nl.nn.adapterframework.receivers

Class Receiver<M>

java.lang.Object

nl.nn.adapterframework.core.TransactionAttributes

nl.nn.adapterframework.receivers.Receiver<M>

All Implemented Interfaces:

HasSender, HasTransactionAttribute, IbisExceptionListener, IConfigurable, IConfigurationAware, IHasProcessState<Object>, IManagable, IMessageHandler<M>, INamedObject, IProvidesMessageBrowsers<Object>, IReceiverStatistics, IScopeProvider, IThreadCountControllable, EventThrowing, HasStatistics, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

GenericReceiver

@Category(value="Basic")
public class Receiver<M>
extends TransactionAttributes
implements IManagable, IReceiverStatistics, IMessageHandler<M>, IProvidesMessageBrowsers<Object>, EventThrowing, IbisExceptionListener, HasSender, HasStatistics, IThreadCountControllable, org.springframework.beans.factory.BeanFactoryAware

Wrapper for a listener that specifies a channel for the incoming messages of a specific Adapter. By choosing a listener, the Frank developer determines how the messages are received. For example, an ApiListener receives RESTful HTTP requests and a JavaListener receives messages from direct Java calls.

Apart from wrapping the listener, a Receiver can be configured to store received messages and to keep track of the processed / failed status of these messages.

There are two kinds of listeners: synchronous listeners and asynchronous listeners. Synchronous listeners are expected to return a response. The system that triggers the receiver typically waits for a response before proceeding its operation. When a ApiListener receives a HTTP request, the listener is expected to return a HTTP response. Asynchronous listeners are not expected to return a response. The system that triggers the listener typically continues without waiting for the adapter to finish. When a receiver contains an asynchronous listener, it can have a sender that sends the transformed message to its destination. Receivers with an asynchronous listener can also have an error sender that is used by the receiver to send error messages. In other words: if the result state is SUCCESS then the message is sent by the ordinary sender, while the error sender is used if the result state is ERROR.

Transaction control

If transacted is set to true, messages will be received and processed under transaction control. This means that after a message has been read and processed and the transaction has ended, one of the following apply:

situation	input listener	Pipeline	inProcess storage	errorSender	summary of effect
successful	message read and committed	message processed	unchanged	unchanged	message processed
procesing failed	message read and committed	message processing failed and rolled back	unchanged	message sent	message only transferred from listener to errroSender
listening failed	unchanged: listening rolled back	no processing performed	unchanged	unchanged	no changes, input message remains on input available for listener
transfer to inprocess storage failed	unchanged: listening rolled back	no processing performed	unchanged	unchanged	no changes, input message remains on input available for listener
transfer to errorSender failed	message read and committed	message processing failed and rolled back	message present	unchanged	message only transferred from listener to inProcess storage

If the application or the server crashes in the middle of one or more transactions, these transactions will be recovered and rolled back after the server/application is restarted. Then always exactly one of the following applies for any message touched at any time by Ibis by a transacted receiver:
• It is processed correctly by the pipeline and removed from the input-queue, not present in inProcess storage and not send to the errorSender
• It is not processed at all by the pipeline, or processing by the pipeline has been rolled back; the message is removed from the input queue and either (one of) still in inProcess storage or sent to the errorSender

commit or rollback
If transacted is set to true, messages will be either committed or rolled back. All message-processing transactions are committed, unless one or more of the following apply:

• The PipeLine is transacted and the exitState of the pipeline is not equal to SUCCESS
• a PipeRunException or another runtime-exception has been thrown by any Pipe or by the PipeLine
• the setRollBackOnly() method has been called on the userTransaction (not accessible by Pipes)

Since:

4.2

Author:

Gerrit van Brakel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Receiver.CheckForDuplicatesMethod
static class	Receiver.OnError

Nested classes/interfaces inherited from interface nl.nn.adapterframework.statistics.HasStatistics

