com.foreach.imageserver.client

Interface ImageRequestHashBuilder

All Known Implementing Classes:

Md5ImageRequestHashBuilder

public interface ImageRequestHashBuilder

API for building a secure hash of image request parameters. When the server is not operating in strict mode and both server and client have the same ImageRequestHashBuilder configured, all requests containing a valid hash for their parameters will be accepted. Whereas otherwise only requests for resolutions that are registered server-side will be accepted.

Author:

Arne Vandamme

See Also:

Md5ImageRequestHashBuilder

Method Summary

Modifier and Type	Method and Description
String	calculateHash(String context, String ratio, ImageResolutionDto imageResolution, ImageVariantDto imageVariant, String... size) Calculate a security hash of the different parameters.
static ImageRequestHashBuilder	md5(String hashToken) Create a default Md5ImageRequestHashBuilder implementation using a base token to be added to the parameters when calculating the hash.

Method Detail

calculateHash

String calculateHash(String context,
                     String ratio,
                     ImageResolutionDto imageResolution,
                     ImageVariantDto imageVariant,
                     String... size)

Calculate a security hash of the different parameters. Result can be empty if no hash could be calculated.

Parameters:

context - of the image

ratio - can be null

imageResolution - can be null

imageVariant - requested - can be null

size - can be empty

Returns:

calculated hash

md5

static ImageRequestHashBuilder md5(String hashToken)

Create a default Md5ImageRequestHashBuilder implementation using a base token to be added to the parameters when calculating the hash.

Parameters:

hashToken - token to use for the MD5 hash

Returns:

builder