com.adaptris.core

Class StandaloneProducer

java.lang.Object

com.adaptris.core.ServiceImp

com.adaptris.core.StandaloneProducer

All Implemented Interfaces:

AdaptrisComponent, AdaptrisMessageSender, ComponentLifecycle, ComponentLifecycleExtension, ConnectedService, MessageEventGenerator, Service, StateManagedComponent

Direct Known Subclasses:

RetryOnceStandaloneProducer, StandaloneRequestor

@ComponentProfile(summary="Produce a message where as part of a service chain",
                  tag="service")
public class StandaloneProducer
extends ServiceImp
implements AdaptrisMessageSender, ConnectedService

Wrapper for a AdaptrisConnection and a AdaptrisMessageProducer for convenience. Also implements Service for use in ServiceCollections.

See Also:

AdaptrisMessageSender

In the adapter configuration file this class is aliased as standalone-producer 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 and Description
StandaloneProducer() Creates a new instance.
StandaloneProducer(AdaptrisConnection c, AdaptrisMessageProducer p)
StandaloneProducer(AdaptrisMessageProducer p)

Method Summary

Modifier and Type	Method and 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.
AdaptrisConnection	getConnection() Returns the connection to use.
AdaptrisMessageProducer	getProducer() Returns the producer to use.
protected void	initService()
void	prepare() Prepare for initialisation.
void	produce(AdaptrisMessage msg) Produces the AdaptrisMessage to the default destination.
void	produce(AdaptrisMessage msg, ProduceDestination dest) Produce the AdaptrisMessage to the supplied ProduceDestination , over-riding any configured destinations.
void	setConnection(AdaptrisConnection conn) Sets the connection to use, may not be null.
void	setProducer(AdaptrisMessageProducer prod) Sets the producer to use, may not be null.
void	start() Starts the component.
void	stop() Stop the component

Methods inherited from class com.adaptris.core.ServiceImp

changeState, close, continueOnFailure, getContinueOnFail, getIsTrackingEndpoint, getUniqueId, init, isBranching, isTrackingEndpoint, requestClose, requestInit, requestStart, requestStop, retrieveComponentState, setContinueOnFail, setIsTrackingEndpoint, 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.Service

continueOnFailure, isBranching, setUniqueId

Methods inherited from interface com.adaptris.core.MessageEventGenerator

isTrackingEndpoint

Methods inherited from interface com.adaptris.core.StateManagedComponent

changeState, requestClose, requestInit, requestStart, requestStop, retrieveComponentState

Methods inherited from interface com.adaptris.core.AdaptrisComponent

getUniqueId

Methods inherited from interface com.adaptris.core.ComponentLifecycle

close, init

Constructor Detail

StandaloneProducer

public StandaloneProducer()

Creates a new instance. Defaults to null connection / producer.

StandaloneProducer

public StandaloneProducer(AdaptrisMessageProducer p)

StandaloneProducer

public StandaloneProducer(AdaptrisConnection c,
                          AdaptrisMessageProducer p)

Method Detail

produce

public void produce(AdaptrisMessage msg)
             throws ProduceException

Description copied from interface: AdaptrisMessageSender

Produces the AdaptrisMessage to the default destination.

Specified by:

produce in interface AdaptrisMessageSender

Parameters:

msg - the @link AdaptrisMessage} to produce

Throws:

ProduceException - wrapping any underlying Exceptions

produce

public void produce(AdaptrisMessage msg,
                    ProduceDestination dest)
             throws ProduceException

Description copied from interface: AdaptrisMessageSender

Produce the AdaptrisMessage to the supplied ProduceDestination , over-riding any configured destinations.

Specified by:

produce in interface AdaptrisMessageSender

Parameters:

msg - the AdaptrisMessage to produce

dest - the ProduceDestination to produce to

Throws:

ProduceException - wrapping any underlying Exceptions

initService

protected void initService()
                    throws CoreException

Specified by:

initService in class ServiceImp

Throws:

CoreException

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:

ComponentLifecycle.start()

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

See Also:

ComponentLifecycle.stop()

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

getConnection

public AdaptrisConnection getConnection()

Returns the connection to use.

Specified by:

getConnection in interface ConnectedService

Returns:

the connection to use

getProducer

public AdaptrisMessageProducer getProducer()

Returns the producer to use.

Returns:

the producer to use

setConnection

public void setConnection(AdaptrisConnection conn)

Sets the connection to use, may not be null.

Specified by:

setConnection in interface ConnectedService

Parameters:

conn - the connection to use, may not be null

setProducer

public void setProducer(AdaptrisMessageProducer prod)

Sets the producer to use, may not be null.

Parameters:

prod - the producer to use, may not be null

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

See Also:

#doService(com.adaptris.core.AdaptrisMessage)

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.