HasStatistics.Action

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_RETRY_INTERVAL
static String	RCV_CONFIGURATIONEXCEPTION_MONITOR_EVENT
static String	RCV_CONFIGURED_MONITOR_EVENT
static String	RCV_MESSAGE_LOG_COMMENTS
static String	RCV_MESSAGE_TO_ERRORSTORE_EVENT
static String	RCV_RESUMED_MONITOR_EVENT
static String	RCV_SHUTDOWN_MONITOR_EVENT
static String	RCV_STARTED_RUNNING_MONITOR_EVENT
static String	RCV_SUSPENDED_MONITOR_EVENT
static int	RCV_SUSPENSION_MESSAGE_THRESHOLD
static String	RCV_THREAD_EXIT_MONITOR_EVENT
static String	RETRY_FLAG_SESSION_KEY
protected RunStateManager	runState
static String	THREAD_CONTEXT_KEY_NAMEOF
static org.springframework.transaction.TransactionDefinition	TXNEW_CTRL
org.springframework.transaction.TransactionDefinition	TXNEW_PROC
static org.springframework.transaction.TransactionDefinition	TXREQUIRED

Fields inherited from class nl.nn.adapterframework.core.TransactionAttributes

log

Constructor Summary

Constructors

Constructor and Description
Receiver()

Method Summary

