Package org.frankframework.pipes

Class PostboxRetrieverPipe

java.lang.Object

org.frankframework.core.TransactionAttributes

org.frankframework.pipes.AbstractPipe

org.frankframework.pipes.FixedForwardPipe

org.frankframework.pipes.PostboxRetrieverPipe

All Implemented Interfaces:

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

@Deprecated(forRemoval=true,
            since="7.7.0")
public class PostboxRetrieverPipe
extends FixedForwardPipe

Deprecated, for removal: This API element is subject to removal in a future version.

Retrieves a message using an IPostboxListener. Note that most listeners allow you to specify a timeout. The timeout has the following meaning:

• <0 = no wait
• 0 = block until message available
• >= 0 maximum wait in milliseconds

nested elementsdescription listenerspecification of postbox listener to retrieve messages from

Author:

John Dekker

Field Summary

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
PostboxRetrieverPipe()	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
void	configure()	Deprecated, for removal: This API element is subject to removal in a future version. checks for correct configuration of forward
PipeRunResult	doPipe(Message message, PipeLineSession session)	Deprecated, for removal: This API element is subject to removal in a future version. This is where the action takes place.
IPostboxListener	getListener()	Deprecated, for removal: This API element is subject to removal in a future version.
String	getResultOnEmptyPostbox()	Deprecated, for removal: This API element is subject to removal in a future version.
void	setListener(IPostboxListener listener)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setResultOnEmptyPostbox(String string)	Deprecated, for removal: This API element is subject to removal in a future version. result when no object is on postbox
void	start()	Deprecated, for removal: This API element is subject to removal in a future version. Perform necessary action to start the pipe.
void	stop()	Deprecated, for removal: This API element is subject to removal in a future version. Perform necessary actions to stop the Pipe. For instance, closing JMS connections, DBMS connections etc.

Methods inherited from class org.frankframework.pipes.FixedForwardPipe

getIfParam, getIfValue, getOnlyIfSessionKey, getOnlyIfValue, getParameterValue, getSuccessForward, getUnlessSessionKey, getUnlessValue, isSkipOnEmptyInput, setIfParam, setIfValue, setOnlyIfSessionKey, setOnlyIfValue, setSkipOnEmptyInput, setUnlessSessionKey, setUnlessValue, skipPipe

Methods inherited from class org.frankframework.pipes.AbstractPipe

addForward, addParameter, consumesSessionVariable, createBean, findForward, getAdapter, getApplicationContext, getChompCharSize, getConfigurationClassLoader, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getEventSourceName, getForwards, getGetInputFromFixedValue, getGetInputFromSessionKey, getHideRegex, getLocker, getLogIntermediaryResults, getMaxThreads, getName, getParameterList, getPipeLine, getSecLogSessionKeys, getStoreResultInSessionKey, hasRegisteredForward, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, registerEvent, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setEventPublisher, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setPipeLine, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, sizeStatisticsEnabled, throwEvent

Methods inherited from class org.frankframework.core.TransactionAttributes

configureTransactionAttributes, getTransactionAttribute, getTransactionTimeout, getTxDef, isTransacted, isTransacted, setTransacted, setTransactionAttribute, 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.IPipe

throwEvent

Constructor Details

PostboxRetrieverPipe

public PostboxRetrieverPipe()

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

configure

public void configure()
               throws ConfigurationException

Deprecated, for removal: This API element is subject to removal in a future version.

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 FixedForwardPipe

Throws:

ConfigurationException

getListener

public IPostboxListener getListener()

Deprecated, for removal: This API element is subject to removal in a future version.

setListener

public void setListener(IPostboxListener listener)

Deprecated, for removal: This API element is subject to removal in a future version.

start

public void start()

Deprecated, for removal: This API element is subject to removal in a future version.

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

stop

public void stop()

Deprecated, for removal: This API element is subject to removal in a future version.

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

doPipe

public PipeRunResult doPipe(Message message,
 PipeLineSession session)
                     throws PipeRunException

Deprecated, for removal: This API element is subject to removal in a future version.

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.

Throws:

PipeRunException

getResultOnEmptyPostbox

public String getResultOnEmptyPostbox()

Deprecated, for removal: This API element is subject to removal in a future version.

setResultOnEmptyPostbox

public void setResultOnEmptyPostbox(String string)

Deprecated, for removal: This API element is subject to removal in a future version.

result when no object is on postbox

Default value

empty postbox