Package org.frankframework.extensions.sap.jco3

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 Details

  • 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

      @Nonnull 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