Package com.uc4.api.objects

Class SAPConnectionRFC

java.lang.Object
com.uc4.api.objects.SAPConnectionRFC
public class SAPConnectionRFC extends Object
This class can be used to read or set the RFC connection data for SAP Connection objects.

  • Constructor Details

    • SAPConnectionRFC

      protected SAPConnectionRFC(com.uc4.util.XMLDocument doc, ConnectionAttributes session)
      Creates a new SAPConnectionRFC from the specified XML document.
      Parameters:
      doc - XML document

  • Method Details

    • setBIChainsParallel

      public void setBIChainsParallel(boolean par)
      Enables or disables the parallel execution of the same chain in one SAP Agent.
      Parameters:
      par - true if BI chains are allowed to run in parallel

    • setSNCEnable

      public void setSNCEnable(boolean enable)
      Enables or disables the SNC mode.
      Parameters:
      enable - true if SNC should be enabled, false if it should be disabled.

    • isSNCEnabled

      public boolean isSNCEnabled()
      Returns true if SNC is enabled, false otherwise. If the vlaue has not been set yet, false is returned.
      Returns:
      SNC enabled

    • setSSOEnable

      public void setSSOEnable(boolean enable)
      Enables or disables the SNC SSO.
      Parameters:
      enable - true if SNC SSO should be enabled, false if it should be disabled.

    • isSSOEnabled

      public boolean isSSOEnabled()
      Returns true if SNC SSO is enabled, false otherwise. If the value has not been set yet, false is returned.
      Returns:
      SNC enabled

    • setSNCLib

      public void setSNCLib(String lib)
      Sets the path to the SNC library.
      Parameters:
      lib - SNC library

    • getSNCLib

      public String getSNCLib()
      Returns the SNC library.
      Returns:
      Path to the SNC library

    • setLogin

      public void setLogin(UC4ObjectName login)
      Sets the login.
      Parameters:
      login - the new login or null if not used

    • getLogin

      public UC4ObjectName getLogin()
      Returns the Login
      Returns:
      Login or null if not set

    • setSpoolBlocksize

      public void setSpoolBlocksize(int kilobytes)
      Sets the blocksize for the transfer of spool lists.
      Parameters:
      kilobytes - Block size in kilobytes

    • setSpoolBlocksize

      public void setSpoolBlocksize(String kilobytes)
      Sets the block size for the transfer of spool lists, allows null and empty string.
      Parameters:
      kilobytes - kilobytes Block size in kilobytes

    • getSpoolBlocksize

      public int getSpoolBlocksize()
      Returns the blocksize for the transfer of spool lists.
      Returns:
      Block size in kilobytes

    • setSNCMyName

      public void setSNCMyName(String myName)
      Sets the SNC "MyName" value.
      Parameters:
      myName - My name

    • getSNCMyName

      public String getSNCMyName()
      Returns the SNC "MyName" value.
      Returns:
      My name

    • setSNCPartnerName

      public void setSNCPartnerName(String partnerName)
      Sets the SNC Partner name.
      Parameters:
      partnerName - name

    • getSNCPartnerName

      public String getSNCPartnerName()
      Returns the SNC Partner name.
      Returns:
      name

    • setSNCQOP

      public void setSNCQOP(int qop)
      Sets the QOP level for the SNC encryption.
      Parameters:
      qop - Integer between one and nine

    • getSNCQOP

      public int getSNCQOP()
      Returns the QOP value for the SNC encryption.
      Returns:
      Integer from one to nine

    • setBIRepeatChecks

      public void setBIRepeatChecks(int runs)
      Sets the number of checks repeated status checks if the extended Info Package monitoring has been set to REPEAT_CHECK.
      Parameters:
      runs - Number of checks

    • setBIRepeatChecks

      public void setBIRepeatChecks(String runs)
      Sets the number of checks repeated status checks if the extended Info Package monitoring has been set to REPEAT_CHECK, allows null and empty string.
      Parameters:
      runs - runs Number of checks

    • getBIRepeatChecks

      public int getBIRepeatChecks()
      Returns the number of checks repeated status checks if the extended Info Package monitoring has been set to REPEAT_CHECK.
      Returns:
      Number of checks

    • setBIExtendedMonitoring

      public void setBIExtendedMonitoring(SAPConnectionRFC.BIExtendedMonitoring ext)
      Sets the status of the extended monitoring of Info Packages.
      Parameters:
      ext - Enumeration containing the extended monitoring

    • getBIRepeatDataRequestChecks

      public int getBIRepeatDataRequestChecks()
      Returns the number of runs for data request checks
      Returns:
      Number of runs

    • setBIRepeatDataRequestChecks

      public void setBIRepeatDataRequestChecks(int runs)
      Sets the number of runs for data request checks.
      Parameters:
      runs - Number of runs

    • setBIRepeatDataRequestChecks

      public void setBIRepeatDataRequestChecks(String runs)
      Sets the number of runs for data request checks, allows null and empty string.
      Parameters:
      runs - runs Number of runs

    • getBIExtendedMonitoring

      public SAPConnectionRFC.BIExtendedMonitoring getBIExtendedMonitoring()
      Returns the status of the extended monitoring of Info Packages.
      Returns:
      Enumeration containing the status

    • isBIChainsParallel

      public boolean isBIChainsParallel()
      Returns true if process chains can be executed in parallel.
      Returns:
      true if parallel executions of chains are allowed

    • setXBPAuditlevel

      public void setXBPAuditlevel(int level)
      Sets the XBP audit level (0 == minimal, 3 == Trace).
      Parameters:
      level - Audit level

    • setIPakChange

      public void setIPakChange(int change)
      Sets the value of the IPak Change parameter.
      Parameters:
      change - IPak change

    • getIPakChange

      public int getIPakChange()
      Returns the IPak Change parameter.
      Returns:
      IPak Change

    • setXALVersion

      public void setXALVersion(SAPConnectionRFC.XALVersion version)
      Sets the version of the XAL interface. Currently only 1.0 and the default can be set.
      Parameters:
      version - XAL version

    • setXALSystemLog

      public void setXALSystemLog(boolean enable)
      Enables or disables the transfer of the XAL system log. This method returns false if no value has been set yet.
      Parameters:
      enable - true if the log should be transfered in case of an error, false otherwise

    • setXALMonitor

      public void setXALMonitor(String monitor)
      Sets the name of the XAL monitor.
      Parameters:
      monitor - Name of the XAL monitor

    • getXALMonitor

      public String getXALMonitor()
      Returns the name of the monitor.
      Returns:
      the name of the monitor

    • setXALMonitorSet

      public void setXALMonitorSet(String set)
      Sets the name of the XAL monitor set.
      Parameters:
      set - the name of the monitor set.

    • getXALMonitorSet

      public String getXALMonitorSet()
      Returns the name of the monitor set.
      Returns:
      Name of the monitor set.

    • setXALMonitorShortName

      public void setXALMonitorShortName(String name)
      Sets the short name of the XAL monitor.
      Parameters:
      name - Short name of the XAL Monitor

    • getXALMonitorShortName

      public String getXALMonitorShortName()
      Returns the short name of the XAL monitor.
      Returns:
      Short name of the XAL Monitor

    • isXALSystemLog

      public boolean isXALSystemLog()
      Returns true if the SAP system log should be transfered in case of an error. This method returns false if a value has not been set yet.
      Returns:
      true if the system log should be transfered, false otherwise

    • getXALVersion

      public SAPConnectionRFC.XALVersion getXALVersion()
      Returns the XAL Version, DEFAULT if not set.
      Returns:
      The XAL Version

    • getXBPAuditlevel

      public int getXBPAuditlevel()
      Returns the XBP auditlevel (0= Minimal, 3= Trace) Depending on the auditlevel the XMI log will contain more or less entries.
      Returns:
      XBP Auditlevel as integer

    • isCollapseSteps

      public boolean isCollapseSteps()
      Return if one SAP job can contain multiple steps.
      Returns:
      true if one SAP job can contain more than one step, false otherwise

    • setCollapseSteps

      public void setCollapseSteps(boolean collapse)
      Enables or disables the use of multiple steps in one SAP job.
      Parameters:
      collapse - if true one SAP job can contain more than one step, if false each created SAP Job will only have one step

    • isConfirmEventHistory

      public boolean isConfirmEventHistory()
      Return if events in the history should be confirmed after processed by the agent
      Returns:
      true if event history should be confirmed

    • setConfirmEventHistory

      public void setConfirmEventHistory(boolean confirm)
      Enables or disables if events in the history should be confirmed after processed by the agent
      Parameters:
      confirm - true if events in the history should be confirmed, false if not (events then always get status "new")

    • isAllowUc4Interface

      public boolean isAllowUc4Interface()
      Returns true if the uc4 function modules should be used. If the value has not been set yet, false is returned.
      Returns:
      true if the uc4 function modules should be used, false otherwise

    • setAllowUc4Interface

      public void setAllowUc4Interface(boolean allow)
      Enables or disables the use of the UC4 function modules.
      Parameters:
      allow - true if the uc4 function modules should be used, false if only XBP function modules should be called

    • getXBPVersion

      public SAPConnectionRFC.XBPVersion getXBPVersion()
      Returns the XBP Version.
      Returns:
      Version of the XBP interface, DEFAULT if not set.

    • setXBPVersion

      public void setXBPVersion(SAPConnectionRFC.XBPVersion version)
      Sets the version of the XBP Interface.
      Parameters:
      version - XBP Version

    • setUser

      public void setUser(String user)
      Sets the user name for the batch user.
      Parameters:
      user - User name

    • getUser

      public String getUser()
      Returns the name of the batch user.
      Returns:
      name of the CPIC user

    • setClient

      public void setClient(int client)
      Sets the logon client.
      Parameters:
      client - Integer between 0 and 999 or -1 if not used

    • getClient

      public int getClient()
      Returns the SAP client.
      Returns:
      client or -1 if not set

    • setLanguage

      public void setLanguage(String lang)
      Sets the logon language (for example DE or EN) or null if not used
      Parameters:
      lang - Language

    • getLanguage

      public String getLanguage()
      Returns the logon language.
      Returns:
      Logon language

    • getGroup

      public String getGroup()
      Returns the GROUP.
      Returns:
      group

    • setPassword

      public void setPassword(String pass)
      Sets the password of the logon user.
      Parameters:
      pass - Password

    • getMaxConnectionCount

      public int getMaxConnectionCount()
      Returns the maximum number of concurrent RFC connections to the SAP system.
      Returns:
      Max rfc connection or -1 if not set

    • setMaxConnectionCount

      public void setMaxConnectionCount(int count)
      Sets the maximum number of concurrent RFC connections.
      Parameters:
      count - Max rfc connection

    • setMaxConnectionCount

      public void setMaxConnectionCount(String count)
      Sets the maximum number of concurrent RFC connections, allows null and empty string.
      Parameters:
      count - Max rfc connection

    • setDirectConnection

      public void setDirectConnection(String ashost, int sysNr, String sid, String router)
      Sets up a direct connection to the SAP system.
      Parameters:
      ashost - Name of the application server host or null if not used
      sysNr - Systm number 0-99 or -1 if not used
      sid - System ID or null if not used
      router - SAP router String or null if not used

    • getAsHost

      public String getAsHost()
      Returns the application server if a direct connection has been used.
      Returns:
      Hostname of the application server

    • getSystemNumber

      public int getSystemNumber()
      Returns the system number or -1 if not set.
      Returns:
      System number

    • getSID

      public String getSID()
      Returns the system id of the SAP System.
      Returns:
      SID

    • getSAPRouter

      public String getSAPRouter()
      Returns the SAP router string.
      Returns:
      SAP router string

    • isAllowSMSEInterface

      public boolean isAllowSMSEInterface()
      Returns true if the SMSE function modules should be used. If the value has not been set yet, false is returned.
      Returns:
      true if the SMSE function modules should be used, false otherwise

    • setAllowSMSEInterface

      public void setAllowSMSEInterface(boolean allow)
      Enables or disables the use of the SMSE function modules.
      Parameters:
      allow - true if the SMSE function modules should be used

    • setUC4Client

      public void setUC4Client(int client)
      Sets the UC4 client.
      Parameters:
      client - Integer between 0 and 9999 or -1 if not used

    • setUC4Client

      public void setUC4Client(String client)
      Sets the UC4 client, allows null and empty string
      Parameters:
      client - Integer between 0 and 9999 or -1 if not used

    • getUC4Client

      public int getUC4Client()
      Returns the SAP client.
      Returns:
      client or -1 if not set

    • setUC4User

      public void setUC4User(String set)
      Sets the name of the UC4 user.
      Parameters:
      set - the name of the UC4 user.

    • getUC4User

      public String getUC4User()
      Returns the name of the UC4 user.
      Returns:
      Name of the UC4 user.

    • setUC4Department

      public void setUC4Department(String set)
      Sets the name of the UC4 department.
      Parameters:
      set - the name of the UC4 department.

    • getUC4Department

      public String getUC4Department()
      Returns the name of the UC4 department.
      Returns:
      Name of the UC4 department.

    • setUC4Password

      public void setUC4Password(String set)
      Sets the UC4 password.
      Parameters:
      set - the UC4 password.

    • setGatewayHost

      public void setGatewayHost(String set)
      Sets the gateway host.
      Parameters:
      set - the gateway host.

    • getGatewayHost

      public String getGatewayHost()
      Returns the Gateway Host.
      Returns:
      Gateway Host.

    • setGatewayService

      public void setGatewayService(String set)
      Sets the gateway service.
      Parameters:
      set - the gateway service.

    • getGatewayService

      public String getGatewayService()
      Returns the Gateway Service.
      Returns:
      Gateway Service.

    • setProgramId

      public void setProgramId(String set)
      Sets the program id.
      Parameters:
      set - the program id.

    • getProgramId

      public String getProgramId()
      Returns the program id
      Returns:
      program id.

    • setDestination

      public void setDestination(String set)
      Sets the Destination.
      Parameters:
      set - the Destination.

    • getDestination

      public String getDestination()
      Returns the Destination
      Returns:
      Destination.

    • setLoadBalancedConnection

      public void setLoadBalancedConnection(String sid, String messageServer, String group, String router)
      Sets up a load balanced connection the SAP system.
      Parameters:
      sid - SID or null if not used
      messageServer - Host name of the message server or null if not used
      group - Group name or null if not used
      router - SAP router String or null if not used

    • getMessageServer

      public String getMessageServer()
      Returns the Message Server.
      Returns:
      message server

    • isUseLoadBalancing

      public boolean isUseLoadBalancing()
      Returns:
      true if load balancing is set, false otherwise

    • store

      protected void store(com.uc4.util.XMLDocument doc, Element objectElement, ConnectionAttributes session, String ocvType)
      Saves the content of this instance in the specified DOM document
      Parameters:
      doc - XML Document
      objectElement - Parent element