org.sblim.wbem.cim

Class CIMNameSpace

Implemented Interfaces:
Cloneable, Serializable

public class CIMNameSpace
extends java.lang.Object
implements Serializable, Cloneable

CIMNameSpace.java (C) Copyright IBM Corp. 2005, 2009 THIS FILE IS PROVIDED UNDER THE TERMS OF THE ECLIPSE PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THIS FILE CONSTITUTES RECIPIENTS ACCEPTANCE OF THE AGREEMENT. You can obtain a current copy of the Eclipse Public License from http://www.opensource.org/licenses/eclipse-1.0.php

Field Summary

static char
NAMESPACE_SEPARATOR

Constructor Summary

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

Method Summary

Object
clone()
boolean
equals(Object o)
String
getHost()
Returns the hostname of the CIMNameSpace
URI
getHostURI()
Returns the URI representation of the CIMNameSpace.
URL
getHostURL()
Returns the URL representation of the CIMNameSpace.
String
getNameSpace()
Returns the namespace fragment of the CIMNameSpace.
int
getPort()
Returns the port defined for this namespace by the URI.
String
getScheme()
Returns the scheme specified on the URI.
int
hashCode()
static CIMNameSpace
parse(String pURI)
Deprecated. The CIMNameSpace(String) constructor must be used instead of this method.
void
setHost(String pHost)
Specifies the host for this CIMNameSpace object.
void
setNameSpace(String pNamespace)
Specifies the namespace for this CIMNameSpace object.
void
setPort(int pPort)
Specifies the port for this CIMNameSpace object.
String
toString()

Field Details

NAMESPACE_SEPARATOR

public static final char NAMESPACE_SEPARATOR
Field Value:
'/'

Constructor Details

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(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(String pHost,
                    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:
CIMException - CIM_ERR_INVALID_PARAMETER - if the URI is malformed

Method Details

clone

public Object clone()

equals

public boolean equals(Object o)

getHost

public String getHost()
Returns the hostname of the CIMNameSpace
Returns:
a string which represents the hostname of the NameSpace

getHostURI

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

getHostURL

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

getNameSpace

public 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

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

getScheme

public String getScheme()
Returns the scheme specified on the URI.
Returns:
The scheme

hashCode

public int hashCode()

parse

public static CIMNameSpace parse(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 -

setHost

public void setHost(String pHost)
Specifies the host for this CIMNameSpace object.
Parameters:
pHost -

setNameSpace

public void setNameSpace(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 -

setPort

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

toString

public String toString()

Copyright © 2005, 2009 IBM Corporation. All Rights Reserved.