Package de.hybris.platform.media.services

Interface MediaLocationHashService

All Known Implementing Classes:

DefaultMediaLocationHashService

public interface MediaLocationHashService

This interface allows to generate hashes for folders and locations of media as well to verify them.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	MediaLocationHashService.HashType

Method Summary

Modifier and Type	Method	Description
default java.lang.String	createHash(java.lang.String folderQualifier, java.lang.String location, long size, java.lang.String mime)	Creates new hash for location, folderQualifier, size and mime.
java.lang.String	createHashForLocation(java.lang.String folderQualifier, java.lang.String location)	Deprecated, for removal: This API element is subject to removal in a future version. since 2011, use createHash(String, String, long, String) instead
default MediaLocationHashService.HashType	verifyHash(java.lang.String hash, java.lang.String folderQualifier, java.lang.String location, long size, java.lang.String mime)	Verifies hash against provided parameters (folderQualifier, location, size, mime).
void	verifyHashForLocation(java.lang.String hash, java.lang.String folderQualifier, java.lang.String location)	Deprecated, for removal: This API element is subject to removal in a future version. since 2011, use verifyHash(String, String, String, long, String)

Method Detail

verifyHashForLocation

@Deprecated(since="2011",
            forRemoval=true)
void verifyHashForLocation(java.lang.String hash,
                           java.lang.String folderQualifier,
                           java.lang.String location)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2011, use verifyHash(String, String, String, long, String)

Verifies hash against provided folderQualifier and Media location.

Parameters:

hash - hash to verify (possibly used in request)

folderQualifier - the folder qualifier

location - the location

verifyHash

default MediaLocationHashService.HashType verifyHash(java.lang.String hash,
                                                     java.lang.String folderQualifier,
                                                     java.lang.String location,
                                                     long size,
                                                     java.lang.String mime)

Verifies hash against provided parameters (folderQualifier, location, size, mime).

Parameters:

hash - hash to verify (possibly used in request)

folderQualifier - the folder qualifier

location - the location

size - the size of media

mime - the mime type of media

Returns:

the enum value indicating the type of hash that has been provided:

• MediaLocationHashService.HashType.LOCATION_MIME_SIZE - the hash based on all passed parameters
• MediaLocationHashService.HashType.LOCATION - the hash based on only location and folderQualifier

Throws:

MediaInvalidLocationException - on invalid hash

createHashForLocation

@Deprecated(since="2011",
            forRemoval=true)
java.lang.String createHashForLocation(java.lang.String folderQualifier,
                                       java.lang.String location)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2011, use createHash(String, String, long, String) instead

Creates new hash for location and folderQualifier.

Parameters:

folderQualifier - the folder qualifier

location - the Media location

Returns:

created hash string

createHash

default java.lang.String createHash(java.lang.String folderQualifier,
                                    java.lang.String location,
                                    long size,
                                    java.lang.String mime)

Creates new hash for location, folderQualifier, size and mime.

Parameters:

folderQualifier - the folder qualifier

location - the Media location

size - the size of media

mime - the mime type of media

Returns:

created hash string