Modifier and Type	Method and Description
void	cacheProcessResult(String messageId, String errorMessage, Date receivedDate)
M	changeProcessState(Object message, ProcessState toState, String reason) Change the processState of the message to the specified state, if that state is supported.
protected void	closeAllResources() Should only close resources when in state stopping (or error)! this should be the only trigger to change the state to stopped On exit resources must be 'closed' so the receiver RunState can be set to 'STOPPED'
boolean	configurationSucceeded()
void	configure() This method is called by the IAdapter to let the receiver do things to initialize itself before the startListening method is called.
PullingListenerContainer<M>	createListenerContainer()
void	decreaseThreadCount()
protected void	error(String msg, Throwable t) sends a error message to the log and to the messagekeeper of the adapter
void	exceptionThrown(INamedObject object, Throwable t) Inform the implementing class that the exception t occurred in object.
void	exceptionThrown(String errorMessage, Throwable t)
protected void	finishProcessingMessage(long processingDuration)
Message	formatException(String extrainfo, String correlationId, Message message, Throwable t) Formats any exception thrown by any of the above methods to a message that can be returned.
org.springframework.beans.factory.BeanFactory	getBeanFactory()
String	getCachedErrorMessage(String messageId)
int	getCurrentThreadCount()
int	getDeliveryCount(String messageId, M rawMessage)
String	getEventSourceName()
Iterable<StatisticsKeeper>	getIdleStatistics() Returns an iterator over the idle-statistics
protected StatisticsKeeper	getIdleStatistics(int threadsProcessing)
long	getLastMessageDate()
PullingListenerContainer<M>	getListenerContainer()
protected String	getLogPrefix()
int	getMaxThreadCount()
IMessageBrowser<Object>	getMessageBrowser(ProcessState state) returns a browser of messages that are in ProcessState 'state', and are stored in a storage managed by the listener itself (as opposed to a storage configured as a messageLog or errorStorage in the configuration).
long	getMessagesReceived() get the number of messages received by this receiver.
long	getMessagesRejected() Get the number of messages rejected (discarded or put in errorStorage).
long	getMessagesRetried() get the number of duplicate messages received this receiver.
Iterable<StatisticsKeeper>	getProcessStatistics() Returns an iterator over the process-statistics
protected StatisticsKeeper	getProcessStatistics(int threadsProcessing)
Iterable<StatisticsKeeper>	getQueueingStatistics()
RunState	getRunState() Get the runstate of this receiver.
boolean	hasProblematicHistory(String messageId, boolean manualRetry, Object rawMessageOrWrapper, ThrowingSupplier<Message,ListenerException> messageSupplier, Map<String,Object> threadContext, String correlationId)
void	increaseRetryIntervalAndWait(Throwable t, String description)
void	increaseThreadCount()
protected void	info(String msg) sends an informational message to the log and to the messagekeeper of the adapter
boolean	isInRunState(RunState someRunState)
boolean	isOnErrorContinue()
boolean	isThreadCountControllable()
boolean	isThreadCountReadable()
void	iterateOverStatistics(StatisticsKeeperIterationHandler hski, Object data, HasStatistics.Action action)
Set<ProcessState>	knownProcessStates() Provides the set of ProcessStates used by this listener.
void	moveInProcessToError(String originalMessageId, String correlationId, ThrowingSupplier<Message,ListenerException> messageSupplier, Date receivedDate, String comments, Object rawMessage, org.springframework.transaction.TransactionDefinition txDef)
protected void	openAllResources()
void	processRawMessage(IListener<M> origin, M rawMessage) Same as IMessageHandler.processRawMessage(IListener,Object,PipeLineSession, boolean), but now without context, for convenience
void	processRawMessage(IListener<M> origin, M rawMessage, PipeLineSession session, boolean duplicatesAlreadyChecked) Will use listener to perform getIdFromRawMessage(), getStringFromRawMessage and afterMessageProcessed
void	processRawMessage(IListener<M> origin, M rawMessage, PipeLineSession session, long waitingDuration, boolean duplicatesAlreadyChecked) Same as IMessageHandler.processRawMessage(IListener,Object,PipeLineSession, boolean), but now updates IdleStatistics too
Message	processRequest(IListener<M> origin, String correlationId, M rawMessage, Message message, PipeLineSession session) Process the received message with processRequest(IListener, String, Object, Message, PipeLineSession).
protected void	propagateName()
protected void	registerEvent(String eventCode)
void	resetNumberOfExceptionsCaughtWithoutMessageBeingReceived()
void	resetRetryInterval()
void	retryMessage(String storageKey)
void	setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory)
void	setCheckForDuplicates(boolean b)
void	setCheckForDuplicatesMethod(Receiver.CheckForDuplicatesMethod method)
void	setChompCharSize(String string)
void	setCorrelationIDNamespaceDefs(String correlationIDNamespaceDefs)
void	setCorrelationIDStyleSheet(String string)
void	setCorrelationIDXPath(String string)
void	setElementToMove(String string)
void	setElementToMoveChain(String string)
void	setElementToMoveSessionKey(String string)
void	setErrorSender(ISender errorSender) Sender that will send the result in case the PipeLineExit state was not SUCCESS.
void	setErrorStorage(ITransactionalStorage<Serializable> errorStorage)
void	setForceRetryFlag(boolean b)
void	setHiddenInputSessionKeys(String string)
void	setHideMethod(IMessageBrowser.HideMethod hideMethod)
void	setHideRegex(String hideRegex)
void	setInProcessStorage(ITransactionalStorage<Serializable> inProcessStorage) Deprecated.
void	setLabelNamespaceDefs(String labelNamespaceDefs)
void	setLabelStyleSheet(String string)
void	setLabelXPath(String string)
void	setListener(IListener<M> newListener) Sets the listener used to receive messages from.
void	setListenerContainer(PullingListenerContainer<M> listenerContainer)
void	setMaxDeliveries(int i)
void	setMaxRetries(int i)
void	setMessageLog(ITransactionalStorage<Serializable> messageLog)
void	setName(String newName) Sets the name of the Receiver.
void	setNumberOfExceptionsCaughtWithoutMessageBeingReceivedThreshold(int number)
void	setNumThreads(int newNumThreads) The number of threads that this receiver is configured to work with.
void	setNumThreadsPolling(int i)
void	setOnError(Receiver.OnError value)
void	setPollInterval(int i)
void	setProcessResultCacheSize(int processResultCacheSize)
void	setRemoveCompactMsgNamespaces(boolean b)
void	setReturnedSessionKeys(String string)
void	setRunState(RunState state) Changes runstate.
void	setSender(ISender sender) Sender to which the response (output of PipeLine) should be sent.
void	setStartTimeout(int i) timeout to start receiver.
void	setStopTimeout(int i) timeout to stopped receiver.
protected void	startProcessingMessage(long waitingDuration)
void	startRunning() Instruct the object that implements IManagable to start working.
void	stopRunning() Instruct the object that implements IManagable to stop working.
Map<ProcessState,Set<ProcessState>>	targetProcessStates() Provides the set of ProcessStates that a message in the specified state can be moved to, e.g.
protected void	tellResourcesToStop() must lead to a 'closeAllResources()' and runstate must be 'STOPPING' if IPushingListener -> call closeAllResources() if IPullingListener -> PullingListenerContainer has to call closeAllResources();
protected void	throwEvent(String eventCode)
String	toString() Returns a toString of this class by introspection and the toString() value of its listener.
protected void	warn(String msg) sends a warning to the log and to the messagekeeper of the adapter

