com.foreach.imageserver.client

Class RemoteImageServerClient

java.lang.Object

com.foreach.imageserver.client.AbstractImageServerClient

com.foreach.imageserver.client.RemoteImageServerClient

All Implemented Interfaces:

ImageServerClient

public class RemoteImageServerClient
extends AbstractImageServerClient

Represents a client for a remote ImageServer endpoint.

Field Summary

Fields inherited from interface com.foreach.imageserver.client.ImageServerClient

ENDPOINT_IMAGE_CONVERT, ENDPOINT_IMAGE_DELETE, ENDPOINT_IMAGE_INFO, ENDPOINT_IMAGE_LOAD, ENDPOINT_IMAGE_PREGENERATE, ENDPOINT_IMAGE_RENDER, ENDPOINT_IMAGE_VIEW, ENDPOINT_MODIFICATION_LIST, ENDPOINT_MODIFICATION_REGISTER, ENDPOINT_MODIFICATION_REGISTER_LIST, ENDPOINT_RESOLUTION_LIST

Constructor Summary

Constructors

Constructor and Description
RemoteImageServerClient(String imageServerEndpoint, String imageServerAccessToken)
RemoteImageServerClient(String imageServerEndpoint, String imageServerAccessToken, org.springframework.web.client.RestTemplate restTemplate)

Method Summary

Modifier and Type	Method and Description
ImageConvertResultDto	convertImage(ImageConvertDto convertDto) Convert given new or existing image using the given series of transformations.
boolean	deleteImage(String imageId) Delete an image entirely from the image server.
protected <T> T	httpGet(String path, org.springframework.util.MultiValueMap<String,String> queryParams, Class<T> responseType)
protected <T> T	httpGet(String path, org.springframework.util.MultiValueMap<String,String> queryParams, org.springframework.core.ParameterizedTypeReference<JsonResponse<T>> responseType)
protected <T> T	httpPost(String path, org.springframework.util.MultiValueMap<String,String> queryParams, org.springframework.http.HttpEntity payload, org.springframework.core.ParameterizedTypeReference<JsonResponse<T>> responseType)
protected <T> T	httpPost(String path, org.springframework.util.MultiValueMap<String,String> queryParams, org.springframework.util.MultiValueMap<String,?> bodyParams, Class<T> responseType)
protected <T> T	httpPost(String path, org.springframework.util.MultiValueMap<String,String> queryParams, org.springframework.util.MultiValueMap<String,?> bodyParams, org.springframework.core.ParameterizedTypeReference<JsonResponse<T>> responseType)
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)
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 imageModification)
void	registerImageModifications(String imageId, String context, List<ImageModificationDto> imageModifications)
void	setRestTemplate(org.springframework.web.client.RestTemplate restTemplate)

Methods inherited from class com.foreach.imageserver.client.AbstractImageServerClient

addQueryParams, addQueryParams, addQueryParams, addQueryParams, buildUri, buildUri, getImageServerUrl, hashBuilder, imageUrl, imageUrl, imageUrl, imageUrl, imageUrl, imageUrl, imageUrl, imageUrl, setImageRequestHashBuilder, setImageServerUrl

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.foreach.imageserver.client.ImageServerClient

convertImage, convertImage

Constructor Detail

RemoteImageServerClient

public RemoteImageServerClient(String imageServerEndpoint,
                               String imageServerAccessToken)

RemoteImageServerClient

public RemoteImageServerClient(String imageServerEndpoint,
                               String imageServerAccessToken,
                               org.springframework.web.client.RestTemplate restTemplate)

Method Detail

setRestTemplate

public void setRestTemplate(org.springframework.web.client.RestTemplate restTemplate)

imageStream

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

imageStream

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

imageStream

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

imageStream

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

loadImage

public ImageInfoDto loadImage(String imageId,
                              byte[] imageBytes)

loadImage

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

loadImage

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

loadImage

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

deleteImage

public boolean deleteImage(String imageId)

Description copied from interface: ImageServerClient

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

public boolean imageExists(String imageId)

Parameters:

imageId - external image id

Returns:

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

imageInfo

public 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

public ImageInfoDto imageInfo(byte[] imageBytes)

Description copied from interface: ImageServerClient

Get info about image without saving the image.

Parameters:

imageBytes - imageBytes

Returns:

imageInfoDto

pregenerateResolutions

public List<ImageResolutionDto> pregenerateResolutions(String imageId)

Description copied from interface: ImageServerClient

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

public void registerImageModification(String imageId,
                                      String context,
                                      ImageModificationDto imageModification)

registerImageModifications

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

listAllowedResolutions

public List<ImageResolutionDto> listAllowedResolutions(String context)

listConfigurableResolutions

public List<ImageResolutionDto> listConfigurableResolutions(String context)

listModifications

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

convertImage

public ImageConvertResultDto convertImage(ImageConvertDto convertDto)

Description copied from interface: ImageServerClient

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

httpGet

protected <T> T httpGet(String path,
                        org.springframework.util.MultiValueMap<String,String> queryParams,
                        Class<T> responseType)

httpGet

protected <T> T httpGet(String path,
                        org.springframework.util.MultiValueMap<String,String> queryParams,
                        org.springframework.core.ParameterizedTypeReference<JsonResponse<T>> responseType)

httpPost

protected <T> T httpPost(String path,
                         org.springframework.util.MultiValueMap<String,String> queryParams,
                         org.springframework.util.MultiValueMap<String,?> bodyParams,
                         Class<T> responseType)

httpPost

protected <T> T httpPost(String path,
                         org.springframework.util.MultiValueMap<String,String> queryParams,
                         org.springframework.http.HttpEntity payload,
                         org.springframework.core.ParameterizedTypeReference<JsonResponse<T>> responseType)

httpPost

protected <T> T httpPost(String path,
                         org.springframework.util.MultiValueMap<String,String> queryParams,
                         org.springframework.util.MultiValueMap<String,?> bodyParams,
                         org.springframework.core.ParameterizedTypeReference<JsonResponse<T>> responseType)