Package com.uc4.api.objects

Class HostAttributes

  • public class HostAttributes
extends java.lang.Object
    This class represents the "Attributes" tab in HOST objects.

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected HostAttributes​(com.uc4.util.XMLDocument doc)  

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      java.lang.String getLicenseCategory()
      Deprecated.
      the license check has been removed in version 12.2 and higher
      java.lang.String getSmgrName()  
      java.lang.String getSmgrPhrase()
      Returns the Service Manager Phrase.
      int getSmgrPort()
      Returns the port of the Service Manager.
      java.lang.String getTrustedIPs()
      Returns a String containing all trusted IPs separated by semicolon.
      boolean isLinkToSmgr()
      Returns true if a link to the Service Manager has been enabled.
      void setLinkToSmgr​(boolean linkToSmgr)
      Enables or disables the link the Service Manager.
      void setSmgrName​(java.lang.String smgrName)
      Sets the name of the Service Manager.
      void setSmgrPhrase​(java.lang.String smgrPhrase)
      Sets the Service Manager Phrase.
      void setSmgrPort​(int smgrPort)
      Sets the Service Manager port.
      void setTrustedIPs​(java.lang.String trustedIPs)
      Sets a String containing all trusted IPs separated by semicolon.
      protected void store​(com.uc4.util.XMLDocument doc, org.w3c.dom.Element request)  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • HostAttributes

        protected HostAttributes​(com.uc4.util.XMLDocument doc)

    • Method Detail

      • getTrustedIPs

        public java.lang.String getTrustedIPs()
        Returns a String containing all trusted IPs separated by semicolon. If your UC4 system runs with encryption, you may specify IP addresses (separated by semicolons) from which the Agent accepts non-encrypted connections. Communication to UC4 components such as Job messenger, Event Monitors (BS2000, OS/390) or Output Collector (NSK) takes place without encryption. By default, the Agent accepts non-encrypted messages from the local host (127.0.0.1) and its own IP address. If Event Monitors on OS/390 are used in LPARs on different computers, the relevant IP addresses must be specified here. Releasing individual IP addresses is only reasonable if the Automation Engine shall generally reject login attempts of former Agent versions.
        Returns:
        String containing all trusted IPs separated by semicolon

      • setTrustedIPs

        public void setTrustedIPs​(java.lang.String trustedIPs)
        Sets a String containing all trusted IPs separated by semicolon. If your system runs with encryption, you may specify IP addresses (separated by semicolons) from which the Agent accepts non-encrypted connections. Communication to components such as Job messenger, Event Monitors (BS2000, OS/390) or Output Collector (NSK) takes place without encryption. By default, the Agent accepts non-encrypted messages from the local host (127.0.0.1) and its own IP address. If Event Monitors on OS/390 are used in LPARs on different computers, the relevant IP addresses must be specified here. Releasing individual IP addresses is only reasonable if the Automation Engine shall generally reject login attempts of former Agent versions.
        Parameters:
        trustedIPs - String containing all trusted IPs separated by semicolon

      • getSmgrPhrase

        public java.lang.String getSmgrPhrase()
        Returns the Service Manager Phrase.
        Returns:
        Service Manager Phrase

      • setSmgrPhrase

        public void setSmgrPhrase​(java.lang.String smgrPhrase)
        Sets the Service Manager Phrase. The Phrase is used for the Service Manager connection which is used to start Agents and Automation Engine processes.
        Parameters:
        smgrPhrase - Phrase, String with max. 25 characterers

      • getSmgrName

        public java.lang.String getSmgrName()
        Returns:
        Name of the Service Manager

      • setSmgrName

        public void setSmgrName​(java.lang.String smgrName)
        Sets the name of the Service Manager. The name is used for the Service Manager connection which is used to start Agents and Automation Engine processes.
        Parameters:
        smgrName - Name of the Service Manager

      • getSmgrPort

        public int getSmgrPort()
        Returns the port of the Service Manager.
        Returns:
        Port

      • setSmgrPort

        public void setSmgrPort​(int smgrPort)
        Sets the Service Manager port.
        Parameters:
        smgrPort - Port of the Service Manager

      • isLinkToSmgr

        public boolean isLinkToSmgr()
        Returns true if a link to the Service Manager has been enabled.
        Returns:
        true if the Agent is linked with a Service Manager

      • setLinkToSmgr

        public void setLinkToSmgr​(boolean linkToSmgr)
        Enables or disables the link the Service Manager.
        Parameters:
        linkToSmgr - true if the link should be enabled, false otherwise.

      • getLicenseCategory

        @Deprecated
public java.lang.String getLicenseCategory()
        Deprecated.
        the license check has been removed in version 12.2 and higher
        Returns the License Category that is to be used by the Agent.
        Returns:
        License category which is used for this HOST.

      • store

        protected void store​(com.uc4.util.XMLDocument doc,
                     org.w3c.dom.Element request)