MessageSendingPipe (Ibis AdapterFramework parent 7.9-SNAPSHOT API)

java.lang.Object
- nl.nn.adapterframework.core.TransactionAttributes
- - nl.nn.adapterframework.pipes.AbstractPipe
  - - nl.nn.adapterframework.pipes.FixedForwardPipe
    - - nl.nn.adapterframework.stream.StreamingPipe
      - nl.nn.adapterframework.pipes.MessageSendingPipe

All Implemented Interfaces:

HasSender, HasTransactionAttribute, IConfigurable, IConfigurationAware, IExtendedPipe, IForwardTarget, INamedObject, IPipe, IScopeProvider, EventThrowing, HasStatistics, IOutputStreamingSupport, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

IteratingPipe, MailSenderPipe, SenderPipe
```
@SupportsOutputStreaming
public class MessageSendingPipe
extends StreamingPipe
implements HasSender, HasStatistics
```
Sends a message using a sender and optionally receives a reply from the same sender, or from a listener.

Author:

Gerrit van Brakel

Parameters

any parameters defined on the pipe will be handed to the sender, if this is a ISenderWithParameters

Specific parameters

stubFilename will not be handed to the sender and it is used at runtime instead of the stubFilename specified by the attribute. A lookup of the file for this stubFilename will be done at runtime, while the file for the stubFilename specified as an attribute will be done at configuration time.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MessageSendingPipe.LinkMethod
- Nested classes/interfaces inherited from interface nl.nn.adapterframework.statistics.HasStatistics
  HasStatistics.Action

Nested Classes
Modifier and Type	Class and Description
`static class`	`MessageSendingPipe.LinkMethod`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`INPUT_VALIDATOR_NAME_PREFIX`
`static String`	`INPUT_VALIDATOR_NAME_SUFFIX`
`static String`	`INPUT_WRAPPER_NAME_PREFIX`
`static String`	`INPUT_WRAPPER_NAME_SUFFIX`
`static int`	`MAX_RETRY_INTERVAL`
`static String`	`MESSAGE_LOG_NAME_PREFIX`
`static String`	`MESSAGE_LOG_NAME_SUFFIX`
`static int`	`MIN_RETRY_INTERVAL`
`protected org.apache.logging.log4j.Logger`	`msgLog`
`static String`	`OUTPUT_VALIDATOR_NAME_PREFIX`
`static String`	`OUTPUT_VALIDATOR_NAME_SUFFIX`
`static String`	`OUTPUT_WRAPPER_NAME_PREFIX`
`static String`	`OUTPUT_WRAPPER_NAME_SUFFIX`
`static String`	`PIPE_CLEAR_TIMEOUT_MONITOR_EVENT`
`static String`	`PIPE_EXCEPTION_MONITOR_EVENT`
`static String`	`PIPE_TIMEOUT_MONITOR_EVENT`

Fields inherited from class nl.nn.adapterframework.stream.StreamingPipe
AUTOMATIC_STREAMING

Fields inherited from class nl.nn.adapterframework.pipes.AbstractPipe
parameterNamesMustBeUnique

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

Fields inherited from interface nl.nn.adapterframework.core.IExtendedPipe
LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT

Constructor Summary

Constructors
Constructor and Description

MessageSendingPipe()

