Package com.adaptris.core

Class BranchingServiceCollection

java.lang.Object

java.util.AbstractCollection<Service>

com.adaptris.core.ServiceCollectionImp

com.adaptris.core.BranchingServiceCollection

All Implemented Interfaces:

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

@ComponentProfile(summary="A Collection of services where the next service is determined dynamically",
                  tag="service,base,branching")
public class BranchingServiceCollection
extends ServiceCollectionImp

Implementation of ServiceCollection which allows branching services to select the next service to apply.

In the adapter configuration file this class is aliased as branching-service-collection 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

Constructor Summary

Constructors

Constructor	Description
BranchingServiceCollection()
BranchingServiceCollection(java.util.Collection<Service> list)

Method Summary

Modifier and Type	Method	Description
protected void	applyServices(AdaptrisMessage msg)	Apply the required services to the message.
protected void	doClose()	Close any additional components.
protected void	doInit()	Start any additional components.
protected void	doStart()	Start any additional components.
protected void	doStop()	Stop any additional components.
protected Service	enforceRequirements(Service service)	Enforce any requirements of the list.
protected java.util.Collection<? extends Service>	enforceRequirements(java.util.Collection<? extends Service> collection)	Enforce any requirements of the list.
java.lang.String	getFirstServiceId()	Returns the unique ID of the first Service to apply.
void	setFirstServiceId(java.lang.String s)	Sets the unique ID of the first Service to apply.
BranchingServiceCollection	withFirstServiceId(java.lang.String s)

Methods inherited from class com.adaptris.core.ServiceCollectionImp

add, add, addAll, addAll, addService, changeState, clear, close, continueOnFailure, createName, createQualifier, doService, get, getComments, getContinueOnFail, getIsTrackingEndpoint, 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, 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.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

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

Constructor Detail

BranchingServiceCollection

public BranchingServiceCollection()

BranchingServiceCollection

public BranchingServiceCollection(java.util.Collection<Service> list)

Method Detail

enforceRequirements

protected Service enforceRequirements(Service service)

Description copied from class: ServiceCollectionImp

Enforce any requirements of the list.

Overrides:

enforceRequirements in class ServiceCollectionImp

Parameters:

service - the service due to be added.

Returns:

the service

enforceRequirements

protected java.util.Collection<? extends Service> enforceRequirements(java.util.Collection<? extends Service> collection)

Description copied from class: ServiceCollectionImp

Enforce any requirements of the list.

Overrides:

enforceRequirements in class ServiceCollectionImp

Parameters:

collection - the services due to be added.

Returns:

the collection

applyServices

protected void applyServices(AdaptrisMessage msg)
                      throws ServiceException

Description copied from class: ServiceCollectionImp

Apply the required services to the message.

Specified by:

applyServices in class ServiceCollectionImp

Parameters:

msg - the message

Throws:

ServiceException - wrapping any underlying exception.

doClose

protected void doClose()

Description copied from class: ServiceCollectionImp

Close any additional components.

Specified by:

doClose in class ServiceCollectionImp

doInit

protected void doInit()
               throws CoreException

Description copied from class: ServiceCollectionImp

Start any additional components.

Specified by:

doInit in class ServiceCollectionImp

Throws:

CoreException - wrapping any underlying exception

doStart

protected void doStart()
                throws CoreException

Description copied from class: ServiceCollectionImp

Start any additional components.

Specified by:

doStart in class ServiceCollectionImp

Throws:

CoreException - wrapping any underlying exception

doStop

protected void doStop()

Description copied from class: ServiceCollectionImp

Stop any additional components.

Specified by:

doStop in class ServiceCollectionImp

getFirstServiceId

public java.lang.String getFirstServiceId()

Returns the unique ID of the first Service to apply.

Returns:

the unique ID of the first Service to apply

setFirstServiceId

public void setFirstServiceId(java.lang.String s)

Sets the unique ID of the first Service to apply.

Parameters:

s - the unique ID of the first Service to apply

withFirstServiceId

public BranchingServiceCollection withFirstServiceId(java.lang.String s)