com.adaptris.core.services.routing

Class SyntaxBranchingService

java.lang.Object

com.adaptris.core.ServiceImp

com.adaptris.core.BranchingServiceImp

com.adaptris.core.services.routing.SyntaxBranchingService

All Implemented Interfaces:

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

@ComponentProfile(summary="Perform a branch based on the derived syntax of the message",
                  tag="service,branching",
                  branchSelector=true)
public class SyntaxBranchingService
extends BranchingServiceImp

Branching Service which determines the next Service to apply according to SyntaxIdentifiers, as used by SyntaxRoutingService.

See Also:

SyntaxIdentifier, SyntaxRoutingService

In the adapter configuration file this class is aliased as syntax-branching-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
SyntaxBranchingService()

Method Summary

Modifier and Type	Method and 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.util.List<SyntaxIdentifier>	getSyntaxIdentifiers() Return the list of configured SyntaxIdentifers.
protected void	initService()
void	prepare() Prepare for initialisation.
void	setSyntaxIdentifiers(java.util.List<SyntaxIdentifier> l) Sets the list of configured SyntaxIdentifers.

Methods inherited from class com.adaptris.core.BranchingServiceImp

isBranching

Methods inherited from class com.adaptris.core.ServiceImp

changeState, close, continueOnFailure, createName, createQualifier, getContinueOnFail, getIsTrackingEndpoint, getLookupName, getUniqueId, init, 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

SyntaxBranchingService

public SyntaxBranchingService()

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:

#doService(com.adaptris.core.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.

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