com.adaptris.core

Interface AdaptrisMessageListener

All Known Subinterfaces:

FailedMessageRetrier, Workflow

All Known Implementing Classes:

DefaultFailedMessageRetrier, FailedMessageRetrierImp, JmsReplyToWorkflow, JmsTransactedWorkflow, LargeMessageWorkflow, MultiProducerWorkflow, NoRetries, PoolingWorkflow, RequestReplyWorkflow, StandardWorkflow, StandardWorkflowImpl, WorkflowImp

public interface AdaptrisMessageListener

Applies arbitrary processing to AdaptrisMessages. Applicable where the calling code does not want to be informed of any Exceptions that may occur. Service is applicable where the container requires to be informed of Exceptions.

See Also:

Service

Method Summary

Modifier and Type	Method and Description
java.lang.String	friendlyName() Get the friendly name for this component.
void	onAdaptrisMessage(AdaptrisMessage msg) It is the responsibility of implementations of this interface to ensure that all Exceptions, including RuntimeExceptions, are handled.

Method Detail

onAdaptrisMessage

void onAdaptrisMessage(AdaptrisMessage msg)

It is the responsibility of implementations of this interface to ensure that all Exceptions, including RuntimeExceptions, are handled. Failure to handle any Exception will result in undefined behaviour. Throwing a RuntimeException to this method is considered a bug.

Although most clients of implementations of this interface are likely to be single-threaded, if implementations are not guaranteed to be thread safe, they should be synchronized or use some other locking mechanism.

Parameters:

msg - the AdaptrisMessage to process

friendlyName

java.lang.String friendlyName()

Get the friendly name for this component.

Returns:

the friendly name.