Class CIMNameSpace

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable

    public class CIMNameSpace
    extends java.lang.Object
    implements java.io.Serializable, java.lang.Cloneable
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      CIMNameSpace()
      Constructs and instantiates a default CIM namespace name.
      CIMNameSpace​(java.lang.String pURI)
      Constructs a CIM namespace, pointing to a specified host or URI (protocol://hostname[:port]/file), i.e.
      CIMNameSpace​(java.lang.String pHost, java.lang.String pNamespace)
      Constructs an object which represents a CIMNameSpace.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      java.lang.Object clone()  
      boolean equals​(java.lang.Object o)  
      java.lang.String getHost()
      Returns the hostname of the CIMNameSpace
      java.net.URI getHostURI()
      Returns the URI representation of the CIMNameSpace.
      java.net.URL getHostURL()
      Returns the URL representation of the CIMNameSpace.
      java.lang.String getNameSpace()
      Returns the namespace fragment of the CIMNameSpace.
      int getPort()
      Returns the port defined for this namespace by the URI.
      java.lang.String getScheme()
      Returns the scheme specified on the URI.
      int hashCode()  
      static CIMNameSpace parse​(java.lang.String pURI)
      Deprecated.
      The CIMNameSpace(String) constructor must be used instead of this method.
      void setHost​(java.lang.String pHost)
      Specifies the host for this CIMNameSpace object.
      void setNameSpace​(java.lang.String pNamespace)
      Specifies the namespace for this CIMNameSpace object.
      void setPort​(int pPort)
      Specifies the port for this CIMNameSpace object.
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • CIMNameSpace

        public CIMNameSpace()
                     throws CIMException
        Constructs and instantiates a default CIM namespace name.
        Throws:
        CIMException - CIM_ERR_FAILED - if a malformed URL is constructed from the specified parameters
      • CIMNameSpace

        public CIMNameSpace​(java.lang.String pURI)
                     throws CIMException
        Constructs a CIM namespace, pointing to a specified host or URI (protocol://hostname[:port]/file), i.e. "https://47.11.8.15:5989/root/cimv2"
        Parameters:
        pURI - The URI String
        Throws:
        CIMException
      • CIMNameSpace

        public CIMNameSpace​(java.lang.String pHost,
                            java.lang.String pNamespace)
                     throws CIMException
        Constructs an object which represents a CIMNameSpace.
        Parameters:
        pHost - host= protocol://hostname[:port]/file host= "https://myhostname/" host= "http://myhostname:5988/cimom" host= "myhostname"
        pNamespace - a string which represents the namespace in the CIM Object Manager. According to the spec it should not starts or ends with '/'. This are examples of valid namespace. namespace= "root/cimv2" namespace= "root"
        Throws:
        java.lang.IllegalArgumentException - if the
        CIMException - CIM_ERR_INVALID_PARAMETER - if the URI is malformed
    • Method Detail

      • clone

        public java.lang.Object clone()
        Overrides:
        clone in class java.lang.Object
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • getHost

        public java.lang.String getHost()
        Returns the hostname of the CIMNameSpace
        Returns:
        a string which represents the hostname of the NameSpace
      • getHostURI

        public java.net.URI getHostURI()
                                throws CIMException
        Returns the URI representation of the CIMNameSpace.
        Returns:
        The URI
        Throws:
        CIMException - malformed URI exception
      • getHostURL

        public java.net.URL getHostURL()
                                throws CIMException
        Returns the URL representation of the CIMNameSpace.
        Returns:
        The URL
        Throws:
        CIMException - malformed URL exception
        See Also:
        URI.toURL()
      • getNameSpace

        public java.lang.String getNameSpace()
        Returns the namespace fragment of the CIMNameSpace. This fragment does not include any information related to a host. (i.e. "myhost:root/cimv2", this method return just the "root/cimv2"
        Returns:
        The namespace
      • getScheme

        public java.lang.String getScheme()
        Returns the scheme specified on the URI.
        Returns:
        The scheme
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • parse

        public static CIMNameSpace parse​(java.lang.String pURI)
                                  throws CIMException
        Deprecated.
        The CIMNameSpace(String) constructor must be used instead of this method.
        Creates a CIMNameSpace object from the specified URI. This method behaves as new CIMNameSpace(p).
        Parameters:
        pURI - The URI string
        Returns:
        The namespace
        Throws:
        CIMException
      • setPort

        public void setPort​(int pPort)
        Specifies the port for this CIMNameSpace object.
        Parameters:
        pPort -
      • getPort

        public int getPort()
        Returns the port defined for this namespace by the URI. If no port is defined, then the default port is used.
        Returns:
        The port
      • setHost

        public void setHost​(java.lang.String pHost)
        Specifies the host for this CIMNameSpace object.
        Parameters:
        pHost -
      • setNameSpace

        public void setNameSpace​(java.lang.String pNamespace)
                          throws CIMException
        Specifies the namespace for this CIMNameSpace object. The namespace should not start or end with a '/', it will be automatically removed. As a result a namespace like "/root/cimv2", will result on "root/cimv2", and "/" would be translated into an empty namespace ("")
        Parameters:
        pNamespace - The namespace
        Throws:
        CIMException
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object