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()
void	configure()
com.sap.conn.jco.JCoDestination	getDestination(PipeLineSession session, SapSystemImpl sapSystem)
String	getLuwHandleSessionKey()
ParameterList	getParameterList()
String	getSapSystemNameParam()
SapSystemImpl	getSystem(ParameterValueList pvl)
String	getTid(com.sap.conn.jco.JCoDestination destination, SapSystemImpl sapSystem)
boolean	isSynchronous()
void	open()
Message	sendMessage(Message message, PipeLineSession session)
void	setLuwHandleSessionKey(String string)
void	setSapSystemNameParam(String string)
protected void	setSynchronous(boolean b)

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

calculateStaticFieldIndices, closeFacade, findFieldIndex, functionCall2message, functionResult2message, getApplicationContext, getConfigurationClassLoader, getCorrelationIdFieldIndex, getCorrelationIdFieldName, getCorrelationIdFromField, getDomain, getFunctionName, getFunctionTemplate, getFunctionTemplate, getLogPrefix, getName, getPhysicalDestinationName, getReplyFieldIndex, getReplyFieldName, getRequestFieldIndex, getRequestFieldName, getSapSystem, getSapSystem, getSapSystemName, message2FunctionCall, message2FunctionResult, openFacade, setApplicationContext, 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.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

Field Detail

paramList

protected ParameterList paramList

Constructor Detail

SapSenderBase

public SapSenderBase()

Method Detail

configure

public void configure()
               throws ConfigurationException

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

Specified by:

open in interface ISender

Throws:

SenderException

close

public void close()

Specified by:

close in interface ISender

sendMessage

public Message sendMessage(Message message,
                           PipeLineSession session)
                    throws SenderException,
                           TimeoutException

Specified by:

sendMessage in interface ISender

Throws:

SenderException

TimeoutException

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

@IbisDoc(value={"1","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",""})
public void setLuwHandleSessionKey(String string)

setSapSystemNameParam

@IbisDoc(value={"2","name of the parameter used to indicate the name of the {@link SapSystem} used by this object if the attribute <code>sapSystemName</code> is empty","sapSystemName"})
public void setSapSystemNameParam(String string)

setSynchronous

@IbisDoc(value={"3","when <code>false</code>, the sender operates in RR mode: the a reply is expected from SAP, and the sender does not participate in a transaction. When <code>false</code>, 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.","false"})
protected void setSynchronous(boolean b)

getLuwHandleSessionKey

public String getLuwHandleSessionKey()

getSapSystemNameParam

public String getSapSystemNameParam()

isSynchronous

public boolean isSynchronous()

Specified by:

isSynchronous in interface ISender