org.sblim.wbem.cim

Class CIMException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.sblim.wbem.cim.CIMException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CIMAuthenticationException, CIMSecurityException, CIMTransportException

public class CIMException
extends java.lang.RuntimeException
implements java.io.Serializable

This class is the super class for classes used to describe exceptional CIM conditions. Standard status codes are marked starts with the CIM prefix as part of the status message. Extended status codes are start with the EXT_ prefix and must be added in classes extending the CIMException.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CIM_ERR_ACCESS_DENIED CIM Status Code value: Access to a CIM resource is not available, or the logon attempt to the CIM Server failed.
static java.lang.String	CIM_ERR_ALREADY_EXISTS CIM Status Code value: The CIM object (class or instance) already exists.
static java.lang.String	CIM_ERR_CLASS_HAS_CHILDREN CIM Status Code value: The CIM class has subclasses.
static java.lang.String	CIM_ERR_CLASS_HAS_INSTANCES CIM Status Code value: One or more instances of this CIM class exist.
static java.lang.String	CIM_ERR_FAILED CIM Status Code value: General error without more specific information.
static java.lang.String	CIM_ERR_INVALID_CLASS CIM Status Code value: The CIM class does not exist in the target CIM namespace.
static java.lang.String	CIM_ERR_INVALID_NAMESPACE CIM Status Code value: The target CIM namespace does not exist in the CIM Server.
static java.lang.String	CIM_ERR_INVALID_PARAMETER CIM Status Code value: One or more parameter values passed to the CIM method or Java method are not valid.
static java.lang.String	CIM_ERR_INVALID_QUERY CIM Status Code value: The query is not valid for the specified query language.
static java.lang.String	CIM_ERR_INVALID_SUPERCLASS CIM Status Code value: The CIM superclass does not exist.
static java.lang.String	CIM_ERR_LOW_ON_MEMORY Origin: Not clear.
static java.lang.String	CIM_ERR_METHOD_NOT_AVAILABLE CIM Status Code value: The CIM method is not supported by the CIM Provider for the class.
static java.lang.String	CIM_ERR_METHOD_NOT_FOUND CIM Status Code value: The CIM method is not defined on the class.
static java.lang.String	CIM_ERR_NO_SUCH_PROPERTY CIM Status Code value: The CIM property is not defined on the class.
static java.lang.String	CIM_ERR_NOT_FOUND CIM Status Code value: For CIM Server/Provider originated errors, the CIM object (instance or class) does not exist in the target CIM namespace.
static java.lang.String	CIM_ERR_NOT_IMPLEMENTED Origin: Not clear.
static java.lang.String	CIM_ERR_NOT_SUPPORTED CIM Status Code value: The CIM operation is not supported by the CIM Server/Provider.
static java.lang.String	CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED CIM Status Code value: The query language is not recognized or supported.
static java.lang.String	CIM_ERR_TYPE_MISMATCH CIM Status Code value: The value supplied is not compatible with the CIM type.
protected static java.lang.String[]	CIM_ERROR_NAMES
static java.lang.String	IBM_ERR_TIMED_OUT Origin: Not clear.
static java.lang.String	IBM_ERR_VER_ERROR Origin: Not clear.

Constructor Summary

Constructors

Constructor and Description
CIMException() Constructs a CIMException with no detail message.
CIMException(java.lang.String pReason) Constructs a CIMException with the specified message.
CIMException(java.lang.String pReason, java.lang.Object pExtendedReason) Constructs a CIMException with the specified message and one extended reason parameter.
CIMException(java.lang.String pReason, java.lang.Object[] pExtendedReason) Constructs a CIMException with the specified message and one extended reason parameter.
CIMException(java.lang.String pReason, java.lang.Object pExtendedReason1, java.lang.Object pExtendedReason2) Constructs a CIMException with the specified message and one extended reason parameter.
CIMException(java.lang.String pReason, java.lang.Object pExtendedReason1, java.lang.Object pExtendedReason2, java.lang.Object pExtendedReason3) Constructs a CIMException with the specified message and one extended reason parameter.
CIMException(java.lang.String pReason, java.lang.Throwable pThrowable) Constructs a CIMException with the specified message and one extended reason parameter.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.Throwable	getCause() Gets the thowable object which causes this exception.
java.lang.String	getDescription() Returns a description for this exception.
java.lang.String	getID() Gets the reason for this exception.
java.lang.String	getMessage() Gets the message associated to this exception.
java.lang.Object[]	getParams() Gets the extended reason for this exception.
int	getStatusCode() Returns the status code that may be returned by a conforming CIM Server application as the value of the CODE attribute of an subelement within a or .
static int	getStatusCode(java.lang.String pMessage) Returns the status code that may be returned by a conforming CIM Server application as the value of the CODE attribute of an subelement within a or .
static java.lang.String	getStatusFromCode(int i) Returns the string representation of the status code.
int	hashCode()
java.lang.Throwable	initCause(java.lang.Throwable pCause)
void	setDescription(java.lang.String pDescription) Sets a description for this exception.
void	setParams(java.lang.Object[] pReason) Specifies the extended reason for this exception.
java.lang.String	toString()

