org.alfresco.repo.thumbnail

Class ThumbnailRegistry

java.lang.Object

org.alfresco.repo.thumbnail.ThumbnailRegistry

All Implemented Interfaces:

java.util.EventListener, org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationListener

public class ThumbnailRegistry
extends java.lang.Object
implements org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationListener

Registry of all the thumbnail details available

Constructor Summary

Constructors

Constructor and Description
ThumbnailRegistry()

Method Summary

Methods

Modifier and Type	Method and Description
void	addThumbnailDefinition(ThumbnailDefinition thumbnailDetails) Add a thumbnail details
long	getMaxSourceSizeBytes(java.lang.String sourceMimetype, ThumbnailDefinition thumbnailDefinition) Returns the maximum source size of any content that may transformed between the supplied sourceMimetype and thumbnailDefinition's targetMimetype using its transformation options.
ThumbnailDefinition	getThumbnailDefinition(java.lang.String thumbnailName) Get the definition of a named thumbnail
java.util.List	getThumbnailDefinitions() Get a list of all the thumbnail definitions
java.util.List	getThumbnailDefinitions(java.lang.String mimetype) Deprecated. use overloaded version with sourceSize parameter.
java.util.List	getThumbnailDefinitions(java.lang.String mimetype, long sourceSize)
ThumbnailRenditionConvertor	getThumbnailRenditionConvertor()
java.util.List	getThumnailDefintions(java.lang.String mimetype) Deprecated. Use ThumbnailRegistry.getThumbnailDefinitions(String) instead.
void	initThumbnailDefinitions()
boolean	isThumbnailDefinitionAvailable(java.lang.String sourceUrl, java.lang.String sourceMimetype, long sourceSize, org.alfresco.service.cmr.repository.NodeRef sourceNodeRef, ThumbnailDefinition thumbnailDefinition) Checks to see if at this moment in time, the specified ThumbnailDefinition is able to thumbnail the source mimetype.
void	onApplicationEvent(org.springframework.context.event.ApplicationContextEvent event)
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setContentService(ContentService contentService) Content service
void	setRenditionService(RenditionService renditionService) Rendition service
void	setTenantAdminService(TenantAdminService tenantAdminService)
void	setThumbnailDefinitions(java.util.List thumbnailDefinitions) This method is used to inject the thumbnail definitions.
void	setThumbnailRenditionConvertor(ThumbnailRenditionConvertor thumbnailRenditionConvertor)
void	setTransactionService(TransactionService transactionService) Transaction service

Methods inherited from class java.lang.Object

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

Constructor Detail

ThumbnailRegistry

public ThumbnailRegistry()

Method Detail

setThumbnailRenditionConvertor

public void setThumbnailRenditionConvertor(ThumbnailRenditionConvertor thumbnailRenditionConvertor)

getThumbnailRenditionConvertor

public ThumbnailRenditionConvertor getThumbnailRenditionConvertor()

setContentService

public void setContentService(ContentService contentService)

Content service

Parameters:

contentService - content service

setTransactionService

public void setTransactionService(TransactionService transactionService)

Transaction service

Parameters:

transactionService - transaction service

setRenditionService

public void setRenditionService(RenditionService renditionService)

Rendition service

Parameters:

renditionService - rendition service

setTenantAdminService

public void setTenantAdminService(TenantAdminService tenantAdminService)

setThumbnailDefinitions

public void setThumbnailDefinitions(java.util.List thumbnailDefinitions)

This method is used to inject the thumbnail definitions.

Parameters:

thumbnailDefinitions -

initThumbnailDefinitions

public void initThumbnailDefinitions()

getThumbnailDefinitions

public java.util.List getThumbnailDefinitions()

Get a list of all the thumbnail definitions

Returns:

Collection collection of thumbnail definitions

getThumbnailDefinitions

public java.util.List getThumbnailDefinitions(java.lang.String mimetype)

Deprecated. use overloaded version with sourceSize parameter.

getThumbnailDefinitions

public java.util.List getThumbnailDefinitions(java.lang.String mimetype,
                                     long sourceSize)

getThumnailDefintions

@Deprecated
public java.util.List getThumnailDefintions(java.lang.String mimetype)

Deprecated. Use ThumbnailRegistry.getThumbnailDefinitions(String) instead.

Parameters:

mimetype -

Returns:

isThumbnailDefinitionAvailable

public boolean isThumbnailDefinitionAvailable(java.lang.String sourceUrl,
                                     java.lang.String sourceMimetype,
                                     long sourceSize,
                                     org.alfresco.service.cmr.repository.NodeRef sourceNodeRef,
                                     ThumbnailDefinition thumbnailDefinition)

Checks to see if at this moment in time, the specified ThumbnailDefinition is able to thumbnail the source mimetype. Typically used with Thumbnail Definitions retrieved by name, and/or when dealing with transient ContentTransformers.

Parameters:

sourceUrl - The URL of the source (optional)

sourceMimetype - The source mimetype

sourceSize - the size (in bytes) of the source. Use -1 if unknown.

sourceNodeRef - which is set in a copy of the thumbnailDefinition transformation options, so that it may be used by transformers and debug.

thumbnailDefinition - The ThumbnailDefinition to check for

getMaxSourceSizeBytes

public long getMaxSourceSizeBytes(java.lang.String sourceMimetype,
                         ThumbnailDefinition thumbnailDefinition)

Returns the maximum source size of any content that may transformed between the supplied sourceMimetype and thumbnailDefinition's targetMimetype using its transformation options.

Parameters:

sourceMimetype -

thumbnailDefinition -

Returns:

0 if there are no transformers, -1 if there is no limit or if positive the size in bytes.

addThumbnailDefinition

public void addThumbnailDefinition(ThumbnailDefinition thumbnailDetails)

Add a thumbnail details

Parameters:

thumbnailDetails - thumbnail details

getThumbnailDefinition

public ThumbnailDefinition getThumbnailDefinition(java.lang.String thumbnailName)

Get the definition of a named thumbnail

Parameters:

thumbnailNam - the thumbnail name

Returns:

ThumbnailDetails the details of the thumbnail

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

onApplicationEvent

public void onApplicationEvent(org.springframework.context.event.ApplicationContextEvent event)

Specified by:

onApplicationEvent in interface org.springframework.context.ApplicationListener