Package com.adaptris.stax.services

Class StaxTransformPlugin

java.lang.Object

com.adaptris.stax.services.StaxTransformPlugin

All Implemented Interfaces:

ComponentLifecycle, Plugin

@ComponentProfile(summary="transform-plugin implementation for TransformPluginServiceList",
                  since="3.8.4")
public class StaxTransformPlugin
extends java.lang.Object
implements Plugin

Plugin implementation that uses STaX to transform between 2 formats.

In the adapter configuration file this class is aliased as stax-transform-plugin which is the preferred alternative to the fully qualified classname when building your configuration.

Constructor Summary

Constructors

Constructor	Description
StaxTransformPlugin()

Method Summary

Modifier and Type	Method	Description
void	close()
XmlInputFactoryBuilder	getInputBuilder()
InputCondition	getInputCondition()
XmlOutputFactoryBuilder	getOutputBuilder()
PostTransform	getPostTransform()
void	init()
void	setInputBuilder(XmlInputFactoryBuilder fac)	Set the XmlInputFactoryBuilder to use when streaming the input.
void	setInputCondition(InputCondition r)	Set the input rule that fires this plugin.
void	setOutputBuilder(XmlOutputFactoryBuilder fac)	Set the XmlOutputFactoryBuilder to use when streaming the output.
void	setPostTransform(PostTransform r)	Set what changes about the message when this plugin is applied.
void	start()
void	stop()
AdaptrisMessage	transform(AdaptrisMessage msg)
StaxTransformPlugin	withInputBuilder(XmlInputFactoryBuilder f)
StaxTransformPlugin	withInputCondition(InputCondition f)
StaxTransformPlugin	withOutputBuilder(XmlOutputFactoryBuilder f)
StaxTransformPlugin	withPostTransform(PostTransform f)

Methods inherited from class java.lang.Object

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

Constructor Detail

StaxTransformPlugin

public StaxTransformPlugin()

Method Detail

init

public void init()
          throws CoreException

Specified by:

init in interface ComponentLifecycle

Throws:

CoreException

start

public void start()
           throws CoreException

Specified by:

start in interface ComponentLifecycle

Throws:

CoreException

stop

public void stop()

Specified by:

stop in interface ComponentLifecycle

close

public void close()

Specified by:

close in interface ComponentLifecycle

transform

public AdaptrisMessage transform(AdaptrisMessage msg)
                          throws ServiceException

Specified by:

transform in interface Plugin

Throws:

ServiceException

getInputBuilder

public XmlInputFactoryBuilder getInputBuilder()

setInputBuilder

public void setInputBuilder(XmlInputFactoryBuilder fac)

Set the XmlInputFactoryBuilder to use when streaming the input.

Parameters:

fac - the input factory.

withInputBuilder

public StaxTransformPlugin withInputBuilder(XmlInputFactoryBuilder f)

getOutputBuilder

public XmlOutputFactoryBuilder getOutputBuilder()

setOutputBuilder

public void setOutputBuilder(XmlOutputFactoryBuilder fac)

Set the XmlOutputFactoryBuilder to use when streaming the output.

Parameters:

fac - the output factory.

withOutputBuilder

public StaxTransformPlugin withOutputBuilder(XmlOutputFactoryBuilder f)

getInputCondition

public InputCondition getInputCondition()

setInputCondition

public void setInputCondition(InputCondition r)

Set the input rule that fires this plugin.

Parameters:

r - th InputCondition implementation; by default it will never match.

withInputCondition

public StaxTransformPlugin withInputCondition(InputCondition f)

See Also:

setInputCondition(InputCondition)

getPostTransform

public PostTransform getPostTransform()

setPostTransform

public void setPostTransform(PostTransform r)

Set what changes about the message when this plugin is applied.

Parameters:

r - the PostTransform implementation, by default nothing is done.

withPostTransform

public StaxTransformPlugin withPostTransform(PostTransform f)

See Also:

setPostTransform(PostTransform)