Methods inherited from class nl.nn.adapterframework.core.TransactionAttributes

configureTransactionAttributes, isTransacted, isTransacted, setTransacted, setTransactionTimeout

Methods inherited from class java.lang.Object

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

Methods inherited from interface nl.nn.adapterframework.core.INamedObject

getName

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware

getApplicationContext, getName

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider

getConfigurationClassLoader

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface nl.nn.adapterframework.monitoring.EventThrowing

getAdapter

Methods inherited from interface nl.nn.adapterframework.core.HasSender

getSender

Methods inherited from interface nl.nn.adapterframework.core.HasTransactionAttribute

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Field Detail

TXREQUIRED

public static final org.springframework.transaction.TransactionDefinition TXREQUIRED

TXNEW_CTRL

public static final org.springframework.transaction.TransactionDefinition TXNEW_CTRL

TXNEW_PROC

public org.springframework.transaction.TransactionDefinition TXNEW_PROC

THREAD_CONTEXT_KEY_NAMEOF

public static final String THREAD_CONTEXT_KEY_NAMEOF

See Also:

Constant Field Values

RCV_CONFIGURED_MONITOR_EVENT

public static final String RCV_CONFIGURED_MONITOR_EVENT

See Also:

Constant Field Values

RCV_CONFIGURATIONEXCEPTION_MONITOR_EVENT

public static final String RCV_CONFIGURATIONEXCEPTION_MONITOR_EVENT

See Also:

Constant Field Values

RCV_STARTED_RUNNING_MONITOR_EVENT

public static final String RCV_STARTED_RUNNING_MONITOR_EVENT

See Also:

Constant Field Values

RCV_SHUTDOWN_MONITOR_EVENT

public static final String RCV_SHUTDOWN_MONITOR_EVENT

See Also:

Constant Field Values

RCV_SUSPENDED_MONITOR_EVENT

public static final String RCV_SUSPENDED_MONITOR_EVENT

See Also:

Constant Field Values

RCV_RESUMED_MONITOR_EVENT

public static final String RCV_RESUMED_MONITOR_EVENT

See Also:

Constant Field Values

RCV_THREAD_EXIT_MONITOR_EVENT

public static final String RCV_THREAD_EXIT_MONITOR_EVENT

See Also:

Constant Field Values

RCV_MESSAGE_TO_ERRORSTORE_EVENT

public static final String RCV_MESSAGE_TO_ERRORSTORE_EVENT

See Also:

Constant Field Values

RCV_MESSAGE_LOG_COMMENTS

public static final String RCV_MESSAGE_LOG_COMMENTS

See Also:

Constant Field Values

RCV_SUSPENSION_MESSAGE_THRESHOLD

public static final int RCV_SUSPENSION_MESSAGE_THRESHOLD

See Also:

Constant Field Values

MAX_RETRY_INTERVAL

public static final int MAX_RETRY_INTERVAL

See Also:

Constant Field Values

RETRY_FLAG_SESSION_KEY

public static final String RETRY_FLAG_SESSION_KEY

See Also:

Constant Field Values

runState

protected RunStateManager runState

Constructor Detail

Receiver

public Receiver()

Method Detail

configurationSucceeded

public boolean configurationSucceeded()

getLogPrefix

protected String getLogPrefix()

info

protected void info(String msg)

sends an informational message to the log and to the messagekeeper of the adapter

warn

protected void warn(String msg)

sends a warning to the log and to the messagekeeper of the adapter

error

protected void error(String msg,
                     Throwable t)

sends a error message to the log and to the messagekeeper of the adapter

openAllResources

protected void openAllResources()
                         throws ListenerException,
                                TimeoutException

Throws:

ListenerException

TimeoutException

tellResourcesToStop

protected void tellResourcesToStop()

must lead to a 'closeAllResources()' and runstate must be 'STOPPING' if IPushingListener -> call closeAllResources() if IPullingListener -> PullingListenerContainer has to call closeAllResources();

closeAllResources

protected void closeAllResources()

Should only close resources when in state stopping (or error)! this should be the only trigger to change the state to stopped On exit resources must be 'closed' so the receiver RunState can be set to 'STOPPED'