Methods inherited from class java.lang.Throwable

fillInStackTrace, getLocalizedMessage, getStackTrace, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Field Detail

CIM_ERR_FAILED

public static final java.lang.String CIM_ERR_FAILED

CIM Status Code value: General error without more specific information. Origin: CIM Server/Provider as well as CIM Client code. TODO Docu: How are description and extendedReason used ? TODO Can we change creaiton of exceptions with this status code in the CIM Client code so they use some other code ?

See Also:

Constant Field Values

CIM_ERR_ACCESS_DENIED

public static final java.lang.String CIM_ERR_ACCESS_DENIED

CIM Status Code value: Access to a CIM resource is not available, or the logon attempt to the CIM Server failed. Origin: CIM Server/Provider only. TODO Docu: How are description and extendedReason used ?

See Also:

Constant Field Values

CIM_ERR_INVALID_NAMESPACE

public static final java.lang.String CIM_ERR_INVALID_NAMESPACE

CIM Status Code value: The target CIM namespace does not exist in the CIM Server. Origin: CIM Server/Provider only. TODO Docu: How are description and extendedReason used ?

See Also:

Constant Field Values

CIM_ERR_INVALID_PARAMETER

public static final java.lang.String CIM_ERR_INVALID_PARAMETER

CIM Status Code value: One or more parameter values passed to the CIM method or Java method are not valid. This includes cases of missing, duplicate, unrecognized or otherwise incorrect parameters. The description mentions in free form text which parameter is invalid for what reason. Origin: CIM Server/Provider as well as CIM Client code. TODO Docu: How is extendedReason used ? TODO Can we change creaiton of exceptions with this status code in the CIM Client code so they use some other code ?

See Also:

Constant Field Values

CIM_ERR_INVALID_CLASS

public static final java.lang.String CIM_ERR_INVALID_CLASS

CIM Status Code value: The CIM class does not exist in the target CIM namespace. Origin: CIM Server/Provider only. TODO Docu: How are description and extendedReason used ?

See Also:

Constant Field Values

CIM_ERR_NOT_FOUND

public static final java.lang.String CIM_ERR_NOT_FOUND

CIM Status Code value: For CIM Server/Provider originated errors, the CIM object (instance or class) does not exist in the target CIM namespace. For CIM Client originated errors, something has not been found. Origin: CIM Server/Provider as well as CIM Client code. TODO Docu: How are description and extendedReason used ? TODO Can we change creaiton of exceptions with this status code in the CIM Client code so they use some other code ?

See Also:

Constant Field Values

CIM_ERR_NOT_SUPPORTED

public static final java.lang.String CIM_ERR_NOT_SUPPORTED

CIM Status Code value: The CIM operation is not supported by the CIM Server/Provider. Origin: CIM Server/Provider only. TODO Docu: How are description and extendedReason used ?

See Also:

Constant Field Values

CIM_ERR_CLASS_HAS_CHILDREN

public static final java.lang.String CIM_ERR_CLASS_HAS_CHILDREN

CIM Status Code value: The CIM class has subclasses. Origin: CIM Server/Provider only. TODO Docu: How are description and extendedReason used ?

See Also:

Constant Field Values

CIM_ERR_CLASS_HAS_INSTANCES

public static final java.lang.String CIM_ERR_CLASS_HAS_INSTANCES

CIM Status Code value: One or more instances of this CIM class exist. Origin: CIM Server/Provider only. TODO Docu: How are description and extendedReason used ?

See Also:

