Package org.exoplatform.services.thumbnail

Interface ImageThumbnailService

public interface ImageThumbnailService

Method Summary

Modifier and Type	Method	Description
void	addPlugin(ImageThumbnailPlugin imageThumbnailPlugin)	Add a new ImageThumbnailPlugin for a given file Type
FileItem	createThumbnail(String id, FileContent fileContent, String userName, int width, int height)	Create a thumbnail for given fileId thith given width and height.
void	deleteThumbnails(Long fileId)	Delete all thumbnails by fileId
void	deleteThumbnails(String fileType, String fileId)	Delete all thumbnails by fileId
FileItem	getOrCreateThumbnail(String fileType, String id, String userName, int width, int height)	Retrieves a thumbnail by given fileId, fileType, width and height or creates a thumbnail image and create it if not exist
FileItem	getOrCreateThumbnail(FileItem file, int width, int height)	Deprecated, for removal: This API element is subject to removal in a future version. use getOrCreateThumbnail(String fileType, String id, String userName, int width, int height) instead
FileItem	getOrCreateThumbnail(ImageResizeService resizeSupplier, FileItem file, int width, int height)	Deprecated, for removal: This API element is subject to removal in a future version. use getOrCreateThumbnail(String fileType, String id, String userName, int width, int height) instead
FileItem	getThumbnail(String id, int width, int height)	Retrieves a thumbnail by given fileId, width and height or creates a thumbnail
void	removePlugin(String fileType)	Removes a ImageThumbnailPlugin identified by its file type

Method Details

getOrCreateThumbnail

@Deprecated(forRemoval=true,
            since="7.1.0")
FileItem getOrCreateThumbnail(FileItem file,
 int width,
 int height)
                       throws Exception

Deprecated, for removal: This API element is subject to removal in a future version.

use getOrCreateThumbnail(String fileType, String id, String userName, int width, int height) instead

Retrieves a thumbnail by given width and height or creates a thumbnail image and create it if not exist

Parameters:

file - Image file

width - target thumbnail width

height - target thumbnail height

Returns:

FileItem

Throws:

Exception

getOrCreateThumbnail

@Deprecated(forRemoval=true,
            since="7.1.0")
FileItem getOrCreateThumbnail(ImageResizeService resizeSupplier,
 FileItem file,
 int width,
 int height)
                       throws Exception

Deprecated, for removal: This API element is subject to removal in a future version.

use getOrCreateThumbnail(String fileType, String id, String userName, int width, int height) instead

Retrieves a thumbnail by given width and height or creates a thumbnail image and create it if not exist

Parameters:

resizeSupplier - if resizeSupplier is null then use ImageResizeService

file - Image file

width - target thumbnail width

height - target thumbnail height

Returns:

FileItem

Throws:

Exception

getOrCreateThumbnail

FileItem getOrCreateThumbnail(String fileType,
 String id,
 String userName,
 int width,
 int height)
                       throws Exception

Retrieves a thumbnail by given fileId, fileType, width and height or creates a thumbnail image and create it if not exist

Parameters:

fileType - file fileType

id - file id

width - target thumbnail width

height - target thumbnail height

Returns:

FileItem

Throws:

Exception

getThumbnail

FileItem getThumbnail(String id,
 int width,
 int height)
               throws Exception

Retrieves a thumbnail by given fileId, width and height or creates a thumbnail

Parameters:

id - file id

width - target thumbnail width

height - target thumbnail height

Returns:

FileItem

Throws:

Exception

createThumbnail

FileItem createThumbnail(String id,
 FileContent fileContent,
 String userName,
 int width,
 int height)
                  throws Exception

Create a thumbnail for given fileId thith given width and height.

Parameters:

id - file id

width - target thumbnail width

height - target thumbnail height

Returns:

FileItem

Throws:

Exception

deleteThumbnails

void deleteThumbnails(String fileType,
 String fileId)

Delete all thumbnails by fileId

Parameters:

fileType - file Type

fileId - file id

deleteThumbnails

void deleteThumbnails(Long fileId)

Delete all thumbnails by fileId

Parameters:

fileId - file id

addPlugin

void addPlugin(ImageThumbnailPlugin imageThumbnailPlugin)

Add a new ImageThumbnailPlugin for a given file Type

Parameters:

imageThumbnailPlugin - ImageThumbnailPlugin

removePlugin

void removePlugin(String fileType)

Removes a ImageThumbnailPlugin identified by its file type

Parameters:

fileType - File type