org.alfresco.repo.content.transform

Interface TransformerConfigMBean

All Known Implementing Classes:

TransformerConfigMBeanImpl

public interface TransformerConfigMBean

A management interface for monitoring Content Transformer configuration and statistics.

Author:

Alan Davis

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 transformerName, String use) Lists all possible transformations sorted by Transformer name.
String	getTransformationStatistics(String transformerName, 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.
String	setProperties(String propertyNamesAndValues) Adds or replaces new transformer properties.
String	testTransform(String transformerName, 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.

Method Detail

getTransformerNames

String[] getTransformerNames()

Lists the names of all top level transformers.

getExtensionsAndMimetypes

String[] getExtensionsAndMimetypes()

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

getTransformationsByTransformer

String getTransformationsByTransformer(String transformerName,
                                       String use)

Lists all possible transformations sorted by Transformer name.

Parameters:

transformerName - 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

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

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

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

String getTransformationStatistics(String transformerName,
                                   String sourceExtension,
                                   String targetExtension)

Lists the transformation statistics for the current node.

Parameters:

transformerName - 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

String[] getTransformationLog(int n)

Returns the last n entries in the transformation log.

getTransformationDebugLog

String[] getTransformationDebugLog(int n)

Returns the last n entries in the transformation debug log.

getProperties

String getProperties(boolean listAll)

Returns custom and default transformer propertiest.

Parameters:

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

setProperties

String setProperties(String propertyNamesAndValues)

Adds or replaces new transformer properties.

Parameters:

propertyNamesAndValues -

Returns:

a confirmation or failure message

removeProperties

String removeProperties(String propertyNames)

Removes transformer properties.

Parameters:

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

Returns:

a confirmation or failure message

testTransform

String testTransform(String transformerName,
                     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.

Parameters:

transformerName - 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

String[] getContextNames()

Lists the names of the contexts or uses.

getCustomePropertyNames

String[] getCustomePropertyNames()

Lists custom (non default) property names.

getTestFileExtensionsAndMimetypes

String[] getTestFileExtensionsAndMimetypes()

Lists the extensions of available test files.

help

String help()

Returns a description of each method and its parameters.