org.apache.camel.spi

Class Transformer

java.lang.Object

org.apache.camel.support.service.BaseService

org.apache.camel.support.service.ServiceSupport

org.apache.camel.spi.Transformer

All Implemented Interfaces:

AutoCloseable, CamelContextAware, Service, ShutdownableService, StatefulService, SuspendableService

public abstract class Transformer
extends ServiceSupport
implements CamelContextAware

Transformer performs message transformation according to the declared data type. org.apache.camel.processor.ContractAdvice looks for a required Transformer and apply if input/output type declared on a route is different from current message type.

See Also:

org.apache.camel.processor.ContractAdvice} {@link DataType} {@link org.apache.camel.model.InputTypeDefinition} {@link org.apache.camel.model.OutputTypeDefinition}

Field Summary

Fields inherited from class org.apache.camel.support.service.BaseService

BUILDED, FAILED, INITIALIZED, INITIALIZING, lock, NEW, SHUTDOWN, SHUTTINGDOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING

Constructor Summary

Constructors

Constructor and Description
Transformer()

Method Summary

Modifier and Type	Method and Description
protected void	doStart() Implementations override this method to support customized start/stop.
protected void	doStop() Implementations override this method to support customized start/stop.
CamelContext	getCamelContext() Get the CamelContext
DataType	getFrom() Get 'from' data type.
String	getModel() Get a data model which is supported by this transformer.
DataType	getTo() Get 'to' data type.
void	setCamelContext(CamelContext context) Injects the CamelContext
Transformer	setFrom(String from) Set 'from' data type.
Transformer	setModel(String model) Set data model.
Transformer	setTo(String to) Set 'to' data type.
String	toString()
abstract void	transform(Message message, DataType from, DataType to) Perform data transformation with specified from/to type.

Methods inherited from class org.apache.camel.support.service.BaseService

build, doBuild, doFail, doInit, doLifecycleChange, doResume, doShutdown, doSuspend, fail, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.camel.CamelContextAware

trySetCamelContext

Methods inherited from interface org.apache.camel.StatefulService

getStatus, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspending

Methods inherited from interface org.apache.camel.SuspendableService

isSuspended, resume, suspend

Methods inherited from interface org.apache.camel.ShutdownableService

shutdown

Methods inherited from interface org.apache.camel.Service

build, close, init, start, stop

Constructor Detail

Transformer

public Transformer()

Method Detail

transform

public abstract void transform(Message message,
                               DataType from,
                               DataType to)
                        throws Exception

Perform data transformation with specified from/to type.

Parameters:

message - message to apply transformation

from - 'from' data type

to - 'to' data type

Throws:

Exception

getModel

public String getModel()

Get a data model which is supported by this transformer.

getFrom

public DataType getFrom()

Get 'from' data type.

getTo

public DataType getTo()

Get 'to' data type.

setModel

public Transformer setModel(String model)

Set data model.

Parameters:

model - data model

setFrom

public Transformer setFrom(String from)

Set 'from' data type.

Parameters:

from - 'from' data type

setTo

public Transformer setTo(String to)

Set 'to' data type.

Parameters:

to - 'to' data type

getCamelContext

public CamelContext getCamelContext()

Description copied from interface: CamelContextAware

Get the CamelContext

Specified by:

getCamelContext in interface CamelContextAware

Returns:

camelContext the Camel context

setCamelContext

public void setCamelContext(CamelContext context)

Description copied from interface: CamelContextAware

Injects the CamelContext

Specified by:

setCamelContext in interface CamelContextAware

Parameters:

context - the Camel context

toString

public String toString()

Overrides:

toString in class Object

doStart

protected void doStart()
                throws Exception

Description copied from class: BaseService

Implementations override this method to support customized start/stop.

Important: See BaseService.doStop() for more details.

Overrides:

doStart in class BaseService

Throws:

Exception

See Also:

BaseService.doStop()

doStop

protected void doStop()
               throws Exception

Description copied from class: BaseService

Implementations override this method to support customized start/stop.

Important: Camel will invoke this BaseService.doStop() method when the service is being stopped. This method will also be invoked if the service is still in uninitialized state (eg has not been started). The method is always called to allow the service to do custom logic when the service is being stopped, such as when CamelContext is shutting down.

Overrides:

doStop in class BaseService

Throws:

Exception

See Also:

BaseService.doStart()