@ComponentProfile(summary="A collection of services", tag="service,base") public class ServiceList extends ServiceListBase
ServiceCollection
with an ordered list of Service
s.In the adapter configuration file this class is aliased as service-list which is the preferred alternative to the fully qualified classname when building your configuration.
eventHandler, log
CONFIRMATION_ID_KEY
Constructor and Description |
---|
ServiceList() |
ServiceList(java.util.Collection<Service> serviceList) |
ServiceList(Service... serviceList) |
Modifier and Type | Method and Description |
---|---|
protected void |
applyServices(AdaptrisMessage msg)
Apply the required services to the message.
|
protected void |
doInit()
Start any additional components.
|
java.lang.Boolean |
getAllowForwardSearch() |
void |
setAllowForwardSearch(java.lang.Boolean b)
Allow services to specify the
next service in a forward search mode only. |
doClose, doStart, doStop, haltProcessing
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
contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public ServiceList()
public ServiceList(java.util.Collection<Service> serviceList)
public ServiceList(Service... serviceList)
protected void doInit() throws CoreException
ServiceCollectionImp
doInit
in class ServiceListBase
CoreException
- wrapping any underlying exceptionprotected void applyServices(AdaptrisMessage msg) throws ServiceException
ServiceCollectionImp
applyServices
in class ServiceCollectionImp
msg
- the messageServiceException
- wrapping any underlying exception.public java.lang.Boolean getAllowForwardSearch()
public void setAllowForwardSearch(java.lang.Boolean b)
next service
in a forward search mode only.
If set to true, then the service-list will act like a limited BranchingServiceCollection
. It will
check AdaptrisMessage.getNextServiceId()
, and search the remaining services for that service-id. If found it will
execute that service (after clearing the next service id). Searches are forward only so you cannot jump backwards through the
service-list.
b
- true to allow limited skipping of (forward only) services based on AdaptrisMessage.setNextServiceId(String)
;
default is null(true).