Package com.uc4.api.objects

Class AttributesJMX

java.lang.Object
com.uc4.api.objects.AttributesJMX
All Implemented Interfaces:
IHostAttributes
public class AttributesJMX extends Object implements IHostAttributes
Host attributes for JMX Jobs.

  • Constructor Details

    • AttributesJMX

      public AttributesJMX()

  • Method Details

    • load

      public void load(com.uc4.util.XMLDocument doc, Element hostAttr, ConnectionAttributes info)
      Description copied from interface: IHostAttributes
      Loads the host attributes.
      Specified by:
      load in interface IHostAttributes
      Parameters:
      doc - XML Document containing the Job
      hostAttr - Element which contains host attributes
      info - Session details

    • store

      public void store(com.uc4.util.XMLDocument doc, Element objectElement, ConnectionAttributes info)
      Description copied from interface: IHostAttributes
      Writes the host attributes back to the XMLDocument.
      Specified by:
      store in interface IHostAttributes
      Parameters:
      doc - Document
      objectElement - ObjectElement
      info - 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 database false 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 database false otherwise

    • isReportErrorOnly

      public boolean isReportErrorOnly()
      Returns true 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()
      Returns true 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()
      Returns true 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()
      Returns true if an MBean Server in the remote JVM is used.
      Returns:
      Uses remote JVM

    • getInitialContextFactory

      public String getInitialContextFactory()
      Returns the initial context factory.
      Returns:
      initial context factory

    • setInitialContextFactory

      public void setInitialContextFactory(String initialContextFactory)
      Sets the initial context factory.
      Parameters:
      initialContextFactory - initial context factory

    • getServerURL

      public String getServerURL()
      Returns the JMX URL of the remote MBean Server.
      Returns:
      Server URL

    • setServerURL

      public void setServerURL(String serverURL)
      Sets the JMX URL of the remote MBean Server.
      Parameters:
      serverURL - JMX URL

    • getAgentID

      public String getAgentID()
      Returns the agent ID.
      Returns:
      agent ID

    • setAgentID

      public void setAgentID(String agentID)
      Sets the agent ID.
      Parameters:
      agentID - agent ID

    • getJndiName

      public String getJndiName()
      Returns the JNDI Name.
      Returns:
      JDNI Name

    • setJndiName

      public void setJndiName(String jndiName)
      Sets the JNDI name.
      Parameters:
      jndiName - JNDI name

    • isMbeanServerCreate

      public boolean isMbeanServerCreate()
      Returns true 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()
      Returns true 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()
      Returns true 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()
      Returns true 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 interface IHostAttributes
      Returns:
      number of fields

    • name

      public String name()
      Description copied from interface: IHostAttributes
      Returns the host attributes name.
      Specified by:
      name in interface IHostAttributes
      Returns:
      name