Constructors
Constructor and Description
`MessageSendingPipe()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected boolean`	`canProvideOutputStream()` returns true when: a) the pipe might be able to accept an input by providing an OutputStream, and b) there are no side effects configured that prevent handing over its PipeRunResult to the calling pipe (e.g.
`protected boolean`	`canStreamToNextPipe()` called if the pipe implementation requests an OutputStream, to determine if there are side effects configured that require the output of this pipe to be available at the return of the doPipe() method.
`void`	`configure()` checks for correct configuration of forward
`boolean`	`consumesSessionVariable(String sessionKey)` returns `true` if the pipe or one of its children use the named session variable.
`PipeRunResult`	`doPipe(Message input, PipeLineSession session)` This is where the action takes place.
`boolean`	`hasSizeStatistics()`
`int`	`increaseRetryIntervalAndWait(PipeLineSession session, int retryInterval, String description)`
`void`	`iterateOverStatistics(StatisticsKeeperIterationHandler hski, Object data, HasStatistics.Action action)`
`protected void`	`preserve(Message input)` Call `Message.preserve()` so it can be consumed multiple times, and wrap potential `IOException` in a `PipeRunException`.
`protected void`	`propagateName()`
`protected MessageOutputStream`	`provideOutputStream(PipeLineSession session)` provide the outputstream, or null if a stream cannot be provided.
`protected PipeRunResult`	`sendMessage(Message input, PipeLineSession session, ISender sender, Map<String,Object> threadContext)`
`void`	`setAuditTrailNamespaceDefs(String auditTrailNamespaceDefs)` Namespace defintions for auditTrailXPath.
`void`	`setAuditTrailSessionKey(String string)` Key of a PipelineSession-variable.
`void`	`setAuditTrailXPath(String string)` XPath expression to extract audit trail from message
`void`	`setCheckRootTag(String s)` If set, besides the XML Well-Formedness the root element of the result is checked to be equal to the value set
`void`	`setCheckXmlWellFormed(boolean b)` If set `true`, the XML Well-Formedness of the result is checked
`void`	`setCorrelationIDNamespaceDefs(String correlationIDNamespaceDefs)` Namespace defintions for correlationIDXPath.
`void`	`setCorrelationIDSessionKey(String string)` Key of a PipelineSession-variable.
`void`	`setCorrelationIDStyleSheet(String string)` Stylesheet to extract correlationid from message
`void`	`setCorrelationIDXPath(String string)` XPath expression to extract correlationid from message
`void`	`setExceptionOnResult(String string)` If not empty, a PipeRunException is thrown when the result equals this value (for testing purposes only)
`void`	`setHideMethod(IMessageBrowser.HideMethod hideMethod)` (Only used when hideRegex is not empty and only applies to error/logstore)
`void`	`setHideRegex(String hideRegex)` Regular expression to mask strings in the log.
`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 defintions for labelXPath.
`void`	`setLabelStyleSheet(String string)` Stylesheet to extract label from message
`void`	`setLabelXPath(String string)` XPath expression to extract label from message
`void`	`setLinkMethod(MessageSendingPipe.LinkMethod method)` For asynchronous communication, the server side may either use the messageID or the correlationID in the correlationID field of the reply message.
`protected void`	`setListener(ICorrelatedPullingListener listener)` Listener for responses on the request sent
`void`	`setMaxRetries(int i)` The number of times a processing attempt is retried after a timeout or an exception is caught or after an incorrect reply is received (see also `retryXPath`)
`void`	`setMessageLog(ITransactionalStorage messageLog)` log of all messages sent
`void`	`setName(String name)` The functional name of this pipe.
`void`	`setOutputValidator(IValidator outputValidator)` specification of Pipe to validate response messages
`void`	`setOutputWrapper(IWrapperPipe outputWrapper)` specification of Pipe to wrap or unwrap response messages
`void`	`setPresumedTimeOutInterval(int i)` If the previous call was a timeout, the maximum time in seconds after this timeout to presume the current call is also a timeout.
`void`	`setResultOnTimeOut(String newResultOnTimeOut)` The message (e.g.
`void`	`setRetryMaxInterval(int i)` The maximum number of seconds waited after an unsuccessful processing attempt before another processing attempt is made
`void`	`setRetryMinInterval(int i)` The starting number of seconds waited after an unsuccessful processing attempt before another processing attempt is made.
`void`	`setRetryNamespaceDefs(String retryNamespaceDefs)` Namespace defintions for retryXPath.
`void`	`setRetryXPath(String string)` XPath expression evaluated on each technical successful reply.
`protected void`	`setSender(ISender sender)` The sender that should send the message
`void`	`setStreamResultToServlet(boolean b)` Deprecated.
`void`	`setStubFilename(String filename)` If set, the pipe returns a message from a file, instead of doing the regular process
`void`	`setStubFileName(String fileName)` Deprecated.
`void`	`setTimeOutOnResult(String string)` If not empty, a TimeoutException is thrown when the result equals this value (for testing purposes only)
`void`	`setUseInputForExtract(boolean b)` If set `true`, the input of the Pipe is used to extract audit trail, correlationid 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.
`boolean`	`supportsOutputStreamPassThrough()` Implementations should return `true` when they do not require an OutputStream, but can provide one to the preceding pipe if they are themselves provided with one from the next pipe.

Methods inherited from class nl.nn.adapterframework.stream.StreamingPipe
getNextPipe, getTargetStream, isStreamingActive, provideOutputStream, setStreamingActive

Methods inherited from class nl.nn.adapterframework.pipes.FixedForwardPipe
getParameterValue, setIfParam, setIfValue, setOnlyIfSessionKey, setOnlyIfValue, setSkipOnEmptyInput, setUnlessSessionKey, setUnlessValue, skipPipe

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, toString, wait, wait, wait

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

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

Methods inherited from interface nl.nn.adapterframework.core.IExtendedPipe
getChompCharSize, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getGetInputFromFixedValue, getGetInputFromSessionKey, getLocker, getSecLogSessionKeys, getStoreResultInSessionKey, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, setPipeLine, throwEvent

Methods inherited from interface nl.nn.adapterframework.core.IPipe
getMaxThreads

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 nl.nn.adapterframework.core.IForwardTarget
getName

Methods inherited from interface nl.nn.adapterframework.core.HasTransactionAttribute
getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

- Field Detail
  - msgLog
```
protected org.apache.logging.log4j.Logger msgLog
```
  - PIPE_TIMEOUT_MONITOR_EVENT
```
public static final String PIPE_TIMEOUT_MONITOR_EVENT
```
    See Also:
    
    Constant Field Values
  - PIPE_CLEAR_TIMEOUT_MONITOR_EVENT
```
public static final String PIPE_CLEAR_TIMEOUT_MONITOR_EVENT
```
    See Also:
    
    Constant Field Values
  - PIPE_EXCEPTION_MONITOR_EVENT
```
public static final String PIPE_EXCEPTION_MONITOR_EVENT
```
    See Also:
    
    Constant Field Values
  - MIN_RETRY_INTERVAL
```
public static final int MIN_RETRY_INTERVAL
```
    See Also:
    
    Constant Field Values
  - MAX_RETRY_INTERVAL
```
public static final int MAX_RETRY_INTERVAL
```
    See Also:
    
    Constant Field Values
  - INPUT_VALIDATOR_NAME_PREFIX
```
public static final String INPUT_VALIDATOR_NAME_PREFIX
```
    See Also:
    
    Constant Field Values
  - INPUT_VALIDATOR_NAME_SUFFIX
```
public static final String INPUT_VALIDATOR_NAME_SUFFIX
```
    See Also:
    
    Constant Field Values
  - OUTPUT_VALIDATOR_NAME_PREFIX
```
public static final String OUTPUT_VALIDATOR_NAME_PREFIX
```
    See Also:
    
    Constant Field Values
  - OUTPUT_VALIDATOR_NAME_SUFFIX
```
public static final String OUTPUT_VALIDATOR_NAME_SUFFIX
```
    See Also:
    
    Constant Field Values
  - INPUT_WRAPPER_NAME_PREFIX
```
public static final String INPUT_WRAPPER_NAME_PREFIX
```
    See Also:
    
    Constant Field Values
  - INPUT_WRAPPER_NAME_SUFFIX
```
public static final String INPUT_WRAPPER_NAME_SUFFIX
```
    See Also:
    
    Constant Field Values
  - OUTPUT_WRAPPER_NAME_PREFIX
```
public static final String OUTPUT_WRAPPER_NAME_PREFIX
```
    See Also:
    
    Constant Field Values
  - OUTPUT_WRAPPER_NAME_SUFFIX
```
public static final String OUTPUT_WRAPPER_NAME_SUFFIX
```
    See Also:
    
    Constant Field Values
  - MESSAGE_LOG_NAME_PREFIX
```
public static final String MESSAGE_LOG_NAME_PREFIX
```
    See Also:
    
    Constant Field Values
  - MESSAGE_LOG_NAME_SUFFIX
```
public static final String MESSAGE_LOG_NAME_SUFFIX
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MessageSendingPipe
```
public MessageSendingPipe()
```
- Method Detail
  - configure
```
public void configure()
               throws ConfigurationException
```
    Description copied from class: FixedForwardPipe
    
    checks for correct configuration of forward
    
    Specified by:
    
    configure in interface IConfigurable
    
    Specified by:
    
    configure in interface IPipe
    
    Overrides:
    
    configure in class StreamingPipe
    
    Throws:
    
    ConfigurationException
  - propagateName
```
protected void propagateName()
```
  - setName
```
public void setName(String name)
```
    Description copied from class: AbstractPipe
    
    The functional name of this pipe. Can be referenced by the path attribute of a PipeForward.
    
    Specified by:
    
    setName in interface INamedObject
    
    Overrides:
    
    setName in class AbstractPipe
  - supportsOutputStreamPassThrough
```
public boolean supportsOutputStreamPassThrough()
```
    Description copied from interface: IOutputStreamingSupport
    
    Implementations should return true when they do not require an OutputStream, but can provide one to the preceding pipe if they are themselves provided with one from the next pipe.
    
    Specified by:
    
    supportsOutputStreamPassThrough in interface IOutputStreamingSupport
    
    Overrides:
    
    supportsOutputStreamPassThrough in class StreamingPipe
  - canProvideOutputStream
```
protected boolean canProvideOutputStream()
```
    Description copied from class: StreamingPipe
    
    returns true when: a) the pipe might be able to accept an input by providing an OutputStream, and b) there are no side effects configured that prevent handing over its PipeRunResult to the calling pipe (e.g. storeResultInSessionKey) c) there are no side effects that require the input to be available at the end of the pipe (e.g. preserveInput=true) d) there are no parameters that require the input value or context (b and c are implemented by PipeProcessors, that do not support outputStreaming)
    
    Overrides:
    
    canProvideOutputStream in class StreamingPipe
  - canStreamToNextPipe
