org.alfresco.repo.thumbnail

Class ThumbnailDefinition

java.lang.Object

org.alfresco.repo.thumbnail.ThumbnailDefinition

public class ThumbnailDefinition
extends java.lang.Object

This class provides the thumbnail details to the thumbnail service.

Constructor Summary

Constructors

Constructor and Description
ThumbnailDefinition() Default constructor
ThumbnailDefinition(java.lang.String destinationMimetype, TransformationOptions options) Constructor
ThumbnailDefinition(java.lang.String mimetype, TransformationOptions options, java.lang.String thumbnailName) Constructor.
ThumbnailDefinition(java.lang.String mimetype, TransformationOptions options, java.lang.String thumbnailName, java.lang.String placeHolderResourcePath) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
FailureHandlingOptions	getFailureHandlingOptions() Get the failure options.
java.lang.String	getMimeAwarePlaceHolderResourcePath()
java.lang.String	getMimetype() Get the destination mimetype
java.lang.String	getName() Gets the name of the thumbnail
java.lang.String	getPlaceHolderResourcePath()
java.lang.String	getRunAs()
TransformationOptions	getTransformationOptions() Get the transformation options
void	setFailureHandlingOptions(FailureHandlingOptions failureOptions) Set the failure options.
void	setMimeAwarePlaceHolderResourcePath(java.lang.String mimeAwarePlaceHolderResourcePath) This method sets the mime-aware placeholder resource path template.
void	setMimetype(java.lang.String mimetype) Set the destination mimetype
void	setName(java.lang.String thumbnailName) Sets the name of the thumbnail
void	setPlaceHolderResourcePath(java.lang.String placeHolderResourcePath) This method sets the placeholder resource path.
void	setRunAs(java.lang.String runAs)
void	setTransformationOptions(TransformationOptions options) Set the transformation options

Methods inherited from class java.lang.Object

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

Constructor Detail

ThumbnailDefinition

public ThumbnailDefinition()

Default constructor

ThumbnailDefinition

public ThumbnailDefinition(java.lang.String destinationMimetype,
                   TransformationOptions options)

Constructor

Parameters:

destinationMimetype -

options -

ThumbnailDefinition

public ThumbnailDefinition(java.lang.String mimetype,
                   TransformationOptions options,
                   java.lang.String thumbnailName)

Constructor. Specify the name of the thumbnail.

Parameters:

thumbnailName - the name of the thumbnail, can be null

ThumbnailDefinition

public ThumbnailDefinition(java.lang.String mimetype,
                   TransformationOptions options,
                   java.lang.String thumbnailName,
                   java.lang.String placeHolderResourcePath)

Constructor. Specify the place holder thumbnail path.

Parameters:

mimetype -

options -

thumbnailName -

placeHolderResourcePath -

Method Detail

setMimetype

public void setMimetype(java.lang.String mimetype)

Set the destination mimetype

Parameters:

mimetype - the destination minetype

getMimetype

public java.lang.String getMimetype()

Get the destination mimetype

Returns:

the destination mimetype

setTransformationOptions

public void setTransformationOptions(TransformationOptions options)

Set the transformation options

Parameters:

options - the transformation options

getTransformationOptions

public TransformationOptions getTransformationOptions()

Get the transformation options

Returns:

the transformation options

setFailureHandlingOptions

public void setFailureHandlingOptions(FailureHandlingOptions failureOptions)

Set the failure options.

Parameters:

failureOptions - the failure options.

Since:

3.5.0

getFailureHandlingOptions

public FailureHandlingOptions getFailureHandlingOptions()

Get the failure options.

Returns:

the failure options

Since:

3.5.0

setName

public void setName(java.lang.String thumbnailName)

Sets the name of the thumbnail

Parameters:

thumbnailName - the thumbnail name

getName

public java.lang.String getName()

Gets the name of the thumbnail

Returns:

String the name of the thumbnail, null if non specified

setRunAs

public void setRunAs(java.lang.String runAs)

getRunAs

public java.lang.String getRunAs()

setPlaceHolderResourcePath

public void setPlaceHolderResourcePath(java.lang.String placeHolderResourcePath)

This method sets the placeholder resource path.

Parameters:

placeHolderResourcePath -

getPlaceHolderResourcePath

public java.lang.String getPlaceHolderResourcePath()

Returns:

setMimeAwarePlaceHolderResourcePath

public void setMimeAwarePlaceHolderResourcePath(java.lang.String mimeAwarePlaceHolderResourcePath)

This method sets the mime-aware placeholder resource path template.

Parameters:

mimeAwarePlaceHolderResourcePath -

Since:

3.4.1 (Team)

getMimeAwarePlaceHolderResourcePath

public java.lang.String getMimeAwarePlaceHolderResourcePath()

Returns:

Since:

3.4.1 (Team)