Package com.uc4.api.objects
Class AttributesJMX
java.lang.Object
com.uc4.api.objects.AttributesJMX
- All Implemented Interfaces:
IHostAttributes
Host attributes for JMX Jobs.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
Returns the number of fields in the host attributes.Returns the agent ID.Returns the initial context factory.Returns the JNDI Name.Returns the JMX URL of the remote MBean Server.boolean
boolean
Returnstrue
if an MBean Server in the local JVM is used.boolean
Returnstrue
if an MBean Server is created if it's not found.boolean
Returnstrue
if an MBean Server in the remote JVM is used.boolean
Returns whether the Job report transfered to the Automation Engine database.boolean
Returnstrue
if the Job report will be stored only in case of Job interruption.boolean
Returnstrue
if the Job report is stored in the file system on the target system.boolean
Returnstrue
if any local MBean Server is used.boolean
Returnstrue
if JNDI is used to get a reference to the MBean Server.boolean
Returnstrue
if an MBean Server with the specified agent ID is used.void
load
(com.uc4.util.XMLDocument doc, Element hostAttr, ConnectionAttributes info) Loads the host attributes.name()
Returns the host attributes name.void
setAgentID
(String agentID) Sets the agent ID.void
setAgentLog
(boolean agentLog) Sets the Agent Process Log for this SAP Job.void
setInitialContextFactory
(String initialContextFactory) Sets the initial context factory.void
setJndiName
(String jndiName) Sets the JNDI name.void
Uses an MBean Server in the local Java Virtual Machine.void
setMbeanServerCreate
(boolean mbeanServerCreate) Sets whether an MBean Server should be created if it does not exist.void
Uses an MBean Server in a remote JVM.void
setReportDatabase
(boolean reportDatabase) Sets whether the Job report should be transfered to the database.void
setReportErrorOnly
(boolean reportErrorOnly) Sets whether the Job report should be stored only in case of Job interruption.void
setReportFile
(boolean reportFile) Sets whether the Job report should be stored in the file system on the target system.void
setServerURL
(String serverURL) Sets the JMX URL of the remote MBean Server.void
Uses any local MBean Server.void
Uses JDNI to get a reference to the MBean Server.void
An MBean Server with the specified agent ID is used.void
store
(com.uc4.util.XMLDocument doc, Element objectElement, ConnectionAttributes info) Writes the host attributes back to theXMLDocument
.
-
Constructor Details
-
AttributesJMX
public AttributesJMX()
-
-
Method Details
-
load
Description copied from interface:IHostAttributes
Loads the host attributes.- Specified by:
load
in interfaceIHostAttributes
- Parameters:
doc
- XML Document containing the JobhostAttr
- Element which contains host attributesinfo
- Session details
-
store
Description copied from interface:IHostAttributes
Writes the host attributes back to theXMLDocument
.- Specified by:
store
in interfaceIHostAttributes
- Parameters:
doc
- DocumentobjectElement
- ObjectElementinfo
- Session details
-
isAgentLog
public boolean isAgentLog()- Returns:
- True if the Agent Process Log should be transfered
-
setAgentLog
public void setAgentLog(boolean agentLog) Sets the Agent Process Log for this SAP Job.- Parameters:
agentLog
- true if the Log should be transfered
-
isReportDatabase
public boolean isReportDatabase()Returns whether the Job report transfered to the Automation Engine database.- Returns:
true
if the Job report is transfered to the databasefalse
otherwise
-
setReportDatabase
public void setReportDatabase(boolean reportDatabase) Sets whether the Job report should be transfered to the database.- Parameters:
reportDatabase
-true
if the job report should be transfered to the databasefalse
otherwise
-
isReportErrorOnly
public boolean isReportErrorOnly()Returnstrue
if the Job report will be stored only in case of Job interruption. This function is only available when "Database" and/or "File" have been selected.- Returns:
true
if the job report is stored only in case of Job interruption
-
setReportErrorOnly
public void setReportErrorOnly(boolean reportErrorOnly) Sets whether the Job report should be stored only in case of Job interruption. This function is only available when "Database" and/or "File" have been selected.- Parameters:
reportErrorOnly
-true
if the job report should be stored only in case of Job interruption
-
isReportFile
public boolean isReportFile()Returnstrue
if the Job report is stored in the file system on the target system.- Returns:
true
if the job report is stored in the file system.
-
setReportFile
public void setReportFile(boolean reportFile) Sets whether the Job report should be stored in the file system on the target system.- Parameters:
reportFile
-true
if the job report should be stored in the file system
-
setLocalJVM
public void setLocalJVM()Uses an MBean Server in the local Java Virtual Machine. -
isLocalJVM
public boolean isLocalJVM()Returnstrue
if an MBean Server in the local JVM is used.- Returns:
- Uses local JVM
-
setRemoteJVM
public void setRemoteJVM()Uses an MBean Server in a remote JVM. -
isRemoteJVM
public boolean isRemoteJVM()Returnstrue
if an MBean Server in the remote JVM is used.- Returns:
- Uses remote JVM
-
getInitialContextFactory
Returns the initial context factory.- Returns:
- initial context factory
-
setInitialContextFactory
Sets the initial context factory.- Parameters:
initialContextFactory
- initial context factory
-
getServerURL
Returns the JMX URL of the remote MBean Server.- Returns:
- Server URL
-
setServerURL
Sets the JMX URL of the remote MBean Server.- Parameters:
serverURL
- JMX URL
-
getAgentID
Returns the agent ID.- Returns:
- agent ID
-
setAgentID
Sets the agent ID.- Parameters:
agentID
- agent ID
-
getJndiName
Returns the JNDI Name.- Returns:
- JDNI Name
-
setJndiName
Sets the JNDI name.- Parameters:
jndiName
- JNDI name
-
isMbeanServerCreate
public boolean isMbeanServerCreate()Returnstrue
if an MBean Server is created if it's not found.- Returns:
- create MBean server
-
setMbeanServerCreate
public void setMbeanServerCreate(boolean mbeanServerCreate) Sets whether an MBean Server should be created if it does not exist.- Parameters:
mbeanServerCreate
-true
if the MBean Server should be created
-
setUseAnyMBeanServer
public void setUseAnyMBeanServer()Uses any local MBean Server. -
isUseAnyMBeanServer
public boolean isUseAnyMBeanServer()Returnstrue
if any local MBean Server is used.- Returns:
- use any
-
setUseSpecificMBeanServer
public void setUseSpecificMBeanServer()An MBean Server with the specified agent ID is used. -
isUseSpecificMBeanServer
public boolean isUseSpecificMBeanServer()Returnstrue
if an MBean Server with the specified agent ID is used.- Returns:
- use specific MBean Server
-
setUseJDNI
public void setUseJDNI()Uses JDNI to get a reference to the MBean Server. -
isUseJDNI
public boolean isUseJDNI()Returnstrue
if JNDI is used to get a reference to the MBean Server.- Returns:
- use JNDI to get a MBean Server
-
fieldCount
public int fieldCount()Description copied from interface:IHostAttributes
Returns the number of fields in the host attributes.- Specified by:
fieldCount
in interfaceIHostAttributes
- Returns:
- number of fields
-
name
Description copied from interface:IHostAttributes
Returns the host attributes name.- Specified by:
name
in interfaceIHostAttributes
- Returns:
- name
-