Constant Field Values

CIM_ERR_INVALID_SUPERCLASS

public static final java.lang.String CIM_ERR_INVALID_SUPERCLASS

CIM Status Code value: The CIM superclass does not exist. Origin: CIM Server/Provider only. TODO Docu: How are description and extendedReason used ?

See Also:

Constant Field Values

CIM_ERR_ALREADY_EXISTS

public static final java.lang.String CIM_ERR_ALREADY_EXISTS

CIM Status Code value: The CIM object (class or instance) already exists. Origin: CIM Server/Provider only. TODO Docu: How are description and extendedReason used ?

See Also:

Constant Field Values

CIM_ERR_NO_SUCH_PROPERTY

public static final java.lang.String CIM_ERR_NO_SUCH_PROPERTY

CIM Status Code value: The CIM property is not defined on the class. Note that if the property is defined on the class but not supported by a CIM Provider, it is still supposed to be returned to the client with its class defined default value. Origin: CIM Server/Provider only. TODO Docu: How are description and extendedReason used ?

See Also:

Constant Field Values

CIM_ERR_TYPE_MISMATCH

public static final java.lang.String CIM_ERR_TYPE_MISMATCH

CIM Status Code value: The value supplied is not compatible with the CIM type. Origin: CIM Server/Provider only. TODO Docu: How are description and extendedReason used ?

See Also:

Constant Field Values

CIM_ERR_LOW_ON_MEMORY

public static final java.lang.String CIM_ERR_LOW_ON_MEMORY

Origin: Not clear. TODO Not used anywhere in the CIM Client code, and also not a DMTF defined CIM status code.

See Also:

Constant Field Values

CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED

public static final java.lang.String CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED

CIM Status Code value: The query language is not recognized or supported. Origin: CIM Server/Provider only. TODO Docu: How are description and extendedReason used ?

See Also:

Constant Field Values

CIM_ERR_INVALID_QUERY

public static final java.lang.String CIM_ERR_INVALID_QUERY

CIM Status Code value: The query is not valid for the specified query language. Origin: CIM Server/Provider only. TODO Docu: How are description and extendedReason used ?

See Also:

Constant Field Values

CIM_ERR_METHOD_NOT_AVAILABLE

public static final java.lang.String CIM_ERR_METHOD_NOT_AVAILABLE

CIM Status Code value: The CIM method is not supported by the CIM Provider for the class. Note that it is still be defined on the class. Origin: CIM Server/Provider only. TODO Docu: How are description and extendedReason used ?

See Also:

Constant Field Values

CIM_ERR_METHOD_NOT_FOUND

public static final java.lang.String CIM_ERR_METHOD_NOT_FOUND

CIM Status Code value: The CIM method is not defined on the class. Origin: CIM Server/Provider only. TODO Docu: How are description and extendedReason used ?

See Also:

Constant Field Values

CIM_ERR_NOT_IMPLEMENTED

public static final java.lang.String CIM_ERR_NOT_IMPLEMENTED

Origin: Not clear. TODO Not used anywhere in the CIM Client code, and also not a DMTF defined CIM status code.

See Also:

Constant Field Values

IBM_ERR_VER_ERROR

public static final java.lang.String IBM_ERR_VER_ERROR

Origin: Not clear. TODO Not used anywhere in the CIM Client code, and also not a DMTF defined CIM status code.

See Also:

Constant Field Values

IBM_ERR_TIMED_OUT

public static final java.lang.String IBM_ERR_TIMED_OUT

Origin: Not clear. TODO Not used anywhere in the CIM Client code, and also not a DMTF defined CIM status code.

See Also:

Constant Field Values

CIM_ERROR_NAMES

protected static final java.lang.String[] CIM_ERROR_NAMES

Constructor Detail

CIMException

public CIMException()

Constructs a CIMException with no detail message.

CIMException

public CIMException(java.lang.String pReason)

Constructs a CIMException with the specified message.

Parameters:

pReason - - a symbolic name of the CIMException. e.g. CIM_ERR_FAILED, CIM_ERR_NOT_FOUND, etc.

CIMException

public CIMException(java.lang.String pReason,
            java.lang.Object pExtendedReason)

Constructs a CIMException with the specified message and one extended reason parameter.

Parameters:

pReason - - a symbolic name of the CIMException. e.g. CIM_ERR_FAILED, CIM_ERR_NOT_FOUND, etc.

