com.adaptris.core.transform.json

Class JsonXmlTransformService

java.lang.Object

com.adaptris.core.ServiceImp

com.adaptris.core.transform.json.JsonXmlTransformService

All Implemented Interfaces:

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

@ComponentProfile(summary="Transform a JSON document to XML, or vice versa",
                  tag="service,transform,json,xml")
public class JsonXmlTransformService
extends ServiceImp

XML to JSON converter and vice versa.

This service requires BOTH json.jar and json-lib-2.4-jdk15.jar on the classpath, since it supports both libraries to perform the conversion. Select a transformation driver to determine which library to use. The "simple" library (json.jar) yields simpler looking and cleaner XML, but will sometimes cause problems transforming XML elements into JSON arrays. The simple driver will behave exactly like the legacy JSON services, including requiring and generating an XML element names "json" to wrap the generated Xml.

The Default transformation driver uses json-lib-2.4-jdk15.jar and has a more complicated, but more information rich XML format. This format can then be used to precisely control the JSON output when converting to JSON, resolving issues like improper array generation. This driver always takes the entire message body as input and does not support converting only a part of it.

In the adapter configuration file this class is aliased as json-xml-transform-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
JsonXmlTransformService()
JsonXmlTransformService(TransformationDirection direction)
JsonXmlTransformService(TransformationDirection direction, TransformationDriver driver)

Method Summary

Modifier and Type	Method and Description
protected void	closeService()
void	doService(AdaptrisMessage msg) .
TransformationDirection	getDirection() Get the transformation direction.
TransformationDriver	getDriver() Get the transformation driver.
protected void	initService()
void	prepare()
void	setDirection(TransformationDirection direction) Set the transformation direction.
void	setDriver(TransformationDriver driver) Set the transformation driver.
JsonXmlTransformService	withDirection(TransformationDirection d)
JsonXmlTransformService	withDriver(TransformationDriver d)

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

JsonXmlTransformService

public JsonXmlTransformService()

JsonXmlTransformService

public JsonXmlTransformService(TransformationDirection direction)

JsonXmlTransformService

public JsonXmlTransformService(TransformationDirection direction,
                               TransformationDriver driver)

Method Detail

doService

public void doService(AdaptrisMessage msg)
               throws ServiceException

.

Throws:

ServiceException

prepare

public void prepare()
             throws CoreException

Throws:

CoreException

closeService

protected void closeService()

Specified by:

closeService in class ServiceImp

initService

protected void initService()
                    throws CoreException

Specified by:

initService in class ServiceImp

Throws:

CoreException

getDirection

public TransformationDirection getDirection()

Get the transformation direction.

Returns:

The transformation direction.

setDirection

public void setDirection(TransformationDirection direction)

Set the transformation direction.

Parameters:

direction - The transformation direction.

withDirection

public JsonXmlTransformService withDirection(TransformationDirection d)

getDriver

public TransformationDriver getDriver()

Get the transformation driver.

Returns:

The transformation driver.

setDriver

public void setDriver(TransformationDriver driver)

Set the transformation driver.

Parameters:

driver - The transformation driver.

withDriver

public JsonXmlTransformService withDriver(TransformationDriver d)