com.foreach.across.modules.webcms.domain.image.connector

Interface WebCmsImageConnector

All Known Implementing Classes:

CloudinaryWebCmsImageConnector, ImageServerWebCmsImageConnector

public interface WebCmsImageConnector

General API for storing WebCmsImage data (the physical files) in an external repository. This API provides all basic methods that the administration UI needs to upload images, delete images, and building a simple URL to an image.

Since:

0.0.2

Author:

Arne Vandamme

See Also:

CloudinaryWebCmsImageConnector, ImageServerWebCmsImageConnector

Field Summary

Fields

Modifier and Type	Field and Description
static int	ORIGINAL_HEIGHT
static int	ORIGINAL_WIDTH

Method Summary

Modifier and Type	Method and Description
String	buildImageUrl(WebCmsImage image, int boxWidth, int boxHeight) Builds a URL to render the given image.
boolean	deleteImageData(WebCmsImage image) Removes the physical data associated with a WebCmsImage.
boolean	saveImageData(WebCmsImage image, byte[] data) Associates physical image data with a WebCmsImage.

Field Detail

ORIGINAL_WIDTH

static final int ORIGINAL_WIDTH

See Also:

Constant Field Values

ORIGINAL_HEIGHT

static final int ORIGINAL_HEIGHT

See Also:

Constant Field Values

Method Detail

saveImageData

boolean saveImageData(WebCmsImage image,
                      byte[] data)

Associates physical image data with a WebCmsImage. Usually uploads the physical file to some kind of remote repository, and stores the returned reference using WebCmsImage#setExternalId(String).

Parameters:

image - record

data - actual image file

Returns:

true if saving was successful

buildImageUrl

String buildImageUrl(WebCmsImage image,
                     int boxWidth,
                     int boxHeight)

Builds a URL to render the given image. The box width and height parameters indicate a box in which the image is supposed to fit.

This method is expected to always return images according to their original aspect ratio.

Parameters:

image - to render

boxWidth - width of the box the image should fit in

boxHeight - height of the box the image should fit in

Returns:

url to the image

deleteImageData

boolean deleteImageData(WebCmsImage image)

Removes the physical data associated with a WebCmsImage. Usually calls the remote repository to delete the actual image file.

Parameters:

image - to remove the physical data from

Returns:

true if data has been deleted