com.foreach.imageserver.client

Interface ImageServerClient

All Known Implementing Classes:

AbstractImageServerClient, RemoteImageServerClient

public interface ImageServerClient

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_IMAGE_CONVERT
static String	ENDPOINT_IMAGE_DELETE
static String	ENDPOINT_IMAGE_INFO
static String	ENDPOINT_IMAGE_LOAD
static String	ENDPOINT_IMAGE_PREGENERATE
static String	ENDPOINT_IMAGE_RENDER
static String	ENDPOINT_IMAGE_VIEW
static String	ENDPOINT_MODIFICATION_LIST
static String	ENDPOINT_MODIFICATION_REGISTER
static String	ENDPOINT_MODIFICATION_REGISTER_LIST
static String	ENDPOINT_RESOLUTION_LIST
static org.slf4j.Logger	LOG

Method Summary

Modifier and Type	Method and Description
default ImageDto	convertImage(byte[] imageBytes, List<ImageTransformDto> transforms) Convenience method to convert a single image with given transformations.
ImageConvertResultDto	convertImage(ImageConvertDto convertDto) Convert given new or existing image using the given series of transformations.
default ImageDto	convertImage(String imageId, List<ImageTransformDto> transforms) Convenience method to convert a single previously registered image with given transformations.
boolean	deleteImage(String imageId) Delete an image entirely from the image server.
String	getImageServerUrl()
boolean	imageExists(String imageId)
ImageInfoDto	imageInfo(byte[] imageBytes) Get info about image without saving the image.
ImageInfoDto	imageInfo(String imageId)
InputStream	imageStream(byte[] imageData, ImageModificationDto imageModificationDto, ImageVariantDto imageVariant)
InputStream	imageStream(String imageId, ImageModificationDto imageModificationDto, ImageVariantDto imageVariant)
InputStream	imageStream(String imageId, String context, ImageResolutionDto imageResolution, ImageVariantDto imageVariant)
InputStream	imageStream(String imageId, String context, Integer width, Integer height, ImageTypeDto imageType)
String	imageUrl(String imageId, String context, ImageResolutionDto imageResolution, ImageVariantDto imageVariant, String... size)
String	imageUrl(String imageId, String context, ImageTypeDto imageType, String... size)
String	imageUrl(String imageId, String context, int width, int height)
String	imageUrl(String imageId, String context, int width, int height, ImageTypeDto imageType)
String	imageUrl(String imageId, String context, int width, int height, ImageVariantDto imageVariant)
String	imageUrl(String imageId, String context, String... size)
String	imageUrl(String imageId, String context, String ratio, int screenWidth, ImageTypeDto imageType, int height, int width)
String	imageUrl(String imageId, String context, String ratio, int screenWidth, ImageVariantDto imageVariantDto)
List<ImageResolutionDto>	listAllowedResolutions(String context)
List<ImageResolutionDto>	listConfigurableResolutions(String context)
List<ImageModificationDto>	listModifications(String imageId, String context)
ImageInfoDto	loadImage(String imageId, byte[] imageBytes)
ImageInfoDto	loadImage(String imageId, byte[] imageBytes, boolean replaceExisting)
ImageInfoDto	loadImage(String imageId, byte[] imageBytes, Date imageDate)
ImageInfoDto	loadImage(String imageId, byte[] imageBytes, Date imageDate, boolean replaceExisting)
List<ImageResolutionDto>	pregenerateResolutions(String imageId) Will create the variants for all pregenerate resolutions of the image.
void	registerImageModification(String imageId, String context, ImageModificationDto imageModificationDto)
void	registerImageModifications(String imageId, String context, List<ImageModificationDto> imageModificationDtos)

Field Detail

LOG

static final org.slf4j.Logger LOG

ENDPOINT_IMAGE_VIEW

static final String ENDPOINT_IMAGE_VIEW

See Also:

Constant Field Values

ENDPOINT_IMAGE_RENDER

static final String ENDPOINT_IMAGE_RENDER

See Also:

Constant Field Values

ENDPOINT_IMAGE_LOAD

static final String ENDPOINT_IMAGE_LOAD

See Also:

Constant Field Values

ENDPOINT_IMAGE_DELETE

static final String ENDPOINT_IMAGE_DELETE

See Also:

Constant Field Values

ENDPOINT_IMAGE_INFO

static final String ENDPOINT_IMAGE_INFO

See Also:

Constant Field Values

ENDPOINT_IMAGE_PREGENERATE

static final String ENDPOINT_IMAGE_PREGENERATE

See Also:

Constant Field Values

ENDPOINT_RESOLUTION_LIST

static final String ENDPOINT_RESOLUTION_LIST

See Also:

Constant Field Values

ENDPOINT_MODIFICATION_LIST

static final String ENDPOINT_MODIFICATION_LIST

See Also:

Constant Field Values

