com.communote.server.core.image.caching

Class ImageDiskCache

java.lang.Object

com.communote.server.core.image.caching.ImageDiskCache

public class ImageDiskCache
extends Object

Helper to cache images on disk.

Author:

Communote GmbH - http://www.communote.com/

Constructor Summary

Constructors

Constructor and Description
ImageDiskCache() Default constructor
ImageDiskCache(String cacheRootDirectory) Constructor.

Method Summary

Modifier and Type	Method and Description
File	getDefaultImage(String typeName, String imageProviderId, ImageSize imageSize) Get the stored default image.
File	getScaledImage(String typeName, String imageProviderId, String imageIdentifier, ImageSize imageSize) Get the stored scaled image
File	getUnscaledImage(String typeName, String imageProviderId, String imageIdentifier) Get the stored unscaled image
void	removeDefaultImages(String typeName, String imageProviderId) Remove the stored default images for the given type
void	removeImages(String typeName, String providerId, String imageIdentifier) Remove the scaled and unscaled images of the given type that were loaded by the given provider from disk.
void	removeScaledImages(String typeName) Remove the scaled images (including the default images) of the given type from disk
File	storeDefaultImage(String typeName, String imageProviderId, Image image, ImageSize imageSize) Store the provided default image on disk
File	storeScaledImage(String typeName, String imageProviderId, String imageIdentifier, Image image, ImageSize imageSize) Store the provided scaled image on disk if it does not yet exist
File	storeUnscaledImage(String typeName, String imageProviderId, String imageIdentifier, Image image) Store the provided image on disk.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageDiskCache

public ImageDiskCache()

Default constructor

ImageDiskCache

public ImageDiskCache(String cacheRootDirectory)

Constructor.

Parameters:

cacheRootDirectory - The caches root dir.

Method Detail

getDefaultImage

public File getDefaultImage(String typeName,
                            String imageProviderId,
                            ImageSize imageSize)

Get the stored default image.

Parameters:

typeName - the name of the image type

imageProviderId - the ID of the provider which loaded the image

imageSize - the size of the default image

Returns:

the file pointing to the stored default image or null if the file does not exist

getScaledImage

public File getScaledImage(String typeName,
                           String imageProviderId,
                           String imageIdentifier,
                           ImageSize imageSize)

Get the stored scaled image

Parameters:

typeName - the name of the image type

imageProviderId - the ID of the provider which loaded the unscaled image

imageIdentifier - The identifier of the unscaled image

imageSize - the size of the scaled image

Returns:

the file pointing to the scaled image or null if it does not exist

getUnscaledImage

public File getUnscaledImage(String typeName,
                             String imageProviderId,
                             String imageIdentifier)

Get the stored unscaled image

Parameters:

typeName - the name of the image type

imageProviderId - the ID of the provider which loaded the unscaled image

imageIdentifier - The identifier of the unscaled image

Returns:

the file pointing to the image or null if it does not exist

removeDefaultImages

public void removeDefaultImages(String typeName,
                                String imageProviderId)

Remove the stored default images for the given type

Parameters:

typeName - the name of the image type

imageProviderId - the ID of the image provider which loaded the default image

removeImages

public void removeImages(String typeName,
                         String providerId,
                         String imageIdentifier)

Remove the scaled and unscaled images of the given type that were loaded by the given provider from disk.

Parameters:

typeName - the name of the image type.

providerId - the ID of the provider that loaded the image

imageIdentifier - identifier of the image to remove. Can be null to remove all images of the provider

removeScaledImages

public void removeScaledImages(String typeName)

Remove the scaled images (including the default images) of the given type from disk

Parameters:

typeName - the name of the image type

storeDefaultImage

public File storeDefaultImage(String typeName,
                              String imageProviderId,
                              Image image,
                              ImageSize imageSize)
                       throws IOException

Store the provided default image on disk

Parameters:

typeName - the name of the image type

imageProviderId - the ID of the provider which loaded the image

image - the default image to store

imageSize - the size of the default image

Returns:

the file pointing to the stored image

Throws:

IOException - in case storing the image failed

storeScaledImage

public File storeScaledImage(String typeName,
                             String imageProviderId,
                             String imageIdentifier,
                             Image image,
                             ImageSize imageSize)
                      throws IOException

Store the provided scaled image on disk if it does not yet exist

Parameters:

typeName - the name of the image type

imageProviderId - the ID of the provider which loaded the unscaled image

imageIdentifier - The identifier of the unscaled image

image - the scaled image to store

imageSize - the size of the scaled image

Returns:

the file pointing to the stored image

Throws:

IOException - in case storing failed

storeUnscaledImage

public File storeUnscaledImage(String typeName,
                               String imageProviderId,
                               String imageIdentifier,
                               Image image)
                        throws IOException

Store the provided image on disk. If the unscaled image exists it will be removed before storing. Any scaled version will also be removed.

Parameters:

typeName - the name of the image type

imageProviderId - the ID of the provider which loaded the image

imageIdentifier - The identifier of the image

image - the unscaled image to store

Returns:

the file pointing to the stored image

Throws:

IOException - in case storing failed