```
protected boolean canStreamToNextPipe()
```
    Description copied from class: StreamingPipe
    
    called if the pipe implementation requests an OutputStream, to determine if there are side effects configured that require the output of this pipe to be available at the return of the doPipe() method. All side effects that are handled by PipeProcessors (storeResultInSessionKey, preserveInput) and move and chop actions (restoreMovedElements, elementToMove, chompCharSize, ElementToMoveChain) inhibit streaming to the next pipe.
    
    Overrides:
    
    canStreamToNextPipe in class StreamingPipe
  - provideOutputStream
```
protected MessageOutputStream provideOutputStream(PipeLineSession session)
                                           throws StreamingException
```
    Description copied from class: StreamingPipe
    
    provide the outputstream, or null if a stream cannot be provided. Implementations should provide a forward target by calling StreamingPipe.getNextPipe().
    
    Overrides:
    
    provideOutputStream in class StreamingPipe
    
    Throws:
    
    StreamingException
  - preserve
```
protected void preserve(@Nonnull
                        Message input)
                 throws PipeRunException
```
    Call Message.preserve() so it can be consumed multiple times, and wrap potential IOException in a PipeRunException.
    
    Parameters:
    
    input - The Message to be preserved.
    
    Throws:
    
    PipeRunException - If an IOException is thrown from Message.preserve(), wrap and rethrow it in a PipeRunException.
  - doPipe