pExtendedReason - extended reason describing the exception.

CIMException

public CIMException(java.lang.String pReason,
            java.lang.Object pExtendedReason1,
            java.lang.Object pExtendedReason2)

Constructs a CIMException with the specified message and one extended reason parameter.

Parameters:

pReason - - a symbolic name of the CIMException. e.g. CIM_ERR_FAILED, CIM_ERR_NOT_FOUND, etc.

pExtendedReason1 - first extended reason describing the exception.

pExtendedReason2 - second extended reason describing the exception.

CIMException

public CIMException(java.lang.String pReason,
            java.lang.Object pExtendedReason1,
            java.lang.Object pExtendedReason2,
            java.lang.Object pExtendedReason3)

Constructs a CIMException with the specified message and one extended reason parameter.

Parameters:

pReason - - a symbolic name of the CIMException. e.g. CIM_ERR_FAILED, CIM_ERR_NOT_FOUND, etc.

pExtendedReason1 - first extended reason describing the exception.

pExtendedReason2 - second extended reason describing the exception.

pExtendedReason3 - third extended reason describing the exception.

CIMException

public CIMException(java.lang.String pReason,
            java.lang.Object[] pExtendedReason)

Constructs a CIMException with the specified message and one extended reason parameter.

Parameters:

pReason - - a symbolic name of the CIMException. e.g. CIM_ERR_FAILED, CIM_ERR_NOT_FOUND, etc.

pExtendedReason - an array of extended reasons describing the exception.

CIMException

public CIMException(java.lang.String pReason,
            java.lang.Throwable pThrowable)

Constructs a CIMException with the specified message and one extended reason parameter.

Parameters:

pReason - - a symbolic name of the CIMException. e.g. CIM_ERR_FAILED, CIM_ERR_NOT_FOUND, etc.

pThrowable - the original cause for this exception.

Method Detail

initCause

public java.lang.Throwable initCause(java.lang.Throwable pCause)

Overrides:

initCause in class java.lang.Throwable

getID

public java.lang.String getID()

Gets the reason for this exception.

Returns:

The reason

setDescription

public void setDescription(java.lang.String pDescription)

Sets a description for this exception.

Parameters:

pDescription -

getDescription

public java.lang.String getDescription()

Returns a description for this exception. If no description is specified, a description is formulated from the reason and extended reasons.

Returns:

The description

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Throwable

getStatusCode

public int getStatusCode()

Returns the status code that may be returned by a conforming CIM Server application as the value of the CODE attribute of an subelement within a or . This method returns the status code assigned to the CIMException. If the status message is a standard status code defined by the specification, it will return the corresponding value. (i.e "CIM_ERR_FAILED" = 1, "CIM_ERR_ACCESS_DENIED" =2), otherwise it will return -1

Returns:

an integer value associated to the cim status code

getStatusCode

public static int getStatusCode(java.lang.String pMessage)

Returns the status code that may be returned by a conforming CIM Server application as the value of the CODE attribute of an subelement within a or . This method returns the status code for a given string value. If the status message is a standard status code defined by the specification, it will return the corresponding value. (i.e "CIM_ERR_FAILED" = 1, "CIM_ERR_ACCESS_DENIED" =2), otherwise it will return -1

Parameters:

pMessage - The status code string (i.e. "CIM_ERR_FAILED")

Returns:

an integer value associated to the cim status code

getStatusFromCode

public static java.lang.String getStatusFromCode(int i)

Returns the string representation of the status code. (i.e. status code 6 will return "CIM_ERR_NOT_FOUND". If the status code is not a standard status code then "CIM_ERR_FAILED" is returned.

Parameters:

i - an integer representing the status code

Returns:

the string representation of the status code

setParams

public void setParams(java.lang.Object[] pReason)

Specifies the extended reason for this exception.

Parameters:

pReason - The extended reason

getParams

public java.lang.Object[] getParams()

Gets the extended reason for this exception.

Returns:

The extended reason

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getMessage

public java.lang.String getMessage()

Gets the message associated to this exception.

Overrides:

getMessage in class java.lang.Throwable

Returns:

The message

getCause

public java.lang.Throwable getCause()

Gets the thowable object which causes this exception.

Overrides:

getCause in class java.lang.Throwable

Returns:

The cause