com.foreach.imageserver.client.ImageServerClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of imageserver-client Show documentation
ImageServer Client
The newest version!
package com.foreach.imageserver.client;

import com.foreach.imageserver.dto.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.InputStream;
import java.util.Date;
import java.util.List;

public interface ImageServerClient
{
	Logger LOG = LoggerFactory.getLogger( ImageServerClient.class );

	String ENDPOINT_IMAGE_VIEW = "view";
	String ENDPOINT_IMAGE_RENDER = "api/image/render";
	String ENDPOINT_IMAGE_LOAD = "api/image/load";
	String ENDPOINT_IMAGE_DELETE = "api/image/delete";
	String ENDPOINT_IMAGE_INFO = "api/image/details";
	String ENDPOINT_IMAGE_PREGENERATE = "api/image/pregenerate";
	String ENDPOINT_RESOLUTION_LIST = "api/resolution/list";
	String ENDPOINT_MODIFICATION_LIST = "api/modification/list";
	String ENDPOINT_MODIFICATION_REGISTER = "api/modification/register";
	String ENDPOINT_MODIFICATION_REGISTER_LIST = "api/modification/registerlist";
	String ENDPOINT_IMAGE_CONVERT = "api/image/convert";

	String getImageServerUrl();

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

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

	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,
	                 ImageTypeDto imageType,
	                 String... size
	);

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

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

	String imageUrl( String imageId,
	                 String context,
	                 ImageResolutionDto imageResolution,
	                 ImageVariantDto imageVariant,
	                 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 );

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

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

	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 );

	/**
	 * Delete an image entirely from the image server.
	 *
	 * @param imageId external id of the image
	 * @return true if image existed and has been deleted
	 */
	boolean deleteImage( String imageId );

	/**
	 * @param imageId external image id
	 * @return true when the image, as referenced by the external image id, exists
	 */
	boolean imageExists( String imageId );

	/**
	 * @param imageId external image id
	 * @return image information dto object for the image, referenced by the given external image id
	 */
	ImageInfoDto imageInfo( String imageId );

	/**
	 * Get info about image without saving the image.
	 *
	 * @param imageBytes imageBytes
	 * @return imageInfoDto
	 */
	ImageInfoDto imageInfo( byte[] imageBytes );

	/**
	 * Will create the variants for all pregenerate resolutions of the image.
	 *
	 * @param imageId External id of the image.
	 * @return List of ImageResolutions that will be pregenerated.
	 */
	List pregenerateResolutions( String imageId );

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

	void registerImageModifications( String imageId,
	                                 String context,
	                                 List imageModificationDtos );

	List listModifications( String imageId, String context );

	List listAllowedResolutions( String context );

	List listConfigurableResolutions( String context );

	/**
	 * Convenience method to convert a single image with given transformations.
	 * The result will be converted image.
	 *
	 * @param imageBytes given image
	 * @param transforms transformations
	 * @return transformed image
	 */
	default ImageDto convertImage( byte[] imageBytes, List transforms ) {
		return convertImage( ImageConvertDto.builder().image( imageBytes ).transformation( "transform", transforms ).build() )
				.getTransforms()
				.get( "transform" );
	}

	/**
	 * Convenience method to convert a single previously registered image with given transformations.
	 * The result will be converted image.
	 *
	 * @param imageId    registered image
	 * @param transforms transformations
	 * @return transformed image
	 */
	default ImageDto convertImage( String imageId, List transforms ) {
		return convertImage( ImageConvertDto.builder().imageId( imageId ).transformation( "transform", transforms ).build() )
				.getTransforms()
				.get( "transform" );
	}

	/**
	 * 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.
	 *
	 * @param convertDto image and transformations
	 * @return transformed images
	 */
	ImageConvertResultDto convertImage( ImageConvertDto convertDto );
}