nl.nn.adapterframework.extensions.sap.jco3

Class SapLUWManager

java.lang.Object

nl.nn.adapterframework.core.TransactionAttributes

nl.nn.adapterframework.pipes.AbstractPipe

nl.nn.adapterframework.pipes.FixedForwardPipe

nl.nn.adapterframework.extensions.sap.jco3.SapLUWManager

All Implemented Interfaces:

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

public class SapLUWManager
extends FixedForwardPipe
implements IPipeLineExitHandler

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 and Description
static String	ACTION_BEGIN
static String	ACTION_COMMIT
static String	ACTION_RELEASE
static String	ACTION_ROLLBACK

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

Method Summary

Modifier and Type	Method and Description
void	atEndOfPipeLine(String correlationId, PipeLineResult pipeLineResult, PipeLineSession session) Called to allow registered handler to perform cleanup or commit/rollback.
void	configure() checks for correct configuration of forward
PipeRunResult	doPipe(Message message, PipeLineSession session) This is where the action takes place.
SapSystemImpl	getSapSystem()
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 nl.nn.adapterframework.pipes.FixedForwardPipe

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

getName, setName

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

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 Detail

SapLUWManager

public SapLUWManager()

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 FixedForwardPipe

Throws:

ConfigurationException

atEndOfPipeLine

public void atEndOfPipeLine(String correlationId,
                            PipeLineResult pipeLineResult,
                            PipeLineSession session)
                     throws PipeRunException

Description copied from interface: IPipeLineExitHandler

Called to allow registered handler to perform cleanup or commit/rollback.

Specified by:

atEndOfPipeLine in interface IPipeLineExitHandler

Parameters:

correlationId - correlationId of current session

pipeLineResult - the result of the PipeLine

session - the PipeLineSession

Throws:

PipeRunException

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

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

getSapSystem

public SapSystemImpl getSapSystem()

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