org.alfresco.repo.content.transform

Class TransformerConfigMBeanImpl

java.lang.Object

org.alfresco.repo.content.transform.TransformerConfigMBeanImpl

All Implemented Interfaces:

TransformerConfigMBean

public class TransformerConfigMBeanImpl
extends Object
implements TransformerConfigMBean

Implements the JMX interface for monitoring Content Transformer configuration and statistics.

Author:

Alan Davis

Constructor Summary

Constructors

Constructor and Description
TransformerConfigMBeanImpl()

Method Summary

Modifier and Type	Method and Description
String[]	getContextNames() Lists the names of the contexts or uses.
String[]	getCustomePropertyNames() Lists custom (non default) property names.
String[]	getExtensionsAndMimetypes() Lists all configured mimetypes, proceeded by its primary file extension.
String	getProperties(boolean listAll) Returns custom and default transformer propertiest.
String[]	getTestFileExtensionsAndMimetypes() Lists the extensions of available test files.
String[]	getTransformationDebugLog(int n) Returns the last n entries in the transformation debug log.
String[]	getTransformationLog(int n) Returns the last n entries in the transformation log.
String	getTransformationsByExtension(String sourceExtension, String targetExtension, String use) Lists all possible transformations sorted by source and then target mimetype extension.
String	getTransformationsByTransformer(String simpleTransformerName, String use) Lists all possible transformations sorted by Transformer name.
String	getTransformationStatistics(String simpleTransformerName, String sourceExtension, String targetExtension) Lists the transformation statistics for the current node.
String[]	getTransformerNames() Lists the names of all top level transformers.
String	help() Returns a description of each method and its parameters.
String	removeProperties(String propertyNames) Removes transformer properties.
void	setContentTransformerRegistry(ContentTransformerRegistry transformerRegistry)
void	setMimetypeService(org.alfresco.service.cmr.repository.MimetypeService mimetypeService)
String	setProperties(String propertyNamesAndValues) Adds or replaces new transformer properties.
void	setTransformerConfig(TransformerConfig transformerConfig)
void	setTransformerDebug(TransformerDebug transformerDebug)
void	setTransformerDebugLog(org.alfresco.repo.content.transform.LogEntries transformerDebugLog)
void	setTransformerLog(org.alfresco.repo.content.transform.LogEntries transformerLog)
String	testTransform(String simpleTransformerName, String sourceExtension, String targetExtension, String use) Transforms a small test file from one mimetype to another and then shows the debug of the transform, which would indicate if it was successful or even if it was possible.

Methods inherited from class java.lang.Object

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

Constructor Detail

TransformerConfigMBeanImpl

public TransformerConfigMBeanImpl()

Method Detail

setContentTransformerRegistry

public void setContentTransformerRegistry(ContentTransformerRegistry transformerRegistry)

setTransformerDebug

public void setTransformerDebug(TransformerDebug transformerDebug)

setTransformerConfig

public void setTransformerConfig(TransformerConfig transformerConfig)

setMimetypeService

public void setMimetypeService(org.alfresco.service.cmr.repository.MimetypeService mimetypeService)

setTransformerLog

public void setTransformerLog(org.alfresco.repo.content.transform.LogEntries transformerLog)

setTransformerDebugLog

public void setTransformerDebugLog(org.alfresco.repo.content.transform.LogEntries transformerDebugLog)

getTransformerNames

public String[] getTransformerNames()

Description copied from interface: TransformerConfigMBean

Lists the names of all top level transformers.

Specified by:

getTransformerNames in interface TransformerConfigMBean

getExtensionsAndMimetypes

public String[] getExtensionsAndMimetypes()

Description copied from interface: TransformerConfigMBean

Lists all configured mimetypes, proceeded by its primary file extension.

Specified by:

getExtensionsAndMimetypes in interface TransformerConfigMBean

getTransformationsByTransformer

public String getTransformationsByTransformer(String simpleTransformerName,
                                              String use)

Description copied from interface: TransformerConfigMBean

Lists all possible transformations sorted by Transformer name.

Specified by:

getTransformationsByTransformer in interface TransformerConfigMBean

