public class SAPConnectionRFC
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
static class |
SAPConnectionRFC.BIExtendedMonitoring
SAP BW Extended Monitoring.
|
static class |
SAPConnectionRFC.XALVersion
XAL version.
|
static class |
SAPConnectionRFC.XBPVersion
XBP version.
|
Modifier | Constructor and Description |
---|---|
protected |
SAPConnectionRFC(com.uc4.util.XMLDocument doc,
ConnectionAttributes session)
Creates a new
SAPConnectionRFC from the specified XML document. |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAsHost()
Returns the application server if a direct connection has been used.
|
SAPConnectionRFC.BIExtendedMonitoring |
getBIExtendedMonitoring()
Returns the status of the extended monitoring of Info Packages.
|
int |
getBIRepeatChecks()
Returns the number of checks repeated status checks if the extended
Info Package monitoring has been set to REPEAT_CHECK.
|
int |
getBIRepeatDataRequestChecks()
Returns the number of runs for data request checks
|
int |
getClient()
Returns the SAP client.
|
java.lang.String |
getDestination()
Returns the Destination
|
java.lang.String |
getGatewayHost()
Returns the Gateway Host.
|
java.lang.String |
getGatewayService()
Returns the Gateway Service.
|
java.lang.String |
getGroup()
Returns the GROUP.
|
int |
getIPakChange()
Returns the IPak Change parameter.
|
java.lang.String |
getLanguage()
Returns the logon language.
|
UC4ObjectName |
getLogin()
Returns the Login
|
int |
getMaxConnectionCount()
Returns the maximum number of concurrent RFC connections to the SAP system.
|
java.lang.String |
getMessageServer()
Returns the Message Server.
|
java.lang.String |
getProgramId()
Returns the program id
|
java.lang.String |
getSAPRouter()
Returns the SAP router string.
|
java.lang.String |
getSID()
Returns the system id of the SAP System.
|
java.lang.String |
getSNCLib()
Returns the SNC library.
|
java.lang.String |
getSNCMyName()
Returns the SNC "MyName" value.
|
java.lang.String |
getSNCPartnerName()
Returns the SNC Partner name.
|
int |
getSNCQOP()
Returns the QOP value for the SNC encryption.
|
int |
getSpoolBlocksize()
Returns the blocksize for the transfer of spool lists.
|
int |
getSystemNumber()
Returns the system number or
-1 if not set. |
int |
getUC4Client()
Returns the SAP client.
|
java.lang.String |
getUC4Department()
Returns the name of the UC4 department.
|
java.lang.String |
getUC4User()
Returns the name of the UC4 user.
|
java.lang.String |
getUser()
Returns the name of the batch user.
|
java.lang.String |
getXALMonitor()
Returns the name of the monitor.
|
java.lang.String |
getXALMonitorSet()
Returns the name of the monitor set.
|
java.lang.String |
getXALMonitorShortName()
Returns the short name of the XAL monitor.
|
SAPConnectionRFC.XALVersion |
getXALVersion()
Returns the XAL Version, DEFAULT if not set.
|
int |
getXBPAuditlevel()
Returns the XBP auditlevel (0= Minimal, 3= Trace)
Depending on the auditlevel the XMI log will contain more or less entries.
|
SAPConnectionRFC.XBPVersion |
getXBPVersion()
Returns the XBP Version.
|
boolean |
isAllowSMSEInterface()
Returns
true if the SMSE function modules should be used. |
boolean |
isAllowUc4Interface()
Returns
true if the uc4 function modules should be used. |
boolean |
isBIChainsParallel()
Returns
true if process chains can be executed in parallel. |
boolean |
isCollapseSteps()
Return if one SAP job can contain multiple steps.
|
boolean |
isConfirmEventHistory()
Return if events in the history should be confirmed after processed by the agent
|
boolean |
isSNCEnabled()
Returns
true if SNC is enabled, false otherwise. |
boolean |
isSSOEnabled()
Returns
true if SNC SSO is enabled, false otherwise. |
boolean |
isUseLoadBalancing() |
boolean |
isXALSystemLog()
Returns
true 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 |
setBIExtendedMonitoring(SAPConnectionRFC.BIExtendedMonitoring ext)
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(java.lang.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 |
setBIRepeatDataRequestChecks(java.lang.String runs)
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 agent
|
void |
setDestination(java.lang.String set)
Sets the Destination.
|
void |
setDirectConnection(java.lang.String ashost,
int sysNr,
java.lang.String sid,
java.lang.String router)
Sets up a direct connection to the SAP system.
|
void |
setGatewayHost(java.lang.String set)
Sets the gateway host.
|
void |
setGatewayService(java.lang.String set)
Sets the gateway service.
|
void |
setIPakChange(int change)
Sets the value of the IPak Change parameter.
|
void |
setLanguage(java.lang.String lang)
Sets the logon language (for example DE or EN) or
null if not used |
void |
setLoadBalancedConnection(java.lang.String sid,
java.lang.String messageServer,
java.lang.String group,
java.lang.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(java.lang.String count)
Sets the maximum number of concurrent RFC connections, allows null and
empty string.
|
void |
setPassword(java.lang.String pass)
Sets the password of the logon user.
|
void |
setProgramId(java.lang.String set)
Sets the program id.
|
void |
setSNCEnable(boolean enable)
Enables or disables the SNC mode.
|
void |
setSNCLib(java.lang.String lib)
Sets the path to the SNC library.
|
void |
setSNCMyName(java.lang.String myName)
Sets the SNC "MyName" value.
|
void |
setSNCPartnerName(java.lang.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(java.lang.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(java.lang.String client)
Sets the UC4 client, allows null and empty string
|
void |
setUC4Department(java.lang.String set)
Sets the name of the UC4 department.
|
void |
setUC4Password(java.lang.String set)
Sets the UC4 password.
|
void |
setUC4User(java.lang.String set)
Sets the name of the UC4 user.
|
void |
setUser(java.lang.String user)
Sets the user name for the batch user.
|
void |
setXALMonitor(java.lang.String monitor)
Sets the name of the XAL monitor.
|
void |
setXALMonitorSet(java.lang.String set)
Sets the name of the XAL monitor set.
|
void |
setXALMonitorShortName(java.lang.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,
org.w3c.dom.Element objectElement,
ConnectionAttributes session,
java.lang.String ocvType)
Saves the content of this instance in the specified DOM document
|
protected SAPConnectionRFC(com.uc4.util.XMLDocument doc, ConnectionAttributes session)
SAPConnectionRFC
from the specified XML document.doc
- XML documentpublic void setBIChainsParallel(boolean par)
par
- true if BI chains are allowed to run in parallelpublic void setSNCEnable(boolean enable)
enable
- true if SNC should be enabled, false if it should be disabled.public boolean isSNCEnabled()
true
if SNC is enabled, false otherwise.
If the vlaue has not been set yet, false
is returned.public void setSSOEnable(boolean enable)
enable
- true if SNC SSO should be enabled, false if it should be disabled.public boolean isSSOEnabled()
true
if SNC SSO is enabled, false otherwise.
If the value has not been set yet, false
is returned.public void setSNCLib(java.lang.String lib)
lib
- SNC librarypublic java.lang.String getSNCLib()
public void setLogin(UC4ObjectName login)
login
- the new login or null
if not usedpublic UC4ObjectName getLogin()
null
if not setpublic void setSpoolBlocksize(int kilobytes)
kilobytes
- Block size in kilobytespublic void setSpoolBlocksize(java.lang.String kilobytes)
kilobytes
- kilobytes Block size in kilobytespublic int getSpoolBlocksize()
public void setSNCMyName(java.lang.String myName)
myName
- My namepublic java.lang.String getSNCMyName()
public void setSNCPartnerName(java.lang.String partnerName)
partnerName
- namepublic java.lang.String getSNCPartnerName()
public void setSNCQOP(int qop)
qop
- Integer between one and ninepublic int getSNCQOP()
public void setBIRepeatChecks(int runs)
runs
- Number of checkspublic void setBIRepeatChecks(java.lang.String runs)
runs
- runs Number of checkspublic int getBIRepeatChecks()
public void setBIExtendedMonitoring(SAPConnectionRFC.BIExtendedMonitoring ext)
ext
- Enumeration containing the extended monitoringpublic int getBIRepeatDataRequestChecks()
public void setBIRepeatDataRequestChecks(int runs)
runs
- Number of runspublic void setBIRepeatDataRequestChecks(java.lang.String runs)
runs
- runs Number of runspublic SAPConnectionRFC.BIExtendedMonitoring getBIExtendedMonitoring()
public boolean isBIChainsParallel()
true
if process chains can be executed in parallel.public void setXBPAuditlevel(int level)
level
- Audit levelpublic void setIPakChange(int change)
change
- IPak changepublic int getIPakChange()
public void setXALVersion(SAPConnectionRFC.XALVersion version)
version
- XAL versionpublic void setXALSystemLog(boolean enable)
false
if no value has been set yet.enable
- true if the log should be transfered in case of an error, false otherwisepublic void setXALMonitor(java.lang.String monitor)
monitor
- Name of the XAL monitorpublic java.lang.String getXALMonitor()
public void setXALMonitorSet(java.lang.String set)
set
- the name of the monitor set.public java.lang.String getXALMonitorSet()
public void setXALMonitorShortName(java.lang.String name)
name
- Short name of the XAL Monitorpublic java.lang.String getXALMonitorShortName()
public boolean isXALSystemLog()
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.public SAPConnectionRFC.XALVersion getXALVersion()
public int getXBPAuditlevel()
public boolean isCollapseSteps()
public void setCollapseSteps(boolean collapse)
collapse
- if true one SAP job can contain more than one step, if false each
created SAP Job will only have one steppublic boolean isConfirmEventHistory()
public void setConfirmEventHistory(boolean confirm)
confirm
- true if events in the history should be confirmed, false if not (events then always get status "new")public boolean isAllowUc4Interface()
true
if the uc4 function modules should be used.
If the value has not been set yet, false
is returned.public void setAllowUc4Interface(boolean allow)
allow
- true if the uc4 function modules should be used, false if only XBP function modules should
be calledpublic SAPConnectionRFC.XBPVersion getXBPVersion()
public void setXBPVersion(SAPConnectionRFC.XBPVersion version)
version
- XBP Versionpublic void setUser(java.lang.String user)
user
- User namepublic java.lang.String getUser()
public void setClient(int client)
client
- Integer between 0 and 999 or -1
if not usedpublic int getClient()
-1
if not setpublic void setLanguage(java.lang.String lang)
null
if not usedlang
- Languagepublic java.lang.String getLanguage()
public java.lang.String getGroup()
public void setPassword(java.lang.String pass)
pass
- Passwordpublic int getMaxConnectionCount()
-1
if not setpublic void setMaxConnectionCount(int count)
count
- Max rfc connectionpublic void setMaxConnectionCount(java.lang.String count)
count
- Max rfc connectionpublic void setDirectConnection(java.lang.String ashost, int sysNr, java.lang.String sid, java.lang.String router)
ashost
- Name of the application server host or null
if not usedsysNr
- Systm number 0-99 or -1
if not usedsid
- System ID or null
if not usedrouter
- SAP router String or null
if not usedpublic java.lang.String getAsHost()
public int getSystemNumber()
-1
if not set.public java.lang.String getSID()
public java.lang.String getSAPRouter()
public boolean isAllowSMSEInterface()
true
if the SMSE function modules should be used.
If the value has not been set yet, false
is returned.public void setAllowSMSEInterface(boolean allow)
allow
- true if the SMSE function modules should be usedpublic void setUC4Client(int client)
client
- Integer between 0 and 9999 or -1
if not usedpublic void setUC4Client(java.lang.String client)
client
- Integer between 0 and 9999 or -1
if not usedpublic int getUC4Client()
-1
if not setpublic void setUC4User(java.lang.String set)
set
- the name of the UC4 user.public java.lang.String getUC4User()
public void setUC4Department(java.lang.String set)
set
- the name of the UC4 department.public java.lang.String getUC4Department()
public void setUC4Password(java.lang.String set)
set
- the UC4 password.public void setGatewayHost(java.lang.String set)
set
- the gateway host.public java.lang.String getGatewayHost()
public void setGatewayService(java.lang.String set)
set
- the gateway service.public java.lang.String getGatewayService()
public void setProgramId(java.lang.String set)
set
- the program id.public java.lang.String getProgramId()
public void setDestination(java.lang.String set)
set
- the Destination.public java.lang.String getDestination()
public void setLoadBalancedConnection(java.lang.String sid, java.lang.String messageServer, java.lang.String group, java.lang.String router)
sid
- SID or null
if not usedmessageServer
- Host name of the message server or null
if not usedgroup
- Group name or null
if not usedrouter
- SAP router String or null
if not usedpublic java.lang.String getMessageServer()
public boolean isUseLoadBalancing()
true
if load balancing is set, false otherwiseprotected void store(com.uc4.util.XMLDocument doc, org.w3c.dom.Element objectElement, ConnectionAttributes session, java.lang.String ocvType)
doc
- XML DocumentobjectElement
- Parent element