Package org.frankframework.pipes

Class AsyncSenderWithListenerPipe<M>

java.lang.Object

org.frankframework.core.TransactionAttributes

org.frankframework.pipes.AbstractPipe

org.frankframework.pipes.FixedForwardPipe

org.frankframework.pipes.MessageSendingPipe

org.frankframework.pipes.AsyncSenderWithListenerPipe<M>

All Implemented Interfaces:

FrankElement, HasApplicationContext, HasName, HasSender, HasTransactionAttribute, IConfigurable, IForwardTarget, IPipe, IScopeProvider, IWithParameters, NameAware, EventThrowing, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle

@Category(BASIC)
@EnterpriseIntegrationPattern(ENDPOINT)
public class AsyncSenderWithListenerPipe<M>
extends MessageSendingPipe

Sends a message using an asynchronous sender and receives a reply from a listener.

Nested Class Summary

Nested classes/interfaces inherited from class org.frankframework.pipes.MessageSendingPipe

MessageSendingPipe.LinkMethod

Field Summary

Fields inherited from class org.frankframework.pipes.MessageSendingPipe

configurationMetrics, INPUT_VALIDATOR_NAME_PREFIX, INPUT_VALIDATOR_NAME_SUFFIX, INPUT_WRAPPER_NAME_PREFIX, INPUT_WRAPPER_NAME_SUFFIX, MAX_RETRY_INTERVAL, MESSAGE_LOG_NAME_PREFIX, MESSAGE_LOG_NAME_SUFFIX, MIN_RETRY_INTERVAL, msgLog, OUTPUT_VALIDATOR_NAME_PREFIX, OUTPUT_VALIDATOR_NAME_SUFFIX, OUTPUT_WRAPPER_NAME_PREFIX, OUTPUT_WRAPPER_NAME_SUFFIX, PIPE_CLEAR_TIMEOUT_MONITOR_EVENT, PIPE_EXCEPTION_MONITOR_EVENT, PIPE_TIMEOUT_MONITOR_EVENT

Fields inherited from class org.frankframework.pipes.AbstractPipe

parameterNamesMustBeUnique

Fields inherited from class org.frankframework.core.TransactionAttributes

log

Fields inherited from interface org.frankframework.core.IPipe

LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT

Constructor Summary

Constructors

Constructor	Description
AsyncSenderWithListenerPipe()

Method Summary

Modifier and Type	Method	Description
void	configure()	Checks for correct configuration of forward.
protected String	doLogToMessageLog(Message input, PipeLineSession session, Message originalMessage, String messageID, String correlationID)
protected PipeRunResult	postSendAction(PipeRunResult sendResult, String correlationID, PipeLineSession session)
protected void	propagateName()
void	setAuditTrailNamespaceDefs(String auditTrailNamespaceDefs)	Namespace definitions for auditTrailXPath.
void	setAuditTrailSessionKey(String string)	Key of a pipeline session variable.
void	setAuditTrailXPath(String string)	XPath expression to extract the audit trail from the message.
void	setCorrelationIDNamespaceDefs(String correlationIDNamespaceDefs)	Namespace definitions for correlationIDXPath.
void	setCorrelationIDSessionKey(String string)	Key of a pipeline session variable.
void	setCorrelationIDStyleSheet(String string)	Stylesheet to extract correlationid from message
void	setCorrelationIDXPath(String string)	XPath expression to extract correlationid from message
void	setInputValidator(IValidator inputValidator)	specification of Pipe to validate request messages, or request and response message if configured as mixed mode validator
void	setInputWrapper(IWrapperPipe inputWrapper)	specification of Pipe to wrap or unwrap request messages
void	setLabelNamespaceDefs(String labelXNamespaceDefs)	Namespace definitions for labelXPath.
void	setLabelStyleSheet(String string)	Stylesheet to extract a label from a message.
void	setLabelXPath(String string)	XPath expression to extract the label from the message.
void	setListener(ICorrelatedPullingListener<M> listener)	Listener for responses on the request sent.
void	setMessageLog(ITransactionalStorage<?> messageLog)	log of all messages sent
void	setSender(ISender sender)	The sender that should send the message
void	setUseInputForExtract(boolean b)	If true, the input of the Pipe is used to extract the audit trail, correlation ID, and label (instead of the wrapped input).
void	start()	Perform necessary action to start the pipe.
void	stop()	Perform necessary actions to stop the Pipe. For instance, closing JMS connections, DBMS connections etc.

Methods inherited from class org.frankframework.pipes.MessageSendingPipe

consumesSessionVariable, doPipe, increaseRetryIntervalAndWait, preserve, sendMessage, sendMessageWithRetries, setCheckRootTag, setCheckXmlWellFormed, setExceptionOnResult, setHideMethod, setHideRegex, setLinkMethod, setMaxRetries, setName, setOutputValidator, setOutputWrapper, setPresumedTimeOutInterval, setResultOnTimeOut, setRetryMaxInterval, setRetryMinInterval, setRetryNamespaceDefs, setRetryXPath, setStubFilename, setTimeoutOnResult, setTimeOutOnResult, sizeStatisticsEnabled, storeMessage

Methods inherited from class org.frankframework.pipes.FixedForwardPipe

getParameterValue, setIfParam, setIfValue, setOnlyIfSessionKey, setOnlyIfValue, setSkipOnEmptyInput, setUnlessSessionKey, setUnlessValue, skipPipe

Methods inherited from class org.frankframework.pipes.AbstractPipe