propagateName

protected void propagateName()

configure

public void configure()
               throws ConfigurationException

This method is called by the IAdapter to let the receiver do things to initialize itself before the startListening method is called.

Specified by:

configure in interface IConfigurable

Overrides:

configure in class TransactionAttributes

Throws:

ConfigurationException - when initialization did not succeed.

See Also:

startRunning()

startRunning

public void startRunning()

Description copied from interface: IManagable

Instruct the object that implements IManagable to start working. The method does not wait for completion of the command; at return of this method, the object might be still in the STARTING-runstate

Specified by:

startRunning in interface IManagable

stopRunning

public void stopRunning()

Description copied from interface: IManagable

Instruct the object that implements IManagable to stop working. The method does not wait for completion of the command; at return of this method, the object might be still in the STOPPING-runstate

Specified by:

stopRunning in interface IManagable

knownProcessStates

public Set<ProcessState> knownProcessStates()

Description copied from interface: IHasProcessState

Provides the set of ProcessStates used by this listener.

Specified by:

knownProcessStates in interface IHasProcessState<Object>

targetProcessStates

public Map<ProcessState,Set<ProcessState>> targetProcessStates()

Description copied from interface: IHasProcessState

Provides the set of ProcessStates that a message in the specified state can be moved to, e.g. from a MessageBrowser for that state.

Specified by:

targetProcessStates in interface IHasProcessState<Object>

changeProcessState

public M changeProcessState(Object message,
                            ProcessState toState,
                            String reason)
                     throws ListenerException

Description copied from interface: IHasProcessState

Change the processState of the message to the specified state, if that state is supported. If it is not supported, nothing changes, and false is returned.

Specified by:

changeProcessState in interface IHasProcessState<Object>

Returns:

the moved message, or null if no message was moved.

Throws:

ListenerException

getMessageBrowser

public IMessageBrowser<Object> getMessageBrowser(ProcessState state)

Description copied from interface: IProvidesMessageBrowsers

returns a browser of messages that are in ProcessState 'state', and are stored in a storage managed by the listener itself (as opposed to a storage configured as a messageLog or errorStorage in the configuration).

Specified by:

getMessageBrowser in interface IProvidesMessageBrowsers<Object>

startProcessingMessage

protected void startProcessingMessage(long waitingDuration)

finishProcessingMessage

protected void finishProcessingMessage(long processingDuration)

moveInProcessToError

public void moveInProcessToError(String originalMessageId,
                                 String correlationId,
                                 ThrowingSupplier<Message,ListenerException> messageSupplier,
                                 Date receivedDate,
                                 String comments,
                                 Object rawMessage,
                                 org.springframework.transaction.TransactionDefinition txDef)

processRequest

public Message processRequest(IListener<M> origin,
                              String correlationId,
                              M rawMessage,
                              Message message,
                              PipeLineSession session)
                       throws ListenerException

Process the received message with processRequest(IListener, String, Object, Message, PipeLineSession). A messageId is generated that is unique and consists of the name of this listener and a GUID

Specified by:

processRequest in interface IMessageHandler<M>

Throws:

ListenerException

processRawMessage

public void processRawMessage(IListener<M> origin,
                              M rawMessage)
                       throws ListenerException

Description copied from interface: IMessageHandler

Same as IMessageHandler.processRawMessage(IListener,Object,PipeLineSession, boolean), but now without context, for convenience

Specified by:

processRawMessage in interface IMessageHandler<M>

Throws:

ListenerException

processRawMessage

public void processRawMessage(IListener<M> origin,
                              M rawMessage,
                              PipeLineSession session,
                              boolean duplicatesAlreadyChecked)
                       throws ListenerException

Description copied from interface: IMessageHandler

Will use listener to perform getIdFromRawMessage(), getStringFromRawMessage and afterMessageProcessed

Specified by:

processRawMessage in interface IMessageHandler<M>

Throws:

ListenerException

processRawMessage

public void processRawMessage(IListener<M> origin,
                              M rawMessage,
                              PipeLineSession session,
                              long waitingDuration,
                              boolean duplicatesAlreadyChecked)
                       throws ListenerException

Description copied from interface: IMessageHandler

