Package org.frankframework.pipes

Class TimeoutGuardPipe

java.lang.Object

org.frankframework.core.TransactionAttributes

org.frankframework.pipes.AbstractPipe

org.frankframework.pipes.FixedForwardPipe

org.frankframework.pipes.TimeoutGuardPipe

All Implemented Interfaces:

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

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

Method Summary

Modifier and Type	Method	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. otherwise the output is only logged as an error (and returned in a xml string with 'error' tags)
void	setTimeout(int i)	timeout in seconds of obtaining a result

Methods inherited from class org.frankframework.pipes.FixedForwardPipe

configure, 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, start, stop, 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

TimeoutGuardPipe

public TimeoutGuardPipe()

Method Details

doPipe

public PipeRunResult doPipe(Message message,
 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.

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