nl.nn.adapterframework.pipes

Class TimeoutGuardPipe

java.lang.Object

nl.nn.adapterframework.core.TransactionAttributes

nl.nn.adapterframework.pipes.AbstractPipe

nl.nn.adapterframework.pipes.FixedForwardPipe

nl.nn.adapterframework.pipes.TimeoutGuardPipe

All Implemented Interfaces:

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

Direct Known Subclasses:

DirectWrapperPipe, GetTibcoQueues, SendTibcoMessage

public abstract class TimeoutGuardPipe
extends FixedForwardPipe

Extension to FixedForwardPipe for interrupting processing when timeout is exceeded.

Author:

Peter Leeuwenburgh

Specific parameters

timeout When a parameter with name timeout is present, it is used instead of the timeout specified by the attribute

Field Summary

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
TimeoutGuardPipe()

Method Summary

Modifier and Type	Method and Description
PipeRunResult	doPipe(Message message, PipeLineSession session) This is where the action takes place.
abstract PipeRunResult	doPipeWithTimeoutGuarded(Message input, PipeLineSession session) doPipe wrapped around a TimeoutGuard
int	getTimeout()
boolean	isThrowException()
protected void	killPipe() optional implementation to kill additional threads if the pipe may have created those.
void	setThrowException(boolean b) when true, a piperunexception is thrown.
void	setTimeout(int i) timeout in seconds of obtaining a result

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

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

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

addParameter, consumesSessionVariable, createBean, findForward, getAdapter, getEventSourceName, getForwards, getInSizeStatDummyObject, getOutSizeStatDummyObject, getParameterList, getParameterOverriddenAttributeValue, getParameterValueList, hasSizeStatistics, registerEvent, registerForward, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, start, stop, throwEvent

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.IExtendedPipe

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

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

getMaxThreads

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

getName

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

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Constructor Detail

TimeoutGuardPipe

public TimeoutGuardPipe()

Method Detail

doPipe

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

Description copied from class: AbstractPipe

This is where the action takes place. Pipes may only throw a PipeRunException, to be handled by the caller of this object.

Specified by:

doPipe in interface IPipe

Specified by:

doPipe in class AbstractPipe

Throws:

PipeRunException

doPipeWithTimeoutGuarded

public abstract PipeRunResult doPipeWithTimeoutGuarded(Message input,
                                                       PipeLineSession session)
                                                throws PipeRunException

doPipe wrapped around a TimeoutGuard

Throws:

PipeRunException

killPipe

protected void killPipe()

optional implementation to kill additional threads if the pipe may have created those.

setThrowException

public void setThrowException(boolean b)

when true, a piperunexception is thrown. otherwise the output is only logged as an error (and returned in a xml string with 'error' tags)

Default value

true

isThrowException

public boolean isThrowException()

getTimeout

public int getTimeout()

setTimeout

public void setTimeout(int i)

timeout in seconds of obtaining a result

Default value

30