Package com.uc4.api.objects

Class AttributesJMX

  • All Implemented Interfaces:
    IHostAttributes
    public class AttributesJMX
extends java.lang.Object
implements IHostAttributes
    Host attributes for JMX Jobs.

    • Constructor Summary

      Constructors 
      Constructor Description
      AttributesJMX()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int fieldCount()
      Returns the number of fields in the host attributes.
      java.lang.String getAgentID()
      Returns the agent ID.
      java.lang.String getInitialContextFactory()
      Returns the initial context factory.
      java.lang.String getJndiName()
      Returns the JNDI Name.
      java.lang.String getServerURL()
      Returns the JMX URL of the remote MBean Server.
      boolean isAgentLog()  
      boolean isLocalJVM()
      Returns true if an MBean Server in the local JVM is used.
      boolean isMbeanServerCreate()
      Returns true if an MBean Server is created if it's not found.
      boolean isRemoteJVM()
      Returns true if an MBean Server in the remote JVM is used.
      boolean isReportDatabase()
      Returns whether the Job report transfered to the Automation Engine database.
      boolean isReportErrorOnly()
      Returns true if the Job report will be stored only in case of Job interruption.
      boolean isReportFile()
      Returns true if the Job report is stored in the file system on the target system.
      boolean isUseAnyMBeanServer()
      Returns true if any local MBean Server is used.
      boolean isUseJDNI()
      Returns true if JNDI is used to get a reference to the MBean Server.
      boolean isUseSpecificMBeanServer()
      Returns true if an MBean Server with the specified agent ID is used.
      void load​(com.uc4.util.XMLDocument doc, org.w3c.dom.Element hostAttr, ConnectionAttributes info)
      Loads the host attributes.
      java.lang.String name()
      Returns the host attributes name.
      void setAgentID​(java.lang.String agentID)
      Sets the agent ID.
      void setAgentLog​(boolean agentLog)
      Sets the Agent Process Log for this SAP Job.
      void setInitialContextFactory​(java.lang.String initialContextFactory)
      Sets the initial context factory.
      void setJndiName​(java.lang.String jndiName)
      Sets the JNDI name.
      void setLocalJVM()
      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 setRemoteJVM()
      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​(java.lang.String serverURL)
      Sets the JMX URL of the remote MBean Server.
      void setUseAnyMBeanServer()
      Uses any local MBean Server.
      void setUseJDNI()
      Uses JDNI to get a reference to the MBean Server.
      void setUseSpecificMBeanServer()
      An MBean Server with the specified agent ID is used.
      void store​(com.uc4.util.XMLDocument doc, org.w3c.dom.Element objectElement, ConnectionAttributes info)
      Writes the host attributes back to the XMLDocument.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • AttributesJMX

        public AttributesJMX()

    • Method Detail

      • load

        public void load​(com.uc4.util.XMLDocument doc,
                 org.w3c.dom.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,
                  org.w3c.dom.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 java.lang.String getInitialContextFactory()
        Returns the initial context factory.
        Returns:
        initial context factory

      • setInitialContextFactory

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

      • getServerURL

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

      • setServerURL

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

      • getAgentID

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

      • setAgentID

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

      • getJndiName

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

      • setJndiName

        public void setJndiName​(java.lang.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 java.lang.String name()
        Description copied from interface: IHostAttributes
        Returns the host attributes name.
        Specified by:
        name in interface IHostAttributes
        Returns:
        name