addForward, addParameter, createBean, findForward, getAdapter, getEventSourceName, getForwards, getParameterList, hasRegisteredForward, isRunning, registerEvent, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setLocker, setLogIntermediaryResults, setMaxThreads, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, throwEvent

Methods inherited from class org.frankframework.core.TransactionAttributes

configureTransactionAttributes, isTransacted, isTransacted, setTransacted, setTransactionTimeout

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.frankframework.core.HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface org.frankframework.core.HasName

getName

Methods inherited from interface org.frankframework.core.HasSender

getSender

Methods inherited from interface org.frankframework.core.HasTransactionAttribute

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Methods inherited from interface org.frankframework.core.IForwardTarget

getName

Methods inherited from interface org.frankframework.core.IPipe

getChompCharSize, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getGetInputFromFixedValue, getGetInputFromSessionKey, getHideRegex, getLocker, getLogIntermediaryResults, getMaxThreads, getSecLogSessionKeys, getStoreResultInSessionKey, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, setPipeLine, throwEvent

Constructor Details

AsyncSenderWithListenerPipe

public AsyncSenderWithListenerPipe()

Method Details

configure

public void configure()
               throws ConfigurationException

Description copied from class: FixedForwardPipe

Checks for correct configuration of forward.

Specified by:

configure in interface IConfigurable

Overrides:

configure in class MessageSendingPipe

Throws:

ConfigurationException - in case it was not able to configure the component.

propagateName

protected void propagateName()

Overrides:

propagateName in class MessageSendingPipe

doLogToMessageLog

protected String doLogToMessageLog(Message input,
 PipeLineSession session,
 Message originalMessage,
 String messageID,
 String correlationID)
                            throws SenderException

Overrides:

doLogToMessageLog in class MessageSendingPipe

Throws:

SenderException

postSendAction

protected PipeRunResult postSendAction(PipeRunResult sendResult,
 String correlationID,
 PipeLineSession session)
                                throws ListenerException,
TimeoutException

Overrides:

postSendAction in class MessageSendingPipe

Throws:

ListenerException

TimeoutException

start

public void start()

Description copied from interface: IPipe

Perform necessary action to start the pipe. This method is executed after the IConfigurable.configure() method, for each start and stop command of the adapter.

Specified by:

start in interface IPipe

Specified by:

start in interface org.springframework.context.Lifecycle

Overrides:

start in class MessageSendingPipe

stop

public void stop()

Description copied from interface: IPipe

Perform necessary actions to stop the Pipe.
For instance, closing JMS connections, DBMS connections etc.

Specified by:

stop in interface IPipe

Specified by:

stop in interface org.springframework.context.Lifecycle

Overrides:

stop in class MessageSendingPipe

setMessageLog

@Reintroduce
public void setMessageLog(ITransactionalStorage<?> messageLog)

Description copied from class: MessageSendingPipe

log of all messages sent

Overrides:

setMessageLog in class MessageSendingPipe

setInputWrapper

@Reintroduce
public void setInputWrapper(IWrapperPipe inputWrapper)

Description copied from class: MessageSendingPipe

specification of Pipe to wrap or unwrap request messages

Overrides:

setInputWrapper in class MessageSendingPipe

setInputValidator

@Reintroduce
public void setInputValidator(IValidator inputValidator)

Description copied from class: MessageSendingPipe

specification of Pipe to validate request messages, or request and response message if configured as mixed mode validator

Overrides:

setInputValidator in class MessageSendingPipe

setSender

@Reintroduce
public void setSender(ISender sender)

Description copied from class: MessageSendingPipe

The sender that should send the message

Overrides:

setSender in class MessageSendingPipe

setListener

@Mandatory
public void setListener(ICorrelatedPullingListener<M> listener)

Listener for responses on the request sent.

setCorrelationIDStyleSheet

public void setCorrelationIDStyleSheet(String string)

Stylesheet to extract correlationid from message

setCorrelationIDXPath

public void setCorrelationIDXPath(String string)

XPath expression to extract correlationid from message

setCorrelationIDNamespaceDefs

public void setCorrelationIDNamespaceDefs(String correlationIDNamespaceDefs)

Namespace definitions for correlationIDXPath. Must be in the form of a comma or space separated list of prefix=namespaceUri definitions.

setCorrelationIDSessionKey

public void setCorrelationIDSessionKey(String string)

Key of a pipeline session variable. If specified, the value of the PipelineSession variable is used as input for the XPathExpression or stylesheet, instead of the current input message.

setLabelStyleSheet

public void setLabelStyleSheet(String string)

Stylesheet to extract a label from a message.

setLabelXPath

public void setLabelXPath(String string)

XPath expression to extract the label from the message.

setLabelNamespaceDefs

public void setLabelNamespaceDefs(String labelXNamespaceDefs)

Namespace definitions for labelXPath. Must be in the form of a comma or space-separated list of prefix=namespaceUri definitions.

setAuditTrailXPath

public void setAuditTrailXPath(String string)

XPath expression to extract the audit trail from the message.

setAuditTrailNamespaceDefs

public void setAuditTrailNamespaceDefs(String auditTrailNamespaceDefs)

Namespace definitions for auditTrailXPath. Must be in the form of a comma or space-separated list of prefix=namespaceUri definitions.

setAuditTrailSessionKey

public void setAuditTrailSessionKey(String string)

Key of a pipeline session variable. If specified, the value of the PipelineSession variable is used as an audit trail (instead of the default 'no audit trail').

setUseInputForExtract

public void setUseInputForExtract(boolean b)

If true, the input of the Pipe is used to extract the audit trail, correlation ID, and label (instead of the wrapped input).

Default value

true