Package com.adaptris.core.services.routing

Class SyntaxRoutingService

java.lang.Object

com.adaptris.core.ServiceImp

com.adaptris.core.services.routing.SyntaxRoutingService

All Implemented Interfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, MessageEventGenerator, Service, StateManagedComponent

@ComponentProfile(summary="Identify a message, and set a metadata key based on the identifier",
                  tag="service,routing")
public class SyntaxRoutingService
extends ServiceImp

Extracts data from an AdaptrisMessage and stores it against metadata.

This is somewhat similar to the available MetadataService, however it uses a list of SyntaxIdentifiers in order to determine the value that should be stored against a particular metadata key.

Each SyntaxIdentifier is tried in turn, until true is returned by the method isThisSyntax(AdaptrisMessage). At this point, the value returned by getDestination() is stored against the configured key.

In the adapter configuration file this class is aliased as syntax-routing-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

Constructor Summary

Constructors

Constructor	Description
SyntaxRoutingService()

Method Summary

Modifier and Type	Method	Description
void	addSyntaxIdentifier(SyntaxIdentifier ident)	Add a SyntaxIdentifier to the configured list.
protected void	closeService()
void	doService(AdaptrisMessage msg)	Apply the service to the message.
java.lang.String	getRoutingKey()	Get the metadata key that the value will be stored against.
java.util.List<SyntaxIdentifier>	getSyntaxIdentifiers()	Return the list of configured SyntaxIdentifers.
protected void	initService()
void	prepare()	Prepare for initialisation.
void	setRoutingKey(java.lang.String key)	Set the metadata key that the value will be stored against.
void	setSyntaxIdentifiers(java.util.List<SyntaxIdentifier> l)	Sets the list of configured SyntaxIdentifers.

Methods inherited from class com.adaptris.core.ServiceImp

changeState, close, continueOnFailure, createName, createQualifier, getContinueOnFail, getIsTrackingEndpoint, getUniqueId, init, isBranching, isTrackingEndpoint, requestClose, requestInit, requestStart, requestStop, retrieveComponentState, setContinueOnFail, setIsTrackingEndpoint, setUniqueId, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

SyntaxRoutingService

public SyntaxRoutingService()

Method Detail

doService

public void doService(AdaptrisMessage msg)
               throws ServiceException

Description copied from interface: Service

Apply the service to the message.

Parameters:

msg - the AdaptrisMessage to process

Throws:

ServiceException - wrapping any underlying Exceptions

See Also:

Service.doService(AdaptrisMessage)

addSyntaxIdentifier

public void addSyntaxIdentifier(SyntaxIdentifier ident)

Add a SyntaxIdentifier to the configured list.

Parameters:

ident - the SyntaxIdentifier.

getSyntaxIdentifiers

public java.util.List<SyntaxIdentifier> getSyntaxIdentifiers()

Return the list of configured SyntaxIdentifers.

Returns:

the list.

setSyntaxIdentifiers

public void setSyntaxIdentifiers(java.util.List<SyntaxIdentifier> l)

Sets the list of configured SyntaxIdentifers.

Parameters:

l - the list.

setRoutingKey

public void setRoutingKey(java.lang.String key)

Set the metadata key that the value will be stored against.

Parameters:

key - the key.

getRoutingKey

public java.lang.String getRoutingKey()

Get the metadata key that the value will be stored against.

Returns:

the key.

initService

protected void initService()
                    throws CoreException

Specified by:

initService in class ServiceImp

Throws:

CoreException

closeService

protected void closeService()

Specified by:

closeService in class ServiceImp

prepare

public void prepare()
             throws CoreException

Description copied from interface: ComponentLifecycleExtension

Prepare for initialisation.

Throws:

CoreException