Class SapSenderBase

java.lang.Object

org.frankframework.extensions.sap.jco3.SapFunctionFacade

org.frankframework.extensions.sap.jco3.SapSenderBase

All Implemented Interfaces:

FrankElement, HasApplicationContext, HasName, HasPhysicalDestination, IConfigurable, IScopeProvider, ISender, ISenderWithParameters, IWithParameters, NameAware, 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	Description
protected @NonNull ParameterList	paramList

Fields inherited from class SapFunctionFacade

log

Constructor Summary

Constructors

Constructor	Description
SapSenderBase()

Method Summary

Modifier and Type	Method	Description
void	addParameter(IParameter p)
void	configure()	Configure this component.
com.sap.conn.jco.JCoDestination	getDestination(PipeLineSession session, SapSystemImpl sapSystem)
@NonNull ParameterList	getParameterList()
SapSystemImpl	getSystem(ParameterValueList pvl)
String	getTid(com.sap.conn.jco.JCoDestination destination, SapSystemImpl sapSystem)
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.
void	start()	This method will be called to start the sender.
void	stop()	Stop/close the sender and deallocate resources.

Methods inherited from class 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 Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface FrankElement

addConfigWarning

Methods inherited from interface HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface HasName

getName

Methods inherited from interface ISender

isSynchronous, sendMessage, sendMessageOrThrow

Methods inherited from interface ISenderWithParameters

consumesSessionVariable

Methods inherited from interface NameAware

setName

Field Details

paramList

protected @NonNull ParameterList paramList

Constructor Details

SapSenderBase

public SapSenderBase()

Method Details

configure

public void configure()
               throws ConfigurationException

Description copied from interface: IConfigurable

Configure this component.

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

In the case of a container, this will propagate the configure signal to all components that apply.

Specified by:

configure in interface IConfigurable

Overrides:

configure in class SapFunctionFacade

Throws:

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

start

public void start()

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:

start in interface ISender

stop

public void stop()

Description copied from interface: ISender

Stop/close the sender and deallocate resources.

Specified by:

stop 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(IParameter p)

Specified by:

addParameter in interface IWithParameters

getParameterList

public @NonNull 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