com.adaptris.core.transform

Class TransformService

java.lang.Object

com.adaptris.core.ServiceImp

com.adaptris.core.transform.TransformService

All Implemented Interfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, JndiBindable, MessageEventGenerator, Service, StateManagedComponent

Direct Known Subclasses:

FfTransformService

public abstract class TransformService
extends ServiceImp

Behaviour common to Services which transform messages.

Field Summary

Fields inherited from class com.adaptris.core.ServiceImp

log

Fields inherited from interface com.adaptris.core.MessageEventGenerator

CONFIRMATION_ID_KEY

Constructor Summary

Constructors

Constructor and Description
TransformService() Creates a new instance.

Method Summary

Modifier and Type	Method and Description
protected void	closeService()
protected abstract TransformFramework	createFramework() Create the appropriate transform framework.
void	doService(AdaptrisMessage msg) Transforms the message.
java.lang.Boolean	getAllowOverride() Returns the flag specifying whether or not an 'over-ride' transform may be specified in message metadata.
java.lang.Boolean	getCacheTransforms() Return the flag indicating whether transforms should be cached or not.
java.lang.String	getMetadataKey() Returns the metadata key that will be used to store the over-ride transform URL.
java.lang.String	getOutputMessageEncoding()
java.lang.String	getUrl() Returns the URL of the transformation style sheet.
protected void	initService()
void	prepare() Prepare for initialisation.
void	setAllowOverride(java.lang.Boolean b) Sets the flag specifying whether or not an 'over-ride' transform may be specified in message metadata.
void	setCacheTransforms(java.lang.Boolean b) Sets the flag indicating whether transforms should be cached or not.
void	setMetadataKey(java.lang.String s) Sets the metadata key that will be used to store the over-ride transform URL.
void	setOutputMessageEncoding(java.lang.String s) Force the output message encoding to be a particular encoding.
void	setUrl(java.lang.String s) Sets the URL of the transformation style sheet.

Methods inherited from class com.adaptris.core.ServiceImp

changeState, close, continueOnFailure, createName, createQualifier, getContinueOnFail, getIsConfirmation, getIsTrackingEndpoint, getLookupName, getUniqueId, init, isBranching, isConfirmation, isTrackingEndpoint, requestClose, requestInit, requestStart, requestStop, rethrowServiceException, retrieveComponentState, setContinueOnFail, setIsConfirmation, setIsTrackingEndpoint, setLookupName, setUniqueId, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

TransformService

public TransformService()

Creates a new instance. Defaults to caching transforms and disallowing metadata-based over-riding of the transform to apply.

Method Detail

initService

protected final void initService()
                          throws CoreException

Specified by:

initService in class ServiceImp

Throws:

CoreException

closeService

protected final void closeService()

Specified by:

closeService in class ServiceImp

doService

public final void doService(AdaptrisMessage msg)
                     throws ServiceException

Transforms the message. If getAllowOverride is true and a transform is specified in message metdata, this over-ride transform will be applied instead of any configured transform. If no transform is explicitly configured and no over-ride transform is specified in metadata, a ServiceException is thrown.

Parameters:

msg - the AdaptrisMessage to process

Throws:

ServiceException - wrapping any underlying Exceptions

See Also:

Service.doService(AdaptrisMessage)

prepare

public void prepare()
             throws CoreException

Description copied from interface: ComponentLifecycleExtension

Prepare for initialisation.

Throws:

CoreException

setUrl

public void setUrl(java.lang.String s)

Sets the URL of the transformation style sheet.

Parameters:

s - the URL of the transformation style sheet

getUrl

public java.lang.String getUrl()

Returns the URL of the transformation style sheet.

Returns:

the URL of the transformation style sheet

getCacheTransforms

public java.lang.Boolean getCacheTransforms()

Return the flag indicating whether transforms should be cached or not.

Returns:

the flag indicating whether transforms should be cached or not.

setCacheTransforms

public void setCacheTransforms(java.lang.Boolean b)

Sets the flag indicating whether transforms should be cached or not.

By default, transforms are cached for the purposes of optimisation. However, in the event that you wish to constantly change transforms, this flag can be set false to disable this feature.

Parameters:

b - the flag indicating whether transforms should be cached or not

setAllowOverride

public void setAllowOverride(java.lang.Boolean b)

Sets the flag specifying whether or not an 'over-ride' transform may be specified in message metadata.

By default, it is not possible to override the given transform with one specified via metadata, if this behaviour is desired, then this flag should be set true. If not transform is configured using setUrl, this flag is set to true in init.

Parameters:

b - the flag specifying whether or not an 'over-ride' transform may be specified in message metadata

getAllowOverride

public java.lang.Boolean getAllowOverride()

Returns the flag specifying whether or not an 'over-ride' transform may be specified in message metadata.

Returns:

the flag specifying whether or not an 'over-ride' transform may be specified in message metadata

setMetadataKey

public void setMetadataKey(java.lang.String s)

Sets the metadata key that will be used to store the over-ride transform URL. This URL will only be used if allowOverride is set to true.

Parameters:

s - the metadata key that will be used to store the over-ride transform URL

getMetadataKey

public java.lang.String getMetadataKey()

Returns the metadata key that will be used to store the over-ride transform URL.

Returns:

the metadata key that will be used to store the over-ride transform URL

getOutputMessageEncoding

public java.lang.String getOutputMessageEncoding()

setOutputMessageEncoding

public void setOutputMessageEncoding(java.lang.String s)

Force the output message encoding to be a particular encoding.

If specified then the underlying AdaptrisMessage.setCharEncoding(String) is changed to match the encoding specified here before attempting any write operations.

This is only useful if the underlying message is encoded in one way, and you wish to force the encoding directly in your ff transformation definition; e.g. the input message is physically encoded using ISO-8859-1; but your xslt has < and you need to ensure that the message is physically encoded using UTF-8

Parameters:

s -

createFramework

protected abstract TransformFramework createFramework()
                                               throws java.lang.Exception

Create the appropriate transform framework.

Returns:

a transformframework

Throws:

java.lang.Exception - on error.