Package org.frankframework.extensions.sap.jco3

Class SapLUWManagerPipe

java.lang.Object

org.frankframework.core.TransactionAttributes

org.frankframework.pipes.AbstractPipe

org.frankframework.pipes.FixedForwardPipe

org.frankframework.extensions.sap.jco3.SapLUWManagerPipe

All Implemented Interfaces:

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

public class SapLUWManagerPipe
extends FixedForwardPipe

Manager for SAP Logical Units of Work (LUWs). Used to begin, commit or rollback LUWs. A SapLUWManager can be placed before a number of SapSenders. The SapLUWManager and the SapSenders must each use the same value for luwHandleSessionKey. By doing so, they use the same connection to SAP. This allows to perform a commit on a number of actions.
The placement of the the first SapLUWManager is optionan: By specifying a new luwHandleSessionKey a new handle is created implicitly.
To explicityly commit or rollback a set of actions, a SapLUWManager-pipe can be used, with the action-attribute set apropriately.

Since:

5.0

Author:

Gerrit van Brakel, Jaco de Groot

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACTION_BEGIN
static final String	ACTION_COMMIT
static final String	ACTION_RELEASE
static final String	ACTION_ROLLBACK

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

Method Summary

Modifier and Type	Method	Description
void	configure()	Checks for correct configuration of forward.
PipeRunResult	doPipe(Message message, PipeLineSession session)	This is where the action takes place.
void	setAction(String string)	One of: begin, commit, rollback, release
void	setLuwHandleSessionKey(String string)	Session key under which information is stored
void	setSapSystemName(String string)	Name of the SapSystem used by this object
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.FixedForwardPipe

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

Methods inherited from class org.frankframework.pipes.AbstractPipe

addForward, addParameter, consumesSessionVariable, createBean, findForward, getAdapter, getEventSourceName, getParameterList, getRegisteredForwards, hasRegisteredForward, isRunning, registerEvent, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, sizeStatisticsEnabled, 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.FrankElement

addConfigWarning

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

Field Details

ACTION_BEGIN

public static final String ACTION_BEGIN

See Also:

• Constant Field Values

ACTION_COMMIT

public static final String ACTION_COMMIT

See Also:

• Constant Field Values

ACTION_ROLLBACK

public static final String ACTION_ROLLBACK

See Also:

• Constant Field Values

ACTION_RELEASE

public static final String ACTION_RELEASE

See Also:

• Constant Field Values

Constructor Details

SapLUWManagerPipe

public SapLUWManagerPipe()

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 FixedForwardPipe

Throws:

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

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 AbstractPipe

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 AbstractPipe

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.

Throws:

PipeRunException

setSapSystemName

public void setSapSystemName(String string)

Name of the SapSystem used by this object

setAction

public void setAction(String string)

One of: begin, commit, rollback, release

setLuwHandleSessionKey

public void setLuwHandleSessionKey(String string)

Session key under which information is stored