```
public PipeRunResult doPipe(@Nonnull
                            Message input,
                            @Nonnull
                            PipeLineSession session)
                     throws PipeRunException
```
    Description copied from interface: IPipe
    
    This is where the action takes place. Pipes may only throw a PipeRunException, to be handled by the caller of this object. Implementations must either consume the message, or pass it on to the next Pipe in the PipeRunResult. If the result of the Pipe does not depend on the input, like for the FixedResultPipe, the Pipe can schedule the input to be closed at session exit, by calling Message.closeOnCloseOf(PipeLineSession, String) This allows the previous Pipe to release any resources (e.g. connections) that it might have kept open until the message was consumed. Doing so avoids connections leaking from pools, while it enables efficient streaming processing of data while it is being read from a stream.
    
    Specified by:
    
    doPipe in interface IPipe
    
    Throws:
    
    PipeRunException
  - sendMessage
```
protected PipeRunResult sendMessage(Message input,
                                    PipeLineSession session,
                                    ISender sender,
                                    Map<String,Object> threadContext)
                             throws SenderException,
                                    TimeoutException,
                                    IOException,
                                    InterruptedException
```
    Throws:
    
    SenderException
    
    TimeoutException
    
    IOException
    
    InterruptedException
  - increaseRetryIntervalAndWait
```
public int increaseRetryIntervalAndWait(PipeLineSession session,
                                        int retryInterval,
                                        String description)
                                 throws InterruptedException
```
    Throws:
    
    InterruptedException
  - start
```
public void start()
           throws PipeStartException
```
    Description copied from interface: IPipe
    
    Perform necessary action to start the pipe. This method is executed after the IPipe.configure() method, for each start and stop command of the adapter.
    
    Specified by:
    
    start in interface IPipe
    
    Overrides:
    
    start in class AbstractPipe
    
    Throws:
    
    PipeStartException
  - 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
    
    Overrides:
    
    stop in class AbstractPipe
  - iterateOverStatistics