Same as IMessageHandler.processRawMessage(IListener,Object,PipeLineSession, boolean), but now updates IdleStatistics too

Specified by:

processRawMessage in interface IMessageHandler<M>

Throws:

ListenerException

retryMessage

public void retryMessage(String storageKey)
                  throws ListenerException

Throws:

ListenerException

cacheProcessResult

public void cacheProcessResult(String messageId,
                               String errorMessage,
                               Date receivedDate)

getCachedErrorMessage

public String getCachedErrorMessage(String messageId)

getDeliveryCount

public int getDeliveryCount(String messageId,
                            M rawMessage)

hasProblematicHistory

public boolean hasProblematicHistory(String messageId,
                                     boolean manualRetry,
                                     Object rawMessageOrWrapper,
                                     ThrowingSupplier<Message,ListenerException> messageSupplier,
                                     Map<String,Object> threadContext,
                                     String correlationId)
                              throws ListenerException

Throws:

ListenerException

exceptionThrown

public void exceptionThrown(INamedObject object,
                            Throwable t)

Description copied from interface: IbisExceptionListener

Inform the implementing class that the exception t occurred in object.

Specified by:

exceptionThrown in interface IbisExceptionListener

exceptionThrown

public void exceptionThrown(String errorMessage,
                            Throwable t)

getEventSourceName

public String getEventSourceName()

Specified by:

getEventSourceName in interface EventThrowing

registerEvent

protected void registerEvent(String eventCode)

throwEvent

protected void throwEvent(String eventCode)

resetRetryInterval

public void resetRetryInterval()

increaseRetryIntervalAndWait

public void increaseRetryIntervalAndWait(Throwable t,
                                         String description)

iterateOverStatistics

public void iterateOverStatistics(StatisticsKeeperIterationHandler hski,
                                  Object data,
                                  HasStatistics.Action action)
                           throws SenderException

Specified by:

iterateOverStatistics in interface HasStatistics

Throws:

SenderException

isThreadCountReadable

public boolean isThreadCountReadable()

Specified by:

isThreadCountReadable in interface IThreadCountControllable

isThreadCountControllable

public boolean isThreadCountControllable()

Specified by:

isThreadCountControllable in interface IThreadCountControllable

getCurrentThreadCount

public int getCurrentThreadCount()

Specified by:

getCurrentThreadCount in interface IThreadCountControllable

getMaxThreadCount

public int getMaxThreadCount()

Specified by:

getMaxThreadCount in interface IThreadCountControllable

increaseThreadCount

public void increaseThreadCount()

Specified by:

increaseThreadCount in interface IThreadCountControllable

decreaseThreadCount

public void decreaseThreadCount()

Specified by:

decreaseThreadCount in interface IThreadCountControllable

setRunState

@Protected
public void setRunState(RunState state)

Changes runstate. Always stops the receiver when state is `**ERROR**`

getRunState

public RunState getRunState()

Get the runstate of this receiver.

Specified by:

getRunState in interface IManagable

isInRunState

public boolean isInRunState(RunState someRunState)

formatException

public Message formatException(String extrainfo,
                               String correlationId,
                               Message message,
                               Throwable t)

Description copied from interface: IMessageHandler

Formats any exception thrown by any of the above methods to a message that can be returned. Can be used if the calling system has no other way of returning the exception to the caller.

Specified by:

formatException in interface IMessageHandler<M>

getBeanFactory

public org.springframework.beans.factory.BeanFactory getBeanFactory()

setBeanFactory

public void setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory)

Specified by:

setBeanFactory in interface org.springframework.beans.factory.BeanFactoryAware

getListenerContainer

public PullingListenerContainer<M> getListenerContainer()

setListenerContainer

public void setListenerContainer(PullingListenerContainer<M> listenerContainer)

createListenerContainer

public PullingListenerContainer<M> createListenerContainer()

getProcessStatistics

protected StatisticsKeeper getProcessStatistics(int threadsProcessing)

getIdleStatistics

protected StatisticsKeeper getIdleStatistics(int threadsProcessing)

getProcessStatistics

public Iterable<StatisticsKeeper> getProcessStatistics()

Returns an iterator over the process-statistics

Specified by:

getProcessStatistics in interface IReceiverStatistics

Returns:

iterator

getIdleStatistics

