org.alfresco.repo.content.transform

Interface TransformerConfig

All Known Implementing Classes:

TransformerConfigImpl

public interface TransformerConfig

Provides access to transformer configuration and current performance data.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Collection	ALL_SUFFIXES All suffixes to property names used to transformer configuration
static java.lang.String	ANY Wild card mimetype and mimetype extension.
static java.lang.String	AVAILABLE The suffix to property names to indicate that a transformer is available.
static java.lang.String	CONTENT Prefix before the transformer name of all property names that contain transformer information
static java.lang.String	DEBUG_ENTRIES The number of debug lines to keep.
static java.lang.String	DEFAULT_TRANSFORMER The 'transformer name' for system wide defaults for all transformers
static java.lang.String	ENTRIES
static java.lang.String	ERROR_TIME The suffix to property names for the error time.
static java.lang.String	EXTENSIONS The separator between the transformer name and two mimetype extensions in a property name.
static java.lang.String	FAILOVER The suffix to property names for creating dynamic failover transformers
static java.lang.String	INITIAL_COUNT The suffix to property names for the the average count.
static java.lang.String	INITIAL_TIME The suffix to property names for the the average time.
static java.lang.String[][]	LIMIT_PAIR_SUFFIXES Suffix pairs (max and limit values) to property names used to define transformation limits
static java.util.Collection	LIMIT_SUFFIXES Suffixes to property names used to define transformation limits
static java.lang.String	LOG_ENTRIES The number of log lines to keep.
static java.lang.String	MAX_PAGES
static java.lang.String	MAX_SOURCE_SIZE_K_BYTES Suffixes for limits.
static java.lang.String	MIMETYPES The separator between the transformer name and wildcarded mimetypes rather than extensions in a property name.
static java.util.Collection	NO_SUFFIXES No suffixes to property names used to define transformer settings.
static java.lang.String	PAGE_LIMIT
static char	PIPE Separator between transformers and mimetype extensions in a dynamic compound property value.
static java.lang.String	PIPELINE The suffix to property names for creating dynamic complex transformers
static java.lang.String	PREFIX The combined content and transformer name prefix of for all property names that contain transformer information
static java.lang.String	PRIORITY The suffix to property names for the priority.
static int	PRIORITY_DEFAULT By default transformers have a priority of 100.
static int	PRIORITY_EXPLICIT To support the historical concept of EXPLICIT transformers, all such transformers are given a PRIORITY_EXPLICIT (50).
static java.lang.String	READ_LIMIT_K_BYTES
static java.lang.String	READ_LIMIT_TIME_MS
static java.lang.String[]	SEPARATORS Both extension and minetype separators.
static java.lang.String	SUMMARY_TRANSFORMER_NAME Name given to the 'SUMMARY' dummy (does not exist) transformer that gathers data from all root level transformations
static java.lang.String	SUPPORTED The suffix to property names for supported and unsupported combinations.
static java.lang.String	THRESHOLD_COUNT The suffix to property names for the threshold count.
static java.lang.String	TIMEOUT_MS
static java.lang.String	TRANSFORMER Prefix for all transformer names
static java.lang.String	USE An optional separator appended after the normal suffix and following value that identifies the 'use' or 'application' of the property.

Method Summary

Methods

Modifier and Type	Method and Description
TransformationOptionLimits	getLimits(ContentTransformer transformer, java.lang.String sourceMimetype, java.lang.String targetMimetype, java.lang.String use) Returns the limits defined for the combination of transformer, sourceMimetype and targetMimetype.
int	getPriority(ContentTransformer contentTransformerHelper, java.lang.String sourceMimetype, java.lang.String targetMimetype) Returns the priority of the specified transformer for the the combination of source and target mimetype.
java.lang.String	getProperties(boolean changesOnly) Returns a sorted set of all transformer properties, their values and includes comments about the properties.
java.lang.String	getProperty(java.lang.String name) Returns a transformer property value.
TransformerStatistics	getStatistics(ContentTransformer transformer, java.lang.String sourceMimetype, java.lang.String targetMimetype, boolean createNew) Returns and creates if needed the TransformerStatistics object for the combination of transformer, sourceMimetype and targetMimetype.
int	getThresholdCount(ContentTransformer contentTransformerHelper, java.lang.String sourceMimetype, java.lang.String targetMimetype) Returns the threshold of the transformer.
boolean	isSupportedTransformation(ContentTransformer transformer, java.lang.String sourceMimetype, java.lang.String targetMimetype, TransformationOptions options) Returns true if the supplied mimetype transformation pair is allowed by the list of supported and unsupported transformations.
int	removeProperties(java.lang.String propertyNames) Removes transformer properties.
int	setProperties(java.lang.String propertyNamesAndValues) Sets a transformer property values.