```
public void iterateOverStatistics(StatisticsKeeperIterationHandler hski,
                                  Object data,
                                  HasStatistics.Action action)
                           throws SenderException
```
    Specified by:
    
    iterateOverStatistics in interface HasStatistics
    
    Throws:
    
    SenderException
  - hasSizeStatistics
```
public boolean hasSizeStatistics()
```
    Specified by:
    
    hasSizeStatistics in interface IExtendedPipe
    
    Overrides:
    
    hasSizeStatistics in class AbstractPipe
  - consumesSessionVariable
```
public boolean consumesSessionVariable(String sessionKey)
```
    Description copied from interface: IPipe
    
    returns true if the pipe or one of its children use the named session variable. Callers can use this to determine if a message needs to be preserved.
    
    Specified by:
    
    consumesSessionVariable in interface IPipe
    
    Overrides:
    
    consumesSessionVariable in class AbstractPipe
  - setSender
```
protected void setSender(ISender sender)
```
    The sender that should send the message
  - setListener
```
protected void setListener(ICorrelatedPullingListener listener)
```
    Listener for responses on the request sent
  - setMessageLog
```
public void setMessageLog(ITransactionalStorage messageLog)
```
    log of all messages sent
  - setInputValidator
```
public void setInputValidator(IValidator inputValidator)
```
    specification of Pipe to validate request messages, or request and response message if configured as mixed mode validator
  - setOutputValidator
```
public void setOutputValidator(IValidator outputValidator)
```
    specification of Pipe to validate response messages
  - setInputWrapper
```
public void setInputWrapper(IWrapperPipe inputWrapper)
```
    specification of Pipe to wrap or unwrap request messages
  - setOutputWrapper
```
public void setOutputWrapper(IWrapperPipe outputWrapper)
```
    specification of Pipe to wrap or unwrap response messages
  - setLinkMethod
```
public void setLinkMethod(MessageSendingPipe.LinkMethod method)
```
    For asynchronous communication, the server side may either use the messageID or the correlationID in the correlationID field of the reply message. Use this property to set the behaviour of the reply-listener.
    
    Default value
    
    CORRELATIONID
  - 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 defintions 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 PipelineSession-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 label from message
  - setLabelXPath
```
public void setLabelXPath(String string)
```
    XPath expression to extract label from message
  - setLabelNamespaceDefs
```
public void setLabelNamespaceDefs(String labelXNamespaceDefs)
```
    Namespace defintions 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 audit trail from message
  - setAuditTrailNamespaceDefs