ENDPOINT_MODIFICATION_REGISTER

static final String ENDPOINT_MODIFICATION_REGISTER

See Also:

Constant Field Values

ENDPOINT_MODIFICATION_REGISTER_LIST

static final String ENDPOINT_MODIFICATION_REGISTER_LIST

See Also:

Constant Field Values

ENDPOINT_IMAGE_CONVERT

static final String ENDPOINT_IMAGE_CONVERT

See Also:

Constant Field Values

Method Detail

getImageServerUrl

String getImageServerUrl()

imageUrl

String imageUrl(String imageId,
                String context,
                int width,
                int height)

imageUrl

String imageUrl(String imageId,
                String context,
                String... size)

imageUrl

String imageUrl(String imageId,
                String context,
                int width,
                int height,
                ImageTypeDto imageType)

imageUrl

String imageUrl(String imageId,
                String context,
                int width,
                int height,
                ImageVariantDto imageVariant)

imageUrl

String imageUrl(String imageId,
                String context,
                ImageTypeDto imageType,
                String... size)

imageStream

InputStream imageStream(String imageId,
                        String context,
                        Integer width,
                        Integer height,
                        ImageTypeDto imageType)

imageStream

InputStream imageStream(String imageId,
                        String context,
                        ImageResolutionDto imageResolution,
                        ImageVariantDto imageVariant)

imageUrl

String imageUrl(String imageId,
                String context,
                ImageResolutionDto imageResolution,
                ImageVariantDto imageVariant,
                String... size)

imageUrl

String imageUrl(String imageId,
                String context,
                String ratio,
                int screenWidth,
                ImageTypeDto imageType,
                int height,
                int width)

imageUrl

String imageUrl(String imageId,
                String context,
                String ratio,
                int screenWidth,
                ImageVariantDto imageVariantDto)

imageStream

InputStream imageStream(String imageId,
                        ImageModificationDto imageModificationDto,
                        ImageVariantDto imageVariant)

imageStream

InputStream imageStream(byte[] imageData,
                        ImageModificationDto imageModificationDto,
                        ImageVariantDto imageVariant)

loadImage

ImageInfoDto loadImage(String imageId,
                       byte[] imageBytes)

loadImage

ImageInfoDto loadImage(String imageId,
                       byte[] imageBytes,
                       boolean replaceExisting)

loadImage

ImageInfoDto loadImage(String imageId,
                       byte[] imageBytes,
                       Date imageDate)

loadImage

ImageInfoDto loadImage(String imageId,
                       byte[] imageBytes,
                       Date imageDate,
                       boolean replaceExisting)

deleteImage

boolean deleteImage(String imageId)

Delete an image entirely from the image server.

Parameters:

imageId - external id of the image

Returns:

true if image existed and has been deleted

imageExists

boolean imageExists(String imageId)

Parameters:

imageId - external image id

Returns:

true when the image, as referenced by the external image id, exists

imageInfo

ImageInfoDto imageInfo(String imageId)

Parameters:

imageId - external image id

Returns:

image information dto object for the image, referenced by the given external image id

imageInfo

ImageInfoDto imageInfo(byte[] imageBytes)

Get info about image without saving the image.

Parameters:

imageBytes - imageBytes

Returns:

imageInfoDto

pregenerateResolutions

List<ImageResolutionDto> pregenerateResolutions(String imageId)

Will create the variants for all pregenerate resolutions of the image.

Parameters:

imageId - External id of the image.

Returns:

List of ImageResolutions that will be pregenerated.

registerImageModification

void registerImageModification(String imageId,
                               String context,
                               ImageModificationDto imageModificationDto)

registerImageModifications

void registerImageModifications(String imageId,
                                String context,
                                List<ImageModificationDto> imageModificationDtos)

listModifications

List<ImageModificationDto> listModifications(String imageId,
                                             String context)

listAllowedResolutions

List<ImageResolutionDto> listAllowedResolutions(String context)

listConfigurableResolutions

List<ImageResolutionDto> listConfigurableResolutions(String context)

convertImage

default ImageDto convertImage(byte[] imageBytes,
                              List<ImageTransformDto> transforms)

Convenience method to convert a single image with given transformations. The result will be converted image.

Parameters:

imageBytes - given image

transforms - transformations

Returns:

transformed image

convertImage

default ImageDto convertImage(String imageId,
                              List<ImageTransformDto> transforms)

Convenience method to convert a single previously registered image with given transformations. The result will be converted image.

Parameters:

imageId - registered image

transforms - transformations

Returns:

transformed image

convertImage

ImageConvertResultDto convertImage(ImageConvertDto convertDto)

Convert given new or existing image using the given series of transformations. The list of transformations contains of all the transformations you want to execute on the image. These will be executed in the supplied order.

Parameters:

convertDto - image and transformations

Returns:

transformed images