Field Detail

ANY

static final java.lang.String ANY

Wild card mimetype and mimetype extension.

See Also:

Constant Field Values

CONTENT

static final java.lang.String CONTENT

Prefix before the transformer name of all property names that contain transformer information

See Also:

Constant Field Values

TRANSFORMER

static final java.lang.String TRANSFORMER

Prefix for all transformer names

See Also:

Constant Field Values

PREFIX

static final java.lang.String PREFIX

The combined content and transformer name prefix of for all property names that contain transformer information

See Also:

Constant Field Values

DEFAULT_TRANSFORMER

static final java.lang.String DEFAULT_TRANSFORMER

The 'transformer name' for system wide defaults for all transformers

See Also:

Constant Field Values

SUMMARY_TRANSFORMER_NAME

static final java.lang.String SUMMARY_TRANSFORMER_NAME

Name given to the 'SUMMARY' dummy (does not exist) transformer that gathers data from all root level transformations

See Also:

Constant Field Values

USE

static final java.lang.String USE

An optional separator appended after the normal suffix and following value that identifies the 'use' or 'application' of the property. Example uses include 'index' 'doclib' and 'preview'. The corresponding configuration value is only used in the context of the specified usage.

See Also:

Constant Field Values

EXTENSIONS

static final java.lang.String EXTENSIONS

The separator between the transformer name and two mimetype extensions in a property name.

See Also:

Constant Field Values

MIMETYPES

static final java.lang.String MIMETYPES

The separator between the transformer name and wildcarded mimetypes rather than extensions in a property name. Effectively equivalent to multiple properties using the TransformerConfig.EXTENSIONS.

See Also:

Constant Field Values

SEPARATORS

static final java.lang.String[] SEPARATORS

Both extension and minetype separators.

PIPELINE

static final java.lang.String PIPELINE

The suffix to property names for creating dynamic complex transformers

See Also:

Constant Field Values

FAILOVER

static final java.lang.String FAILOVER

The suffix to property names for creating dynamic failover transformers

See Also:

Constant Field Values

AVAILABLE

static final java.lang.String AVAILABLE

The suffix to property names to indicate that a transformer is available. If not specified, defaults to true, indicating it may be selected rather only being available as a component of another transformer.

See Also:

Constant Field Values

PIPE

static final char PIPE

Separator between transformers and mimetype extensions in a dynamic compound property value.

See Also:

Constant Field Values

SUPPORTED

static final java.lang.String SUPPORTED

The suffix to property names for supported and unsupported combinations.

See Also:

Constant Field Values

PRIORITY

static final java.lang.String PRIORITY

The suffix to property names for the priority.

See Also:

Constant Field Values

THRESHOLD_COUNT

static final java.lang.String THRESHOLD_COUNT

The suffix to property names for the threshold count.

See Also:

Constant Field Values

ERROR_TIME

static final java.lang.String ERROR_TIME

The suffix to property names for the error time.

See Also:

Constant Field Values

INITIAL_TIME

static final java.lang.String INITIAL_TIME

The suffix to property names for the the average time. Only used in the initial setup of TransformerData. This is a historical property used by the 'Transformation Server' to set an effective priority.

See Also:

Constant Field Values

INITIAL_COUNT

static final java.lang.String INITIAL_COUNT

The suffix to property names for the the average count. Only used in the initial setup of TransformerData. This is a historical property used by the 'Transformation Server' to set an effective priority.

See Also:

Constant Field Values

MAX_SOURCE_SIZE_K_BYTES

static final java.lang.String MAX_SOURCE_SIZE_K_BYTES

Suffixes for limits.

See Also:

Constant Field Values

TIMEOUT_MS

static final java.lang.String TIMEOUT_MS

See Also:

Constant Field Values

MAX_PAGES

static final java.lang.String MAX_PAGES

See Also:

Constant Field Values

READ_LIMIT_K_BYTES

static final java.lang.String READ_LIMIT_K_BYTES

See Also:

Constant Field Values

READ_LIMIT_TIME_MS

static final java.lang.String READ_LIMIT_TIME_MS

See Also:

Constant Field Values

PAGE_LIMIT

static final java.lang.String PAGE_LIMIT

See Also:

Constant Field Values

PRIORITY_EXPLICIT

static final int PRIORITY_EXPLICIT

To support the historical concept of EXPLICIT transformers, all such transformers are given a PRIORITY_EXPLICIT (50). By default transformers have a default of 10. A value of 5 allows better transformers to be added later.

See Also:

Constant Field Values

PRIORITY_DEFAULT

static final int PRIORITY_DEFAULT

By default transformers have a priority of 100.

