org.alfresco.repo.thumbnail

Class ThumbnailRegistry

java.lang.Object

org.alfresco.repo.thumbnail.ThumbnailRegistry

All Implemented Interfaces:

EventListener, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationListener<org.springframework.context.event.ApplicationContextEvent>

public class ThumbnailRegistry
extends Object
implements org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationListener<org.springframework.context.event.ApplicationContextEvent>

Registry of all the thumbnail details available

Author:

Roy Wetherall, Neil McErlean

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	ThumbnailRegistry.RegistryLifecycle This class hooks in to the spring application lifecycle and ensures that any ThumbnailDefinitions injected by spring are converted to RenditionDefinitions and saved.

Field Summary

Fields

Modifier and Type	Field and Description
protected RenditionService	renditionService Rendition service
protected TenantAdminService	tenantAdminService
protected TransactionService	transactionService Transaction service

Constructor Summary

Constructors

Constructor and Description
ThumbnailRegistry()

Method Summary

Modifier and Type	Method and Description
void	addThumbnailDefinition(ThumbnailDefinition thumbnailDetails) Add a thumbnail details
long	getMaxSourceSizeBytes(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(String thumbnailName) Get the definition of a named thumbnail
List<ThumbnailDefinition>	getThumbnailDefinitions() Get a list of all the thumbnail definitions
List<ThumbnailDefinition>	getThumbnailDefinitions(String mimetype) Deprecated. use overloaded version with sourceSize parameter.
List<ThumbnailDefinition>	getThumbnailDefinitions(String mimetype, long sourceSize)
List<ThumbnailDefinition>	getThumbnailDefinitions(String sourceUrl, String mimetype, long sourceSize)
ThumbnailRenditionConvertor	getThumbnailRenditionConvertor()
List<ThumbnailDefinition>	getThumnailDefintions(String mimetype) Deprecated. Use getThumbnailDefinitions(String) instead.
void	initThumbnailDefinitions()
boolean	isThumbnailDefinitionAvailable(String sourceUrl, 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.
boolean	isThumbnailDefinitionAvailable(String sourceUrl, String sourceMimeType, long sourceSize, 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)
protected boolean	redeploy()
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setContentService(ContentService contentService) Content service
void	setRedeployStaticDefsOnStartup(boolean redeployStaticDefsOnStartup)
void	setRenditionService(RenditionService renditionService) Rendition service
void	setTenantAdminService(TenantAdminService tenantAdminService)
void	setThumbnailDefinitions(List<ThumbnailDefinition> 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

Field Detail

transactionService

protected TransactionService transactionService

Transaction service

renditionService

protected RenditionService renditionService

Rendition service

tenantAdminService

protected TenantAdminService tenantAdminService

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)

setRedeployStaticDefsOnStartup

public void setRedeployStaticDefsOnStartup(boolean redeployStaticDefsOnStartup)

setThumbnailDefinitions

public void setThumbnailDefinitions(List<ThumbnailDefinition> thumbnailDefinitions)

This method is used to inject the thumbnail definitions.

initThumbnailDefinitions

public void initThumbnailDefinitions()

getThumbnailDefinitions

public List<ThumbnailDefinition> getThumbnailDefinitions()

Get a list of all the thumbnail definitions

Returns:

collection of thumbnail definitions

getThumbnailDefinitions

public List<ThumbnailDefinition> getThumbnailDefinitions(String mimetype)

Deprecated. use overloaded version with sourceSize parameter.

getThumbnailDefinitions

public List<ThumbnailDefinition> getThumbnailDefinitions(String mimetype,
                                                         long sourceSize)

getThumbnailDefinitions

public List<ThumbnailDefinition> getThumbnailDefinitions(String sourceUrl,
                                                         String mimetype,
                                                         long sourceSize)

getThumnailDefintions

@Deprecated
public List<ThumbnailDefinition> getThumnailDefintions(String mimetype)

Deprecated. Use getThumbnailDefinitions(String) instead.

Parameters:

mimetype - String

isThumbnailDefinitionAvailable

public boolean isThumbnailDefinitionAvailable(String sourceUrl,
                                              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

isThumbnailDefinitionAvailable

public boolean isThumbnailDefinitionAvailable(String sourceUrl,
                                              String sourceMimeType,
                                              long sourceSize,
                                              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.

thumbnailDefinition - The ThumbnailDefinition to check for

getMaxSourceSizeBytes

public long getMaxSourceSizeBytes(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 - String

thumbnailDefinition - 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(String thumbnailName)

Get the definition of a named thumbnail

Parameters:

thumbnailName - 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<org.springframework.context.event.ApplicationContextEvent>

redeploy

protected boolean redeploy()