com.adaptris.stax.services

Class ServiceListWithPlugin

java.lang.Object

java.util.AbstractCollection<Service>

com.adaptris.core.ServiceCollectionImp

com.adaptris.core.ServiceListBase

com.adaptris.core.ServiceList

com.adaptris.stax.services.ServiceListWithPlugin

All Implemented Interfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, ConfigComment, EventHandlerAware, JndiBindable, MessageEventGenerator, Service, ServiceCollection, StateManagedComponent, java.lang.Iterable<Service>, java.util.Collection<Service>, java.util.List<Service>

@ComponentProfile(summary="Conditionally map from one format to another on entry and exit via STaX",
                  since="3.8.4",
                  tag="xml,stax,json")
public class ServiceListWithPlugin
extends ServiceList

Allows you to optionally transform from one format to another upon entry and exit of this service.

This allows you to transform the message payload from one format to another upon entry and exit to this ServiceList implementation. This means you that you can automatically convert between JSON and XML (using com.adaptris.core.json.streaming.JsonStreamingInputFactory and XmlOutputFactoryBuilder; do your services treating the payload as XML, and render the result as JSON automatically.

The standard implementation of Plugin which is StaxTransformPlugin allows you to specify a rule under which you perform the transforms (an expression based metadata value against a regular expression). If the rule is true, then the transform is applied; otherwise it is a no-op operation.

Note that this behaviour is achievable in a number of ways with Interlok itself already, most easily with the interlok-config-conditional package; this is simply a convenience. There will also be situations where streaming from JSON to XML won't work, such as when the incoming message is a JSON array (you may need to have additional post configuration) or when the XML has attributes.

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

Field Summary

Fields inherited from class com.adaptris.core.ServiceCollectionImp

eventHandler, log

Fields inherited from interface com.adaptris.core.MessageEventGenerator

CONFIRMATION_ID_KEY

Constructor Summary

Constructors

Constructor and Description
ServiceListWithPlugin()

Method Summary

Modifier and Type	Method and Description
protected void	applyServices(AdaptrisMessage msg)
protected void	doClose()
protected void	doInit()
protected void	doStart()
protected void	doStop()
Plugin	getOnEntry()
Plugin	getOnExit()
void	setOnEntry(Plugin onEntry)
void	setOnExit(Plugin onExit)
ServiceListWithPlugin	withOnEntry(Plugin onEntry)
ServiceListWithPlugin	withOnExit(Plugin onEntry)

Methods inherited from class com.adaptris.core.ServiceList

getAllowForwardSearch, setAllowForwardSearch

Methods inherited from class com.adaptris.core.ServiceListBase

haltProcessing

Methods inherited from class com.adaptris.core.ServiceCollectionImp

add, add, addAll, addAll, addService, changeState, clear, close, continueOnFailure, createName, createQualifier, doService, enforceRequirements, enforceRequirements, get, getComments, getContinueOnFail, getIsTrackingEndpoint, getLookupName, getOutOfStateHandler, getRestartAffectedServiceOnException, getServices, getUniqueId, handleException, indexOf, init, isBranching, isTrackingEndpoint, iterator, lastIndexOf, listIterator, listIterator, prepare, registerEventHandler, remove, requestClose, requestInit, requestStart, requestStop, retrieveComponentState, set, setComments, setContinueOnFail, setIsTrackingEndpoint, setLookupName, setOutOfStateHandler, setRestartAffectedServiceOnException, setServices, setUniqueId, size, start, stop, subList, withServices

Methods inherited from class java.util.AbstractCollection

contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

contains, containsAll, equals, hashCode, isEmpty, remove, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

ServiceListWithPlugin

public ServiceListWithPlugin()

Method Detail

applyServices

protected void applyServices(AdaptrisMessage msg)
                      throws ServiceException

Overrides:

applyServices in class ServiceList

Throws:

ServiceException

doInit

protected void doInit()
               throws CoreException

Overrides:

doInit in class ServiceList

Throws:

CoreException

doStart

protected void doStart()
                throws CoreException

Overrides:

doStart in class ServiceListBase

Throws:

CoreException

doStop

protected void doStop()

Overrides:

doStop in class ServiceListBase

doClose

protected void doClose()

Overrides:

doClose in class ServiceListBase

getOnEntry

public Plugin getOnEntry()

setOnEntry

public void setOnEntry(Plugin onEntry)

withOnEntry

public ServiceListWithPlugin withOnEntry(Plugin onEntry)

getOnExit

public Plugin getOnExit()

setOnExit

public void setOnExit(Plugin onExit)

withOnExit

public ServiceListWithPlugin withOnExit(Plugin onEntry)