public Iterable<StatisticsKeeper> getIdleStatistics()

Returns an iterator over the idle-statistics

Specified by:

getIdleStatistics in interface IReceiverStatistics

Returns:

iterator

getQueueingStatistics

public Iterable<StatisticsKeeper> getQueueingStatistics()

isOnErrorContinue

public boolean isOnErrorContinue()

getMessagesReceived

public long getMessagesReceived()

get the number of messages received by this receiver.

getMessagesRetried

public long getMessagesRetried()

get the number of duplicate messages received this receiver.

getMessagesRejected

public long getMessagesRejected()

Get the number of messages rejected (discarded or put in errorStorage).

getLastMessageDate

public long getLastMessageDate()

resetNumberOfExceptionsCaughtWithoutMessageBeingReceived

public void resetNumberOfExceptionsCaughtWithoutMessageBeingReceived()

toString

public String toString()

Returns a toString of this class by introspection and the toString() value of its listener.

Overrides:

toString in class Object

Returns:

Description of the Return Value

setListener

public void setListener(IListener<M> newListener)

Sets the listener used to receive messages from.

setSender

public void setSender(ISender sender)

Sender to which the response (output of PipeLine) should be sent. Applies if the receiver has an asynchronous listener. N.B. Sending correlated responses via this sender is not supported.

setInProcessStorage

@Deprecated
 @ConfigurationWarning(value="In-Process Storage no longer exists")
public void setInProcessStorage(ITransactionalStorage<Serializable> inProcessStorage)

Deprecated.

Sets the inProcessStorage.

Parameters:

inProcessStorage - The inProcessStorage to set

setErrorSender

public void setErrorSender(ISender errorSender)

Sender that will send the result in case the PipeLineExit state was not SUCCESS. Applies if the receiver has an asynchronous listener.

setErrorStorage

@IbisDoc(value="Storage to keep track of messages that failed processing")
public void setErrorStorage(ITransactionalStorage<Serializable> errorStorage)

setMessageLog

@IbisDoc(value="Storage to keep track of all messages processed correctly")
public void setMessageLog(ITransactionalStorage<Serializable> messageLog)

setName

@IbisDoc(value={"Name of the Receiver as known to the Adapter",""})
public void setName(String newName)

Sets the name of the Receiver. If the listener implements the name interface and getName() of the listener is empty, the name of this object is given to the listener.

Specified by:

setName in interface INamedObject

setOnError

@IbisDoc(value={"One of \'continue\' or \'close\'. Controls the behaviour of the Receiver when it encounters an error sending a reply or receives an exception asynchronously","CONTINUE"})
public void setOnError(Receiver.OnError value)

setNumThreads

@IbisDoc(value={"The number of threads that may execute a Pipeline concurrently (only for pulling listeners)","1"})
public void setNumThreads(int newNumThreads)

The number of threads that this receiver is configured to work with.

setNumThreadsPolling

@IbisDoc(value={"The number of threads that are actively polling for messages concurrently. \'0\' means \'limited only by <code>numthreads</code>\' (only for pulling listeners)","1"})
public void setNumThreadsPolling(int i)

setPollInterval

@IbisDoc(value={"The number of seconds waited after an unsuccesful poll attempt before another poll attempt is made. Only for polling listeners, not for e.g. ifsa, jms, webservice or javaListeners","10"})
public void setPollInterval(int i)

setStartTimeout

public void setStartTimeout(int i)

timeout to start receiver. If this timeout is reached, the Receiver may be stopped again

setStopTimeout

public void setStopTimeout(int i)

timeout to stopped receiver. If this timeout is reached, a new stop command may be issued

setCheckForDuplicates

@IbisDoc(value={"If set to <code>true</code>, each message is checked for presence in the messageLog. If already present, it is not processed again. Only required for non XA compatible messaging. Requires messageLog!","false"})
public void setCheckForDuplicates(boolean b)

setCheckForDuplicatesMethod

@IbisDoc(value={"(Only used when <code>checkForDuplicates=true</code>) Indicates whether the messageid or the correlationid is used for checking presence in the message log","MESSAGEID"})
public void setCheckForDuplicatesMethod(Receiver.CheckForDuplicatesMethod method)

setMaxDeliveries

