Package com.uc4.api.objects
Class SAPConnectionRFC
java.lang.Object
com.uc4.api.objects.SAPConnectionRFC
This class can be used to read or set the RFC connection data
for SAP Connection objects.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
SAP BW Extended Monitoring.static enum
XAL version.static enum
XBP version. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
SAPConnectionRFC
(com.uc4.util.XMLDocument doc, ConnectionAttributes session) Creates a newSAPConnectionRFC
from the specified XML document. -
Method Summary
Modifier and TypeMethodDescriptionReturns the application server if a direct connection has been used.Returns the status of the extended monitoring of Info Packages.int
Returns the number of checks repeated status checks if the extended Info Package monitoring has been set to REPEAT_CHECK.int
Returns the number of runs for data request checksint
Returns the SAP client.Returns the DestinationReturns the Gateway Host.Returns the Gateway Service.getGroup()
Returns the GROUP.int
Returns the IPak Change parameter.Returns the logon language.getLogin()
Returns the Loginint
Returns the maximum number of concurrent RFC connections to the SAP system.Returns the Message Server.Returns the program idReturns the SAP router string.getSID()
Returns the system id of the SAP System.Returns the SNC library.Returns the SNC "MyName" value.Returns the SNC Partner name.int
Returns the QOP value for the SNC encryption.int
Returns the blocksize for the transfer of spool lists.int
Returns the system number or-1
if not set.int
Returns the SAP client.Returns the name of the UC4 department.Returns the name of the UC4 user.getUser()
Returns the name of the batch user.Returns the name of the monitor.Returns the name of the monitor set.Returns the short name of the XAL monitor.Returns the XAL Version, DEFAULT if not set.int
Returns the XBP auditlevel (0= Minimal, 3= Trace) Depending on the auditlevel the XMI log will contain more or less entries.Returns the XBP Version.boolean
Returnstrue
if the SMSE function modules should be used.boolean
Returnstrue
if the uc4 function modules should be used.boolean
Returnstrue
if process chains can be executed in parallel.boolean
Return if one SAP job can contain multiple steps.boolean
Return if events in the history should be confirmed after processed by the agentboolean
Returnstrue
if SNC is enabled, false otherwise.boolean
Returnstrue
if SNC SSO is enabled, false otherwise.boolean
boolean
Returnstrue
if the SAP system log should be transfered in case of an error.void
setAllowSMSEInterface
(boolean allow) Enables or disables the use of the SMSE function modules.void
setAllowUc4Interface
(boolean allow) Enables or disables the use of the UC4 function modules.void
setBIChainsParallel
(boolean par) Enables or disables the parallel execution of the same chain in one SAP Agent.void
Sets the status of the extended monitoring of Info Packages.void
setBIRepeatChecks
(int runs) Sets the number of checks repeated status checks if the extended Info Package monitoring has been set to REPEAT_CHECK.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.void
setBIRepeatDataRequestChecks
(int runs) Sets the number of runs for data request checks.void
Sets the number of runs for data request checks, allows null and empty string.void
setClient
(int client) Sets the logon client.void
setCollapseSteps
(boolean collapse) Enables or disables the use of multiple steps in one SAP job.void
setConfirmEventHistory
(boolean confirm) Enables or disables if events in the history should be confirmed after processed by the agentvoid
setDestination
(String set) Sets the Destination.void
setDirectConnection
(String ashost, int sysNr, String sid, String router) Sets up a direct connection to the SAP system.void
setGatewayHost
(String set) Sets the gateway host.void
setGatewayService
(String set) Sets the gateway service.void
setIPakChange
(int change) Sets the value of the IPak Change parameter.void
setLanguage
(String lang) Sets the logon language (for example DE or EN) ornull
if not usedvoid
setLoadBalancedConnection
(String sid, String messageServer, String group, String router) Sets up a load balanced connection the SAP system.void
setLogin
(UC4ObjectName login) Sets the login.void
setMaxConnectionCount
(int count) Sets the maximum number of concurrent RFC connections.void
setMaxConnectionCount
(String count) Sets the maximum number of concurrent RFC connections, allows null and empty string.void
setPassword
(String pass) Sets the password of the logon user.void
setProgramId
(String set) Sets the program id.void
setSNCEnable
(boolean enable) Enables or disables the SNC mode.void
Sets the path to the SNC library.void
setSNCMyName
(String myName) Sets the SNC "MyName" value.void
setSNCPartnerName
(String partnerName) Sets the SNC Partner name.void
setSNCQOP
(int qop) Sets the QOP level for the SNC encryption.void
setSpoolBlocksize
(int kilobytes) Sets the blocksize for the transfer of spool lists.void
setSpoolBlocksize
(String kilobytes) Sets the block size for the transfer of spool lists, allows null and empty string.void
setSSOEnable
(boolean enable) Enables or disables the SNC SSO.void
setUC4Client
(int client) Sets the UC4 client.void
setUC4Client
(String client) Sets the UC4 client, allows null and empty stringvoid
setUC4Department
(String set) Sets the name of the UC4 department.void
setUC4Password
(String set) Sets the UC4 password.void
setUC4User
(String set) Sets the name of the UC4 user.void
Sets the user name for the batch user.void
setXALMonitor
(String monitor) Sets the name of the XAL monitor.void
setXALMonitorSet
(String set) Sets the name of the XAL monitor set.void
setXALMonitorShortName
(String name) Sets the short name of the XAL monitor.void
setXALSystemLog
(boolean enable) Enables or disables the transfer of the XAL system log.void
setXALVersion
(SAPConnectionRFC.XALVersion version) Sets the version of the XAL interface.void
setXBPAuditlevel
(int level) Sets the XBP audit level (0 == minimal, 3 == Trace).void
setXBPVersion
(SAPConnectionRFC.XBPVersion version) Sets the version of the XBP Interface.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
-
Constructor Details
-
SAPConnectionRFC
Creates a newSAPConnectionRFC
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()Returnstrue
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()Returnstrue
if SNC SSO is enabled, false otherwise. If the value has not been set yet,false
is returned.- Returns:
- SNC enabled
-
setSNCLib
Sets the path to the SNC library.- Parameters:
lib
- SNC library
-
getSNCLib
Returns the SNC library.- Returns:
- Path to the SNC library
-
setLogin
Sets the login.- Parameters:
login
- the new login ornull
if not used
-
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
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
Sets the SNC "MyName" value.- Parameters:
myName
- My name
-
getSNCMyName
Returns the SNC "MyName" value.- Returns:
- My name
-
setSNCPartnerName
Sets the SNC Partner name.- Parameters:
partnerName
- name
-
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
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
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
Sets the number of runs for data request checks, allows null and empty string.- Parameters:
runs
- runs Number of runs
-
getBIExtendedMonitoring
Returns the status of the extended monitoring of Info Packages.- Returns:
- Enumeration containing the status
-
isBIChainsParallel
public boolean isBIChainsParallel()Returnstrue
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
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 returnsfalse
if no value has been set yet.- Parameters:
enable
- true if the log should be transfered in case of an error, false otherwise
-
setXALMonitor
Sets the name of the XAL monitor.- Parameters:
monitor
- Name of the XAL monitor
-
getXALMonitor
Returns the name of the monitor.- Returns:
- the name of the monitor
-
setXALMonitorSet
Sets the name of the XAL monitor set.- Parameters:
set
- the name of the monitor set.
-
getXALMonitorSet
Returns the name of the monitor set.- Returns:
- Name of the monitor set.
-
setXALMonitorShortName
Sets the short name of the XAL monitor.- Parameters:
name
- Short name of the XAL Monitor
-
getXALMonitorShortName
Returns the short name of the XAL monitor.- Returns:
- Short name of the XAL Monitor
-
isXALSystemLog
public boolean isXALSystemLog()Returnstrue
if the SAP system log should be transfered in case of an error. This method returnsfalse
if a value has not been set yet.- Returns:
- true if the system log should be transfered, false otherwise
-
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()Returnstrue
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
Returns the XBP Version.- Returns:
- Version of the XBP interface, DEFAULT if not set.
-
setXBPVersion
Sets the version of the XBP Interface.- Parameters:
version
- XBP Version
-
setUser
Sets the user name for the batch user.- Parameters:
user
- User name
-
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
Sets the logon language (for example DE or EN) ornull
if not used- Parameters:
lang
- Language
-
getLanguage
Returns the logon language.- Returns:
- Logon language
-
getGroup
Returns the GROUP.- Returns:
- group
-
setPassword
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
Sets the maximum number of concurrent RFC connections, allows null and empty string.- Parameters:
count
- Max rfc connection
-
setDirectConnection
Sets up a direct connection to the SAP system.- Parameters:
ashost
- Name of the application server host ornull
if not usedsysNr
- Systm number 0-99 or-1
if not usedsid
- System ID ornull
if not usedrouter
- SAP router String ornull
if not used
-
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
Returns the system id of the SAP System.- Returns:
- SID
-
getSAPRouter
Returns the SAP router string.- Returns:
- SAP router string
-
isAllowSMSEInterface
public boolean isAllowSMSEInterface()Returnstrue
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
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
Sets the name of the UC4 user.- Parameters:
set
- the name of the UC4 user.
-
getUC4User
Returns the name of the UC4 user.- Returns:
- Name of the UC4 user.
-
setUC4Department
Sets the name of the UC4 department.- Parameters:
set
- the name of the UC4 department.
-
getUC4Department
Returns the name of the UC4 department.- Returns:
- Name of the UC4 department.
-
setUC4Password
Sets the UC4 password.- Parameters:
set
- the UC4 password.
-
setGatewayHost
Sets the gateway host.- Parameters:
set
- the gateway host.
-
getGatewayHost
Returns the Gateway Host.- Returns:
- Gateway Host.
-
setGatewayService
Sets the gateway service.- Parameters:
set
- the gateway service.
-
getGatewayService
Returns the Gateway Service.- Returns:
- Gateway Service.
-
setProgramId
Sets the program id.- Parameters:
set
- the program id.
-
getProgramId
Returns the program id- Returns:
- program id.
-
setDestination
Sets the Destination.- Parameters:
set
- the Destination.
-
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 ornull
if not usedmessageServer
- Host name of the message server ornull
if not usedgroup
- Group name ornull
if not usedrouter
- SAP router String ornull
if not used
-
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 DocumentobjectElement
- Parent element
-