org.alfresco.repo.content.transform

Class BinaryPassThroughContentTransformer

java.lang.Object

org.alfresco.repo.content.transform.ContentTransformerHelper

org.alfresco.repo.content.transform.AbstractContentTransformerLimits

org.alfresco.repo.content.transform.AbstractContentTransformer2

org.alfresco.repo.content.transform.BinaryPassThroughContentTransformer

All Implemented Interfaces:

ContentWorker, ContentTransformer, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware

public class BinaryPassThroughContentTransformer
extends AbstractContentTransformer2

Allows direct streaming from source to target when the respective mimetypes are identical, except where the mimetype is text.

Text has to be transformed based on the encoding even if the mimetypes don't reflect it.

Author:

Derek Hulley

See Also:

StringExtractingContentTransformer

Field Summary

Fields inherited from class org.alfresco.repo.content.transform.AbstractContentTransformerLimits

transformerDebug

Fields inherited from class org.alfresco.repo.content.transform.ContentTransformerHelper

transformerConfig

Constructor Summary

Constructors

Constructor and Description
BinaryPassThroughContentTransformer()

Method Summary

Modifier and Type	Method and Description
String	getComments(boolean available) Overridden to supply a comment or String of commented out transformation properties that specify any (hard coded or implied) supported transformations.
boolean	isTransformableMimetype(String sourceMimetype, String targetMimetype, TransformationOptions options) Indicates if this transformer is able to transform the given source mimetype to the target mimetype.
protected void	transformInternal(org.alfresco.service.cmr.repository.ContentReader reader, org.alfresco.service.cmr.repository.ContentWriter writer, TransformationOptions options) Method to be implemented by subclasses wishing to make use of the common infrastructural code provided by this class.

Methods inherited from class org.alfresco.repo.content.transform.AbstractContentTransformer2

checkTransformable, getExecutorService, getRetryTransformOnDifferentMimeType, getStrictMimeTypeCheck, getTransformationTime, getTransformationTime, isTransformationLimitedInternally, recordError, recordTime, recordTime, register, setAdditionalThreadTimout, setExecutorService, setMetadataExtracterConfig, setRegisterTransformer, setRegistry, setRetryTransformOnDifferentMimeType, setStrictMimeTypeCheck, setUseTimeoutThread, toString, transform, transform, transform

Methods inherited from class org.alfresco.repo.content.transform.AbstractContentTransformerLimits

getLimits, getLimits, getLimits, getMaxPages, getMaxSourceSizeKBytes, getMaxSourceSizeKBytes, getPageLimit, getReadLimitKBytes, getReadLimitTimeMs, getTimeoutMs, isPageLimitSupported, isTransformable, isTransformable, isTransformableSize, setLimits, setMaxPages, setMaxSourceSizeKBytes, setMimetypeLimits, setPageLimit, setPageLimitsSupported, setReaderLimits, setReadLimitKBytes, setReadLimitTimeMs, setTimeoutMs, setTransformerDebug

Methods inherited from class org.alfresco.repo.content.transform.ContentTransformerHelper

deprecatedSetter, equals, getBeanName, getCommentsOnlySupports, getExtensionOrAny, getMimetype, getMimetypeService, getName, getSimpleName, hashCode, isExplicitTransformation, isSupportedTransformation, onlySupports, setBeanName, setExplicitTransformations, setMimetypeService, setSupportedTransformations, setTransformerConfig, setUnsupportedTransformations

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.alfresco.repo.content.transform.ContentTransformer

getName, isExplicitTransformation

Constructor Detail

BinaryPassThroughContentTransformer

public BinaryPassThroughContentTransformer()

Method Detail

transformInternal

protected void transformInternal(org.alfresco.service.cmr.repository.ContentReader reader,
                                 org.alfresco.service.cmr.repository.ContentWriter writer,
                                 TransformationOptions options)
                          throws Exception

Description copied from class: AbstractContentTransformer2

Method to be implemented by subclasses wishing to make use of the common infrastructural code provided by this class.

Specified by:

transformInternal in class AbstractContentTransformer2

Parameters:

reader - the source of the content to transform

writer - the target to which to write the transformed content

options - a map of options to use when performing the transformation. The map will never be null.

Throws:

Exception - exceptions will be handled by this class - subclasses can throw anything

isTransformableMimetype

public boolean isTransformableMimetype(String sourceMimetype,
                                       String targetMimetype,
                                       TransformationOptions options)

Description copied from class: AbstractContentTransformerLimits

Indicates if this transformer is able to transform the given source mimetype to the target mimetype. If overridden, consider also overriding ContentTransformerHelper.getComments(boolean).

Specified by:

isTransformableMimetype in interface ContentTransformer

Overrides:

isTransformableMimetype in class AbstractContentTransformerLimits

Parameters:

sourceMimetype - the source mimetype

targetMimetype - the target mimetype

options - the transformation options

Returns:

boolean true if this content transformer can satify the mimetypes, false otherwise

getComments

public String getComments(boolean available)

Description copied from class: ContentTransformerHelper

Overridden to supply a comment or String of commented out transformation properties that specify any (hard coded or implied) supported transformations. Used when providing a list of properties to an administrators who may be setting other transformation properties, via JMX. Consider overriding if {link AbstractContentTransformerLimits.isTransformableMimetype(String, String, TransformationOptions) or ContentTransformerWorker.isTransformable(String, String, TransformationOptions) have been overridden. See ContentTransformerHelper.getCommentsOnlySupports(List, List, boolean) which may be used to help construct a comment.

Specified by:

getComments in interface ContentTransformer

Overrides:

getComments in class ContentTransformerHelper

Parameters:

available - indicates if the transformer has been registered and is available to be selected. false indicates that the transformer is only available as a component of a complex transformer.

Returns:

one line per property. The simple transformer name is returned by default as a comment.