com.adaptris.stax

Class StaxStreamingService

java.lang.Object

com.adaptris.core.ServiceImp

com.adaptris.stax.StaxStreamingService

All Implemented Interfaces:

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

@ComponentProfile(summary="Use STaX to stream from one format to another",
                  tag="service,stax,transform,xml,json",
                  since="3.8.3")
public class StaxStreamingService
extends ServiceImp

Streaming service that takes using STaX events to stream to and from various XMLEventWriter implementations.

The most common use case for this would be to stream XML into JSON or vice-versa making use of com.adaptris.core.json.streaming.JsonStreamingOutputFactory or com.adaptris.core.json.streaming.JsonStreamingInputFactory as the XmlOutputFactoryBuilder or XmlInputFactoryBuilder implementations respectively.

Since:

3.8.3

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

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
StaxStreamingService()

Method Summary

Modifier and Type	Method and Description
protected void	closeService()
void	doService(AdaptrisMessage msg)
XmlInputFactoryBuilder	getInputBuilder()
XmlOutputFactoryBuilder	getOutputBuilder()
protected void	initService()
void	prepare()
void	setInputBuilder(XmlInputFactoryBuilder b)
void	setOutputBuilder(XmlOutputFactoryBuilder b)
StaxStreamingService	withInputBuilder(XmlInputFactoryBuilder b)
StaxStreamingService	withOutputBuilder(XmlOutputFactoryBuilder b)

Methods inherited from class com.adaptris.core.ServiceImp

changeState, close, continueOnFailure, createName, createQualifier, getContinueOnFail, getIsTrackingEndpoint, getLookupName, getUniqueId, init, isBranching, isTrackingEndpoint, requestClose, requestInit, requestStart, requestStop, retrieveComponentState, setContinueOnFail, 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

StaxStreamingService

public StaxStreamingService()

Method Detail

doService

public void doService(AdaptrisMessage msg)
               throws ServiceException

Throws:

ServiceException

prepare

public void prepare()
             throws CoreException

Throws:

CoreException

initService

protected void initService()
                    throws CoreException

Specified by:

initService in class ServiceImp

Throws:

CoreException

closeService

protected void closeService()

Specified by:

closeService in class ServiceImp

getInputBuilder

public XmlInputFactoryBuilder getInputBuilder()

setInputBuilder

public void setInputBuilder(XmlInputFactoryBuilder b)

withInputBuilder

public StaxStreamingService withInputBuilder(XmlInputFactoryBuilder b)

getOutputBuilder

public XmlOutputFactoryBuilder getOutputBuilder()

setOutputBuilder

public void setOutputBuilder(XmlOutputFactoryBuilder b)

withOutputBuilder

public StaxStreamingService withOutputBuilder(XmlOutputFactoryBuilder b)