```
public void setAuditTrailNamespaceDefs(String auditTrailNamespaceDefs)
```
    Namespace defintions 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 PipelineSession-variable. If specified, the value of the PipelineSession variable is used as audit trail (instead of the default 'no audit trail)
  - setUseInputForExtract
```
public void setUseInputForExtract(boolean b)
```
    If set true, the input of the Pipe is used to extract audit trail, correlationid and label (instead of the wrapped input)
    
    Default value
    
    true
  - setHideRegex
```
public void setHideRegex(String hideRegex)
```
    Description copied from class: AbstractPipe
    
    Regular expression to mask strings in the log. For example, the regular expression (?<=<password>).*?(?=</password>) will replace every character between keys '<password>' and '</password>'. note: this feature is used at adapter level, so one pipe affects all pipes in the pipeline (and multiple values in different pipes are merged)
    
    Overrides:
    
    setHideRegex in class AbstractPipe
  - setHideMethod
```
public void setHideMethod(IMessageBrowser.HideMethod hideMethod)
```
    (Only used when hideRegex is not empty and only applies to error/logstore)
    
    Default value
    
    all
  - setCheckXmlWellFormed
```
public void setCheckXmlWellFormed(boolean b)
```
    If set true, the XML Well-Formedness of the result is checked
    
    Default value
    
    false
  - setCheckRootTag
```
public void setCheckRootTag(String s)
```
    If set, besides the XML Well-Formedness the root element of the result is checked to be equal to the value set
  - setResultOnTimeOut
```
public void setResultOnTimeOut(String newResultOnTimeOut)
```
    The message (e.g. 'receiver timed out') that is returned when the time listening for a reply message exceeds the timeout, or in other situations no reply message is received.
  - setMaxRetries
```
public void setMaxRetries(int i)
```
    The number of times a processing attempt is retried after a timeout or an exception is caught or after an incorrect reply is received (see also retryXPath)
    
    Default value
    
    0
  - setRetryMinInterval
```
public void setRetryMinInterval(int i)
```
    The starting number of seconds waited after an unsuccessful processing attempt before another processing attempt is made. Each next retry this interval is doubled with a upper limit of retryMaxInterval
    
    Default value
    
    1
  - setRetryMaxInterval
```
public void setRetryMaxInterval(int i)
```
    The maximum number of seconds waited after an unsuccessful processing attempt before another processing attempt is made
    
    Default value
    
    600
  - setRetryXPath
```
public void setRetryXPath(String string)
```
    XPath expression evaluated on each technical successful reply. Retry is done if condition returns true
  - setRetryNamespaceDefs
```
public void setRetryNamespaceDefs(String retryNamespaceDefs)
```
    Namespace defintions for retryXPath. Must be in the form of a comma or space separated list of prefix=namespaceUri-definitions
  - setPresumedTimeOutInterval
```
public void setPresumedTimeOutInterval(int i)
```
    If the previous call was a timeout, the maximum time in seconds after this timeout to presume the current call is also a timeout.
    
    Default value
    
    0
  - setStreamResultToServlet
```
@Deprecated
 @ConfigurationWarning(value="Please use a base64pipe to decode the message and send the result to the pipeline exit")
public void setStreamResultToServlet(boolean b)
```
    Deprecated.
  - setStubFileName
```
@Deprecated
 @ConfigurationWarning(value="attribute \'stubFileName\' is replaced with \'stubFilename\'")
public void setStubFileName(String fileName)
```
    Deprecated.
  - setStubFilename
```
public void setStubFilename(String filename)
```
    If set, the pipe returns a message from a file, instead of doing the regular process
  - setTimeOutOnResult
```
public void setTimeOutOnResult(String string)
```
    If not empty, a TimeoutException is thrown when the result equals this value (for testing purposes only)
  - setExceptionOnResult
```
public void setExceptionOnResult(String string)
```
    If not empty, a PipeRunException is thrown when the result equals this value (for testing purposes only)

Class MessageSendingPipe

Nested Class Summary

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

Field Summary

Fields inherited from class nl.nn.adapterframework.stream.StreamingPipe

Fields inherited from class nl.nn.adapterframework.pipes.AbstractPipe

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

Fields inherited from interface nl.nn.adapterframework.core.IExtendedPipe

Constructor Summary

Method Summary

Methods inherited from class nl.nn.adapterframework.stream.StreamingPipe

Methods inherited from class nl.nn.adapterframework.pipes.FixedForwardPipe

Methods inherited from class nl.nn.adapterframework.pipes.AbstractPipe

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

Methods inherited from class java.lang.Object

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

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

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

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

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

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

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

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

Field Detail

msgLog

PIPE_TIMEOUT_MONITOR_EVENT

PIPE_CLEAR_TIMEOUT_MONITOR_EVENT

PIPE_EXCEPTION_MONITOR_EVENT

MIN_RETRY_INTERVAL

MAX_RETRY_INTERVAL

INPUT_VALIDATOR_NAME_PREFIX

INPUT_VALIDATOR_NAME_SUFFIX

OUTPUT_VALIDATOR_NAME_PREFIX

OUTPUT_VALIDATOR_NAME_SUFFIX

INPUT_WRAPPER_NAME_PREFIX

INPUT_WRAPPER_NAME_SUFFIX

OUTPUT_WRAPPER_NAME_PREFIX

OUTPUT_WRAPPER_NAME_SUFFIX

MESSAGE_LOG_NAME_PREFIX

MESSAGE_LOG_NAME_SUFFIX

Constructor Detail

MessageSendingPipe

Method Detail

configure

propagateName

setName

supportsOutputStreamPassThrough

canProvideOutputStream

canStreamToNextPipe

provideOutputStream

preserve

doPipe

sendMessage

increaseRetryIntervalAndWait

start

stop

iterateOverStatistics

hasSizeStatistics

consumesSessionVariable

setSender

setListener

setMessageLog

setInputValidator

setOutputValidator

setInputWrapper

setOutputWrapper

setLinkMethod

setCorrelationIDStyleSheet

setCorrelationIDXPath

setCorrelationIDNamespaceDefs

setCorrelationIDSessionKey

setLabelStyleSheet

setLabelXPath

setLabelNamespaceDefs

setAuditTrailXPath

setAuditTrailNamespaceDefs

setAuditTrailSessionKey

setUseInputForExtract

setHideRegex

setHideMethod