nl.nn.adapterframework.extensions.sap.jco3

Class SapSenderBase

java.lang.Object

nl.nn.adapterframework.extensions.sap.jco3.SapFunctionFacade

nl.nn.adapterframework.extensions.sap.jco3.SapSenderBase

All Implemented Interfaces:

HasPhysicalDestination, IConfigurable, IConfigurationAware, INamedObject, IScopeProvider, ISender, ISenderWithParameters, IWithParameters, ISapFunctionFacade, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

IdocSenderImpl, SapSenderImpl

public abstract class SapSenderBase
extends SapFunctionFacade
implements ISenderWithParameters

Base class for functions that call SAP.

Since:

5.0

Author:

Gerrit van Brakel, Jaco de Groot

Specific parameters

sapSystemName points to SapSystemImpl to use; required when attribute sapSystemName is empty

Field Summary

Fields

Modifier and Type	Field and Description
protected ParameterList	paramList

Fields inherited from class nl.nn.adapterframework.extensions.sap.jco3.SapFunctionFacade

log

Constructor Summary

Constructors

Constructor and Description
SapSenderBase()

Method Summary

Modifier and Type	Method and Description
void	addParameter(Parameter p)
void	close() Stop/close the sender and deallocate resources.
void	configure() configure() is called once at startup of the framework in the configure method of the owner of this sender.
com.sap.conn.jco.JCoDestination	getDestination(PipeLineSession session, SapSystemImpl sapSystem)
ParameterList	getParameterList()
SapSystemImpl	getSystem(ParameterValueList pvl)
String	getTid(com.sap.conn.jco.JCoDestination destination, SapSystemImpl sapSystem)
void	open() This method will be called to start the sender.
void	setLuwHandleSessionKey(String string) Session key in which LUW information is stored.
void	setSapSystemNameParam(String string) Name of the parameter used to indicate the name of the SapSystem used by this object if the attribute sapSystemName is empty
protected void	setSynchronous(boolean b) If false, the sender operates in RR mode: the a reply is expected from SAP, and the sender does not participate in a transaction.

Methods inherited from class nl.nn.adapterframework.extensions.sap.jco3.SapFunctionFacade

calculateStaticFieldIndices, closeFacade, findFieldIndex, functionCall2message, functionResult2message, getCorrelationIdFromField, getFunctionName, getFunctionTemplate, getFunctionTemplate, getLogPrefix, getPhysicalDestinationName, getSapSystem, getSapSystem, message2FunctionCall, message2FunctionResult, openFacade, setCorrelationIdFieldIndex, setCorrelationIdFieldName, setName, setParameters, setReplyFieldIndex, setReplyFieldName, setRequestFieldIndex, setRequestFieldName, setSapSystemName

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

consumesSessionVariable

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

isSynchronous, sendMessage, sendMessageOrThrow

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

getName, setName

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 org.springframework.context.ApplicationContextAware

setApplicationContext

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

getDomain

Field Detail

paramList

protected ParameterList paramList

Constructor Detail

SapSenderBase

public SapSenderBase()

Method Detail

configure

public void configure()
               throws ConfigurationException

Description copied from interface: ISender

configure() is called once at startup of the framework in the configure method of the owner of this sender. Purpose of this method is to check whether the static configuration of the sender is correct. As much as possible class-instantiating should take place in the configure() or open() method, to improve performance.

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface ISender

Overrides:

configure in class SapFunctionFacade

Throws:

ConfigurationException

open

public void open()
          throws SenderException

Description copied from interface: ISender

This method will be called to start the sender. After this method is called the sendMessage method may be called. Purpose of this method is to reduce creating connections to databases etc. in the sendMessage() method.

Specified by:

open in interface ISender

Throws:

SenderException

close

public void close()

Description copied from interface: ISender

Stop/close the sender and deallocate resources.

Specified by:

close in interface ISender

getSystem

public SapSystemImpl getSystem(ParameterValueList pvl)
                        throws SapException

Throws:

SapException

getDestination

public com.sap.conn.jco.JCoDestination getDestination(PipeLineSession session,
                                                      SapSystemImpl sapSystem)
                                               throws SenderException,
                                                      SapException,
                                                      com.sap.conn.jco.JCoException

Throws:

SenderException

SapException

com.sap.conn.jco.JCoException

getTid

public String getTid(com.sap.conn.jco.JCoDestination destination,
                     SapSystemImpl sapSystem)
              throws SapException,
                     com.sap.conn.jco.JCoException

Throws:

SapException

com.sap.conn.jco.JCoException

addParameter

public void addParameter(Parameter p)

Specified by:

addParameter in interface IWithParameters

getParameterList

public ParameterList getParameterList()

Specified by:

getParameterList in interface IWithParameters

setLuwHandleSessionKey

public void setLuwHandleSessionKey(String string)

Session key in which LUW information is stored. If set, actions that share a LUW-handle will be executed using the same destination. Can only be used for synchronous functions

setSapSystemNameParam

public void setSapSystemNameParam(String string)

Name of the parameter used to indicate the name of the SapSystem used by this object if the attribute sapSystemName is empty

Default value

sapSystemName

setSynchronous

protected void setSynchronous(boolean b)

If false, the sender operates in RR mode: the a reply is expected from SAP, and the sender does not participate in a transaction. When false, the sender operates in FF mode: no reply is expected from SAP, and the sender joins the transaction, that must be present. The SAP transaction is committed right after the XA transaction is completed.

Default value

false