Package com.adaptris.core.services

Class StatelessServiceWrapper

java.lang.Object

com.adaptris.core.ServiceImp

com.adaptris.core.services.StatelessServiceWrapper

All Implemented Interfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, EventHandlerAware, MessageEventGenerator, Service, ServiceWrapper, StateManagedComponent

@ComponentProfile(summary="Wraps another service, with a strategy for restarting the service periodically",
                  tag="service")
public class StatelessServiceWrapper
extends ServiceImp
implements EventHandlerAware, ServiceWrapper

Stateless service wrapper, wraps any configured service and allows you to set a strategy on when to restart the service before allowing it to execute.

Consider using this wrapper on a service where you will periodically want to stop and re-start a service. Check RestartStrategy for the available restarting strategies. Note that some nested configuration will be ignored, particularly ServiceImp.setContinueOnFail(Boolean) in the nested service. If you want that behaviour, then you should explicitly configure it in this service.

In the adapter configuration file this class is aliased as stateless-service-wrapper 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
StatelessServiceWrapper()
StatelessServiceWrapper(Service s)

Method Summary

Modifier and Type	Method	Description
protected void	closeService()
java.lang.String	createName()	Create a name for any MleMarker that is generated.
java.lang.String	createQualifier()	Create a qualifier for any MleMarker that is generated.
void	doService(AdaptrisMessage msg)	Apply the service to the message.
java.lang.Boolean	getIsTrackingEndpoint()
RestartStrategy	getRestartStrategy()
Service	getService()
protected void	initService()
boolean	isBranching()	Returns true if the implementation supports branching.
boolean	isTrackingEndpoint()	Returns true if this should be considered an 'end-point' for tracking purposes, otherwise false.
void	prepare()	Prepare for initialisation.
void	registerEventHandler(EventHandler eh)	Register the current event handler against this component.
void	setIsTrackingEndpoint(java.lang.Boolean b)	whether or not this service is is a tracking endpoint.
void	setRestartStrategy(RestartStrategy restartStrategy)
void	setService(Service s)
void	start()	Starts the component.
void	stop()	Stop the component
Service[]	wrappedServices()	Return all the services that are wrapped by this service.

Methods inherited from class com.adaptris.core.ServiceImp

changeState, close, continueOnFailure, getContinueOnFail, getUniqueId, init, requestClose, requestInit, requestStart, requestStop, retrieveComponentState, setContinueOnFail, setUniqueId

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adaptris.core.AdaptrisComponent

getUniqueId

Methods inherited from interface com.adaptris.core.ComponentLifecycle

close, init

Methods inherited from interface com.adaptris.core.Service

continueOnFailure, setUniqueId

Methods inherited from interface com.adaptris.core.StateManagedComponent

changeState, requestClose, requestInit, requestStart, requestStop, retrieveComponentState

Constructor Detail

StatelessServiceWrapper

public StatelessServiceWrapper()

StatelessServiceWrapper

public StatelessServiceWrapper(Service s)

Method Detail

stop

public void stop()

Description copied from interface: ComponentLifecycle

Stop the component

A stopped component is not expected to be ready to process messages. In the case of AdaptrisMessageConsumer, calling stop will pause message delivery. Throwing a RuntimeException may cause unintended consequences

Specified by:

stop in interface ComponentLifecycle

Overrides:

stop in class ServiceImp

start

public void start()
           throws CoreException

Description copied from interface: ComponentLifecycle

Starts the component.

Once a component is started it should be ready to process messages. In the case of AdaptrisMessageConsumer, calling start will begin message delivery.

Specified by:

start in interface ComponentLifecycle

Overrides:

start in class ServiceImp

Throws:

CoreException - wrapping any underlying Exceptions

See Also:

AdaptrisComponent

createName

public java.lang.String createName()

Description copied from interface: MessageEventGenerator

Create a name for any MleMarker that is generated.

The default implementation is to return the classname of the component in question.

* @return the name for any MleMarker that is generated.

Specified by:

createName in interface MessageEventGenerator

Overrides:

createName in class ServiceImp

createQualifier

public java.lang.String createQualifier()

Description copied from interface: MessageEventGenerator

Create a qualifier for any MleMarker that is generated.

The default implementation is to return the unique-id of the component in question, or the empty string if not configured

Specified by:

createQualifier in interface MessageEventGenerator

Overrides:

createQualifier in class ServiceImp

Returns:

the qualifier for any MleMarker that is generated.

isTrackingEndpoint

public boolean isTrackingEndpoint()

Description copied from interface: MessageEventGenerator

Returns true if this should be considered an 'end-point' for tracking purposes, otherwise false.

Specified by:

isTrackingEndpoint in interface MessageEventGenerator

Overrides:

isTrackingEndpoint in class ServiceImp

Returns:

true if this should be considered an 'end-point' for tracking purposes, otherwise false

isBranching

public boolean isBranching()

Description copied from interface: Service

Returns true if the implementation supports branching.

Specified by:

isBranching in interface Service

Overrides:

isBranching in class ServiceImp

Returns:

true if the implementation supports branching

See Also:

BranchingServiceCollection

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.

Specified by:

prepare in interface ComponentLifecycleExtension

Throws:

CoreException

doService

public void doService(AdaptrisMessage msg)
               throws ServiceException

Description copied from interface: Service

Apply the service to the message.

Specified by:

doService in interface Service

Parameters:

msg - the AdaptrisMessage to process

Throws:

ServiceException - wrapping any underlying Exceptions

getService

public Service getService()

Returns:

the wrappedService

setService

public void setService(Service s)

Parameters:

s - the wrappedService to set

getIsTrackingEndpoint

public java.lang.Boolean getIsTrackingEndpoint()

Overrides:

getIsTrackingEndpoint in class ServiceImp

setIsTrackingEndpoint

public void setIsTrackingEndpoint(java.lang.Boolean b)

Description copied from class: ServiceImp

whether or not this service is is a tracking endpoint.

Overrides:

setIsTrackingEndpoint in class ServiceImp

Parameters:

b - true/false, default if not specified is false.

getRestartStrategy

public RestartStrategy getRestartStrategy()

setRestartStrategy

public void setRestartStrategy(RestartStrategy restartStrategy)

registerEventHandler

public void registerEventHandler(EventHandler eh)

Description copied from interface: EventHandlerAware

Register the current event handler against this component.

Specified by:

registerEventHandler in interface EventHandlerAware

Parameters:

eh - the event handler currently in use.

wrappedServices

public Service[] wrappedServices()

Description copied from interface: ServiceWrapper

Return all the services that are wrapped by this service.

Specified by:

wrappedServices in interface ServiceWrapper

Returns:

an array of wrapped services.