Parameters:

simpleTransformerName - to be checked. If null all transformers are included.

use - or context in which the transformation will be used ("doclib", "index", "webpreview", "syncRule", "asyncRule"...) or null for the default.

getTransformationsByExtension

public String getTransformationsByExtension(String sourceExtension,
                                            String targetExtension,
                                            String use)

Description copied from interface: TransformerConfigMBean

Lists all possible transformations sorted by source and then target mimetype extension.

Specified by:

getTransformationsByExtension in interface TransformerConfigMBean

Parameters:

sourceExtension - to be checked. If null all source mimetypes are included.

targetExtension - to be checked. If null all target mimetypes are included.

use - or context in which the transformation will be used ("doclib", "index", "webpreview", "syncRule", "asyncRule"...) or null for the default.

getTransformationStatistics

public String getTransformationStatistics(String simpleTransformerName,
                                          String sourceExtension,
                                          String targetExtension)

Description copied from interface: TransformerConfigMBean

Lists the transformation statistics for the current node.

Specified by:

getTransformationStatistics in interface TransformerConfigMBean

Parameters:

simpleTransformerName - to be checked. If null all transformers are included.

sourceExtension - to be checked. If null all source mimetypes are included.

targetExtension - to be checked. If null all target mimetypes are included.

getTransformationLog

public String[] getTransformationLog(int n)

Description copied from interface: TransformerConfigMBean

Returns the last n entries in the transformation log.

Specified by:

getTransformationLog in interface TransformerConfigMBean

getTransformationDebugLog

public String[] getTransformationDebugLog(int n)

Description copied from interface: TransformerConfigMBean

Returns the last n entries in the transformation debug log.

Specified by:

getTransformationDebugLog in interface TransformerConfigMBean

getProperties

public String getProperties(boolean listAll)

Description copied from interface: TransformerConfigMBean

Returns custom and default transformer propertiest.

Specified by:

getProperties in interface TransformerConfigMBean

Parameters:

listAll - list both default and custom values, otherwise includes only custom values.

setProperties

public String setProperties(String propertyNamesAndValues)

Description copied from interface: TransformerConfigMBean

Adds or replaces new transformer properties.

Specified by:

setProperties in interface TransformerConfigMBean

Returns:

a confirmation or failure message

removeProperties

public String removeProperties(String propertyNames)

Description copied from interface: TransformerConfigMBean

Removes transformer properties.

Specified by:

removeProperties in interface TransformerConfigMBean

Parameters:

propertyNames - to be removed. Any values after the property name are ignored.

Returns:

a confirmation or failure message

testTransform

public String testTransform(String simpleTransformerName,
                            String sourceExtension,
                            String targetExtension,
                            String use)

Description copied from interface: TransformerConfigMBean

Transforms a small test file from one mimetype to another and then shows the debug of the transform, which would indicate if it was successful or even if it was possible.

Specified by:

testTransform in interface TransformerConfigMBean

Parameters:

simpleTransformerName - to be used. If not specified the ContentService is used to select one.

sourceExtension - used to identify the mimetype

targetExtension - used to identify the mimetype

use - or context in which to test the transformation ("doclib", "index", "webpreview", "syncRule", "asyncRule"...) or blank for the default.";

Returns:

Text indicating if the transform was possible and any debug

getContextNames

public String[] getContextNames()

Description copied from interface: TransformerConfigMBean

Lists the names of the contexts or uses.

Specified by:

getContextNames in interface TransformerConfigMBean

getCustomePropertyNames

public String[] getCustomePropertyNames()

Description copied from interface: TransformerConfigMBean

Lists custom (non default) property names.

Specified by:

getCustomePropertyNames in interface TransformerConfigMBean

getTestFileExtensionsAndMimetypes

public String[] getTestFileExtensionsAndMimetypes()

Description copied from interface: TransformerConfigMBean

Lists the extensions of available test files.

Specified by:

getTestFileExtensionsAndMimetypes in interface TransformerConfigMBean

help

public String help()

Description copied from interface: TransformerConfigMBean

Returns a description of each method and its parameters.

Specified by:

help in interface TransformerConfigMBean