com.foreach.imageserver.client

Class AbstractImageServerClient

java.lang.Object

com.foreach.imageserver.client.AbstractImageServerClient

All Implemented Interfaces:

ImageServerClient

Direct Known Subclasses:

RemoteImageServerClient

public abstract class AbstractImageServerClient
extends Object
implements ImageServerClient

Provides the common ImageServerClient methods that are endpoint independent. Adds support for a ImageRequestHashBuilder that will be used when generating image urls.

Author:

Arne Vandamme

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, LOG

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractImageServerClient(String imageServerUrl)

Method Summary

Modifier and Type	Method and Description
protected void	addQueryParams(org.springframework.util.MultiValueMap<String,String> queryParams, ImageModificationDto imageModification)
protected void	addQueryParams(org.springframework.util.MultiValueMap<String,String> queryParams, ImageResolutionDto imageResolution)
protected void	addQueryParams(org.springframework.util.MultiValueMap<String,String> queryParams, ImageVariantDto imageVariant)
protected void	addQueryParams(org.springframework.util.MultiValueMap<String,String> queryParams, List<ImageModificationDto> imageModifications)
protected URI	buildUri(String path, org.springframework.util.MultiValueMap<String,String> queryParams)
protected URI	buildUri(String path, org.springframework.util.MultiValueMap<String,String> queryParams, String host)
String	getImageServerUrl()
protected Optional<ImageRequestHashBuilder>	hashBuilder()
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 width, int height)
String	imageUrl(String imageId, String context, String ratio, int screenWidth, ImageVariantDto imageVariant)
void	setImageRequestHashBuilder(ImageRequestHashBuilder hashBuilder) Sets an ImageRequestHashBuilder to be used when generating image urls.
void	setImageServerUrl(String imageServerUrl)

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, convertImage, deleteImage, imageExists, imageInfo, imageInfo, imageStream, imageStream, imageStream, imageStream, listAllowedResolutions, listConfigurableResolutions, listModifications, loadImage, loadImage, loadImage, loadImage, pregenerateResolutions, registerImageModification, registerImageModifications

Constructor Detail

AbstractImageServerClient

protected AbstractImageServerClient(String imageServerUrl)

Method Detail

getImageServerUrl

public String getImageServerUrl()

Specified by:

getImageServerUrl in interface ImageServerClient

setImageServerUrl

public void setImageServerUrl(String imageServerUrl)

setImageRequestHashBuilder

public void setImageRequestHashBuilder(ImageRequestHashBuilder hashBuilder)

Sets an ImageRequestHashBuilder to be used when generating image urls. If one is set, image urls will be suffixed with a hash of their parameters. If the server side is not operating in strict mode and has the same hash builder configured, all generated image urls will be accepted and result in a working response.

Parameters:

hashBuilder - to be used

hashBuilder

protected Optional<ImageRequestHashBuilder> hashBuilder()

imageUrl

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

Specified by:

imageUrl in interface ImageServerClient

imageUrl

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

Specified by:

imageUrl in interface ImageServerClient

imageUrl

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

Specified by:

imageUrl in interface ImageServerClient

imageUrl

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

Specified by:

imageUrl in interface ImageServerClient

imageUrl

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

Specified by:

imageUrl in interface ImageServerClient

imageUrl

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

Specified by:

imageUrl in interface ImageServerClient

imageUrl

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

Specified by:

imageUrl in interface ImageServerClient

imageUrl

public String imageUrl(String imageId,
                       String context,
                       String ratio,
                       int screenWidth,
                       ImageVariantDto imageVariant)

Specified by:

imageUrl in interface ImageServerClient

buildUri

protected URI buildUri(String path,
                       org.springframework.util.MultiValueMap<String,String> queryParams)

buildUri

protected URI buildUri(String path,
                       org.springframework.util.MultiValueMap<String,String> queryParams,
                       String host)

addQueryParams

protected void addQueryParams(org.springframework.util.MultiValueMap<String,String> queryParams,
                              ImageResolutionDto imageResolution)

addQueryParams

protected void addQueryParams(org.springframework.util.MultiValueMap<String,String> queryParams,
                              ImageVariantDto imageVariant)

addQueryParams

protected void addQueryParams(org.springframework.util.MultiValueMap<String,String> queryParams,
                              ImageModificationDto imageModification)

addQueryParams

protected void addQueryParams(org.springframework.util.MultiValueMap<String,String> queryParams,
                              List<ImageModificationDto> imageModifications)