@IbisDoc(value={"The maximum delivery count after which to stop processing the message (only for listeners that know the delivery count of received messages). If -1 the delivery count is ignored","5"})
public void setMaxDeliveries(int i)

setMaxRetries

@IbisDoc(value={"The number of times a processing attempt is automatically retried after an exception is caught or rollback is experienced. If <code>maxRetries &lt; 0</code> the number of attempts is infinite","1"})
public void setMaxRetries(int i)

setProcessResultCacheSize

@IbisDoc(value={"Size of the cache to keep process results, used by maxRetries","100"})
public void setProcessResultCacheSize(int processResultCacheSize)

setReturnedSessionKeys

@IbisDoc(value={"Comma separated list of keys of session variables that should be returned to caller, for correct results as well as for erronous results. (Only for Listeners that support it, like JavaListener)",""})
public void setReturnedSessionKeys(String string)

setCorrelationIDXPath

@IbisDoc(value={"XPath expression to extract correlationid from message",""})
public void setCorrelationIDXPath(String string)

setCorrelationIDNamespaceDefs

@IbisDoc(value={"Namespace defintions for correlationIDXPath. Must be in the form of a comma or space separated list of <code>prefix=namespaceuri</code>-definitions",""})
public void setCorrelationIDNamespaceDefs(String correlationIDNamespaceDefs)

setCorrelationIDStyleSheet

@IbisDoc(value={"Stylesheet to extract correlationID from message",""})
public void setCorrelationIDStyleSheet(String string)

setLabelXPath

@IbisDoc(value={"XPath expression to extract label from message",""})
public void setLabelXPath(String string)

setLabelNamespaceDefs

@IbisDoc(value={"Namespace defintions for labelXPath. Must be in the form of a comma or space separated list of <code>prefix=namespaceuri</code>-definitions",""})
public void setLabelNamespaceDefs(String labelNamespaceDefs)

setLabelStyleSheet

@IbisDoc(value={"Stylesheet to extract label from message",""})
public void setLabelStyleSheet(String string)

setChompCharSize

@IbisDoc(value={"If set (>=0) and the character data length inside a xml element exceeds this size, the character data is chomped (with a clear comment)",""})
public void setChompCharSize(String string)

setElementToMove

@IbisDoc(value={"If set, the character data in this element is stored under a session key and in the message replaced by a reference to this session key: {sessionkey: + <code>elementToMoveSessionKey</code> + }",""})
public void setElementToMove(String string)

setElementToMoveSessionKey

@IbisDoc(value={"(Only used when <code>elementToMove</code> is set) Name of the session key under which the character data is stored","ref_ + the name of the element"})
public void setElementToMoveSessionKey(String string)

setElementToMoveChain

@IbisDoc(value={"Like <code>elementToMove</code> but element is preceded with all ancestor elements and separated by semicolons (e.g. adapter;pipeline;pipe)",""})
public void setElementToMoveChain(String string)

setRemoveCompactMsgNamespaces

public void setRemoveCompactMsgNamespaces(boolean b)

setHideRegex

@IbisDoc(value={"Regular expression to mask strings in the errorStore/logStore. Every character between to the strings in this expression will be replaced by a \'*\'. For example, the regular expression (?<=<party>).*?(?=</party>) will replace every character between keys <party> and </party>",""})
public void setHideRegex(String hideRegex)

setHideMethod

@IbisDoc(value={"Only used when hideRegex is not empty","all"})
public void setHideMethod(IMessageBrowser.HideMethod hideMethod)

setHiddenInputSessionKeys

@IbisDoc(value={"Comma separated list of keys of session variables which are available when the <code>PipelineSession</code> is created and of which the value will not be shown in the log (replaced by asterisks)",""})
public void setHiddenInputSessionKeys(String string)

setForceRetryFlag

@IbisDoc(value={"If set to <code>true</code>, every message read will be processed as if it is being retried, by setting a session variable \'retry\'","false"})
public void setForceRetryFlag(boolean b)

setNumberOfExceptionsCaughtWithoutMessageBeingReceivedThreshold

@IbisDoc(value={"Number of connection attemps to put the adapter in warning status","5"})
public void setNumberOfExceptionsCaughtWithoutMessageBeingReceivedThreshold(int number)