Package org.opennms.netmgt.config.xmpConfig

Class XmpConfig

  • All Implemented Interfaces:
    java.io.Serializable
    public class XmpConfig
extends java.lang.Object
implements java.io.Serializable
    Top-level element for the xmp-config.xml configuration file.
    Version:
    $Revision$ $Date$
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      XmpConfig()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void deletePort()  
      void deleteRetry()  
      void deleteTimeout()  
      boolean equals​(java.lang.Object obj)
      Overrides the java.lang.Object.equals method.
      java.lang.String getAuthenUser()
      Returns the value of field 'authenUser'.
      int getPort()
      Returns the value of field 'port'.
      int getRetry()
      Returns the value of field 'retry'.
      int getTimeout()
      Returns the value of field 'timeout'.
      int hashCode()
      Overrides the java.lang.Object.hashCode method.
      boolean hasPort()
      Method hasPort.
      boolean hasRetry()
      Method hasRetry.
      boolean hasTimeout()
      Method hasTimeout.
      void setAuthenUser​(java.lang.String authenUser)
      Sets the value of field 'authenUser'.
      void setPort​(int port)
      Sets the value of field 'port'.
      void setRetry​(int retry)
      Sets the value of field 'retry'.
      void setTimeout​(int timeout)
      Sets the value of field 'timeout'.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • XmpConfig

        public XmpConfig()

    • Method Detail

      • deletePort

        public void deletePort()

      • deleteRetry

        public void deleteRetry()

      • deleteTimeout

        public void deleteTimeout()

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides the java.lang.Object.equals method.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        obj -
        Returns:
        true if the objects are equal.

      • getAuthenUser

        public java.lang.String getAuthenUser()
        Returns the value of field 'authenUser'. The field 'authenUser' has the following description: Default XMP user/profile
        Returns:
        the value of field 'AuthenUser'.

      • getPort

        public int getPort()
        Returns the value of field 'port'. The field 'port' has the following description: If set, overrides TCP port 5270 as the port where XMP documents (queries) are sent.
        Returns:
        the value of field 'Port'.

      • getRetry

        public int getRetry()
        Returns the value of field 'retry'. The field 'retry' has the following description: Default number of retries
        Returns:
        the value of field 'Retry'.

      • getTimeout

        public int getTimeout()
        Returns the value of field 'timeout'. The field 'timeout' has the following description: Default timeout (in milliseconds)
        Returns:
        the value of field 'Timeout'.

      • hasPort

        public boolean hasPort()
        Method hasPort.
        Returns:
        true if at least one Port has been added

      • hasRetry

        public boolean hasRetry()
        Method hasRetry.
        Returns:
        true if at least one Retry has been added

      • hasTimeout

        public boolean hasTimeout()
        Method hasTimeout.
        Returns:
        true if at least one Timeout has been added

      • hashCode

        public int hashCode()
        Overrides the java.lang.Object.hashCode method.

        The following steps came from Effective Java Programming Language Guide by Joshua Bloch, Chapter 3

        Overrides:
        hashCode in class java.lang.Object
        Returns:
        a hash code value for the object.

      • setAuthenUser

        public void setAuthenUser​(java.lang.String authenUser)
        Sets the value of field 'authenUser'. The field 'authenUser' has the following description: Default XMP user/profile
        Parameters:
        authenUser - the value of field 'authenUser'.

      • setPort

        public void setPort​(int port)
        Sets the value of field 'port'. The field 'port' has the following description: If set, overrides TCP port 5270 as the port where XMP documents (queries) are sent.
        Parameters:
        port - the value of field 'port'.

      • setRetry

        public void setRetry​(int retry)
        Sets the value of field 'retry'. The field 'retry' has the following description: Default number of retries
        Parameters:
        retry - the value of field 'retry'.

      • setTimeout

        public void setTimeout​(int timeout)
        Sets the value of field 'timeout'. The field 'timeout' has the following description: Default timeout (in milliseconds)
        Parameters:
        timeout - the value of field 'timeout'.