org.alfresco.repo.content.transform.pdfrenderer

Class AlfrescoPdfRendererContentTransformerWorker

java.lang.Object

org.alfresco.repo.content.transform.ContentTransformerHelper

org.alfresco.repo.content.transform.pdfrenderer.AlfrescoPdfRendererContentTransformerWorker

All Implemented Interfaces:

ContentTransformerWorker, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean

public class AlfrescoPdfRendererContentTransformerWorker
extends ContentTransformerHelper
implements ContentTransformerWorker, org.springframework.beans.factory.InitializingBean

Field Summary

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

transformerConfig

Constructor Summary

Constructors

Constructor and Description
AlfrescoPdfRendererContentTransformerWorker()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
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.
String	getVersionString() Gets a string returning product and version information.
boolean	isAvailable() Checks if this worker is available.
boolean	isTransformable(String sourceMimetype, String targetMimetype, TransformationOptions options) Unlike ContentTransformer.isTransformable(String, String, TransformationOptions) should not include the transformer name, as that is added by the ContentTransformer in the parent context.
protected void	setAvailable(boolean available) Make the transformer available
void	setCheckCommand(org.alfresco.util.exec.RuntimeExec checkCommand) Sets the command that must be executed in order to retrieve version information from the executable and thus test that the executable itself is present.
void	setExecuter(org.alfresco.util.exec.RuntimeExec executer) Set the runtime command executer that must be executed in order to run alfresco-pdf-renderer.
void	setRemoteTransformerClient(RemoteTransformerClient remoteTransformerClient) Sets the optional remote transformer client which will be used in preference to a local command if available.
void	transform(org.alfresco.service.cmr.repository.ContentReader reader, org.alfresco.service.cmr.repository.ContentWriter writer, TransformationOptions options)

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AlfrescoPdfRendererContentTransformerWorker

public AlfrescoPdfRendererContentTransformerWorker()

Method Detail

setExecuter

public void setExecuter(org.alfresco.util.exec.RuntimeExec executer)

Set the runtime command executer that must be executed in order to run alfresco-pdf-renderer. Whether or not this is the full path to the command or just the command itself depends the environment setup.

The command must contain the variables ${source} and ${target}, which will be replaced by the names of the file to be transformed and the name of the output file respectively.

    alfresco-pdf-renderer ${source} ${target}
 

Parameters:

executer - the system command executer

setRemoteTransformerClient

public void setRemoteTransformerClient(RemoteTransformerClient remoteTransformerClient)

Sets the optional remote transformer client which will be used in preference to a local command if available.

Parameters:

remoteTransformerClient - may be null;

setCheckCommand

public void setCheckCommand(org.alfresco.util.exec.RuntimeExec checkCommand)

Sets the command that must be executed in order to retrieve version information from the executable and thus test that the executable itself is present.

Parameters:

checkCommand - command executer to retrieve version information

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

isAvailable

public boolean isAvailable()

Description copied from interface: ContentTransformerWorker

Checks if this worker is available.

Specified by:

isAvailable in interface ContentTransformerWorker

Returns:

Returns true if the transformer is functioning otherwise false

setAvailable

protected void setAvailable(boolean available)

Make the transformer available

Parameters:

available - boolean

getVersionString

public String getVersionString()

Description copied from interface: ContentTransformerWorker

Gets a string returning product and version information.

Specified by:

getVersionString in interface ContentTransformerWorker

Returns:

the version string

isTransformable

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

Description copied from interface: ContentTransformerWorker

Unlike ContentTransformer.isTransformable(String, String, TransformationOptions) should not include the transformer name, as that is added by the ContentTransformer in the parent context.

Specified by:

isTransformable in interface ContentTransformerWorker

transform

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

Specified by:

transform in interface ContentTransformerWorker

Throws:

Exception

See Also:

ContentTransformer.transform(ContentReader, ContentWriter, TransformationOptions)

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 ContentTransformerWorker

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.

See Also:

ContentTransformer.getComments(boolean)