See Also:

Constant Field Values

LIMIT_SUFFIXES

static final java.util.Collection LIMIT_SUFFIXES

Suffixes to property names used to define transformation limits

LIMIT_PAIR_SUFFIXES

static final java.lang.String[][] LIMIT_PAIR_SUFFIXES

Suffix pairs (max and limit values) to property names used to define transformation limits

ALL_SUFFIXES

static final java.util.Collection ALL_SUFFIXES

All suffixes to property names used to transformer configuration

NO_SUFFIXES

static final java.util.Collection NO_SUFFIXES

No suffixes to property names used to define transformer settings.

ENTRIES

static final java.lang.String ENTRIES

See Also:

Constant Field Values

DEBUG_ENTRIES

static final java.lang.String DEBUG_ENTRIES

The number of debug lines to keep. Turned off if <= 0.

See Also:

Constant Field Values

LOG_ENTRIES

static final java.lang.String LOG_ENTRIES

The number of log lines to keep. Turned off if <= 0.

See Also:

Constant Field Values

Method Detail

getProperty

java.lang.String getProperty(java.lang.String name)

Returns a transformer property value.

Parameters:

name - of the property.

Returns:

a transformer property or null if not set.

getProperties

java.lang.String getProperties(boolean changesOnly)

Returns a sorted set of all transformer properties, their values and includes comments about the properties.

Parameters:

changesOnly - only custom values will be included.

Returns:

a multi-line String which is never {code null}.

removeProperties

int removeProperties(java.lang.String propertyNames)

Removes transformer properties.

Parameters:

propertyNames - new line separated names. Any values will be ignored.

Returns:

the number of properties removed.

Throws:

java.lang.IllegalArgumentException - if the properties were not set or the list contains errors.

setProperties

int setProperties(java.lang.String propertyNamesAndValues)

Sets a transformer property values. These will be stored in the database but on an MBean reset is cleared.

Parameters:

propertyNamesAndValues - new line separated name and values

Returns:

the number of properties set.

Throws:

java.lang.IllegalArgumentException - the list contains errors.

getStatistics

TransformerStatistics getStatistics(ContentTransformer transformer,
                                  java.lang.String sourceMimetype,
                                  java.lang.String targetMimetype,
                                  boolean createNew)

Returns and creates if needed the TransformerStatistics object for the combination of transformer, sourceMimetype and targetMimetype. When transformer is null this is the system wide summary object for a combination of sourceMimetype and targetMimetype. When both sourceMimetype and targetMimetype are null this is the transformer's summary object. When all three parameters are null this is the system wide summary for all transformers.

Parameters:

transformer - the transformer for which data is being recorded.

sourceMimetype - the source mimetype.

targetMimetype - the source mimetype.

createNew - indicates if a new object should be created if it does not exist.

Returns:

the requested TransformerStatistics.

getLimits

TransformationOptionLimits getLimits(ContentTransformer transformer,
                                   java.lang.String sourceMimetype,
                                   java.lang.String targetMimetype,
                                   java.lang.String use)

Returns the limits defined for the combination of transformer, sourceMimetype and targetMimetype. When the transformer is null, this is a default value. When both sourceMimetype and targetMimetype are null this is a default for the specified transformer.

Parameters:

transformer -

sourceMimetype -

targetMimetype -

use - to which the limits will be put. For example "index", "webpreview", "doclib", "syncRule", "aysncRule". null is the default.

Returns:

the combined (takes into account defaults from higher levels) limits for the combination.

isSupportedTransformation

boolean isSupportedTransformation(ContentTransformer transformer,
                                java.lang.String sourceMimetype,
                                java.lang.String targetMimetype,
                                TransformationOptions options)

Returns true if the supplied mimetype transformation pair is allowed by the list of supported and unsupported transformations.

Parameters:

transformer -

sourceMimetype -

targetMimetype -

options - not currently used

getPriority

int getPriority(ContentTransformer contentTransformerHelper,
              java.lang.String sourceMimetype,
              java.lang.String targetMimetype)

Returns the priority of the specified transformer for the the combination of source and target mimetype.

Parameters:

transformer -

sourceMimetype -

targetMimetype -

Returns:

the priority. To support the historical concept of EXPLICIT transformers, all such transformers are given a PRIORITY_EXPLICIT (50). By default transformers have a default of 100.

getThresholdCount

int getThresholdCount(ContentTransformer contentTransformerHelper,
                    java.lang.String sourceMimetype,
                    java.lang.String targetMimetype)

Returns the threshold of the transformer. It is only after this number of transformation attempts that the average time is used.

Parameters:

transformer -

sourceMimetype -

targetMimetype -

Returns:

the threshold.