javax.wbem
Class WBEMException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          javax.wbem.WBEMException

All Implemented Interfaces:

java.io.Serializable

public class WBEMException
extends java.lang.Exception

WBEMException is what all WBEM Operations return when there is an error. WBEMException includes the following:

• ID - The ID of the Exception
• Description - Brief description of the exception
• CIMInstance[] - Optional array of CIM_Error instances

See Also:

Serialized Form

Field Summary

static int	CIM_ERR_ACCESS_DENIED Access Denied Exception.
static int	CIM_ERR_ALREADY_EXISTS Element already exists.
static int	CIM_ERR_CLASS_HAS_CHILDREN Class has subclasses.
static int	CIM_ERR_CLASS_HAS_INSTANCES Class has instances.
static int	CIM_ERR_CONTINUATION_ON_ERROR_NOT_SUPPORTED The WBEM Server does not support continuation on error.
static int	CIM_ERR_FAILED General Exception.
static int	CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED Using a filter in the enumeration is not supported by the WBEM Server.
static int	CIM_ERR_INVALID_CLASS Invalid class specified.
static int	CIM_ERR_INVALID_ENUMERATION_CONTEXT The enumeration identified by the specified context cannot be found, is in a closed state, does not exist, or is otherwise invalid.
static int	CIM_ERR_INVALID_NAMESPACE Invalid namespace Exception Thrown when the specified namespace does not exist.
static int	CIM_ERR_INVALID_OPERATION_TIMEOUT The specified operation timeout is not supported by the WBEM Server.
static int	CIM_ERR_INVALID_PARAMETER Invalid parameter is passed to a method.
static int	CIM_ERR_INVALID_QUERY Invalid query.
static int	CIM_ERR_INVALID_RESPONSE_DESTINATION The destination is invalid.
static int	CIM_ERR_INVALID_SUPERCLASS The super class does not exist.
static int	CIM_ERR_METHOD_NOT_AVAILABLE The method is not available.
static int	CIM_ERR_METHOD_NOT_FOUND The method is not found.
static int	CIM_ERR_NAMESPACE_NOT_EMPTY The namespace is not empty.
static int	CIM_ERR_NO_SUCH_PROPERTY The property does not exist in the class/instance being manipulated.
static int	CIM_ERR_NOT_FOUND Element cannot be found.
static int	CIM_ERR_NOT_SUPPORTED The action is not supported.
static int	CIM_ERR_PULL_CANNOT_BE_ABANDONED The attempt to abandon a concurrent Pull operation on the same enumeration failed, the concurrent Pull operation proceeds normally.
static int	CIM_ERR_PULL_HAS_BEEN_ABANDONED The Pull operation has been abandoned due to execution of a concurrent CloseEnumeration operation on the same enumeration.
static int	CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED The requested query language is not recognized.
static int	CIM_ERR_SERVER_IS_SHUTTING_DOWN The WBEM Server is in the process of shutting down and cannot process the operation at this time.
static int	CIM_ERR_SERVER_LIMITS_EXCEEDED The WBEM Server has failed the operation based upon exceeding server limits.
static int	CIM_ERR_TYPE_MISMATCH The value supplied is not compatible with the type.

Constructor Summary

WBEMException(int pID)
Constructs a new exception using the specified ID.

WBEMException(int pID, java.lang.String pMessage)
Constructs a new exception using the specified ID and detailed message.

WBEMException(int pID, java.lang.String pMessage, CIMInstance[] pErrors)
Constructs a new exception using the specified ID, detailed message and CIM_Error instances.

WBEMException(int pID, java.lang.String pMessage, CIMInstance[] pErrors, java.lang.Throwable pCause)
Constructs a new exception using the specified ID, detailed message, CIM_Error instances and cause.

WBEMException(java.lang.String pMessage)
Constructs a new exception using the specified detailed message.

Method Summary

CIMInstance[]	getCIMErrors() Get the CIM Error Instances.
int	getID() Returns the ID of the error
java.lang.String	getMessage()
java.lang.String	toString() Prints out the ID and the optional detailed message.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Field Detail

CIM_ERR_FAILED

public static final int CIM_ERR_FAILED

General Exception. If no other error IDs match the error, this one should be returned.

See Also:

Constant Field Values

CIM_ERR_ACCESS_DENIED

public static final int CIM_ERR_ACCESS_DENIED

Access Denied Exception. Thrown when the principal is not authenticated or authorized.

See Also:

Constant Field Values

CIM_ERR_INVALID_NAMESPACE

public static final int CIM_ERR_INVALID_NAMESPACE

Invalid namespace Exception Thrown when the specified namespace does not exist.

See Also:

Constant Field Values

CIM_ERR_INVALID_PARAMETER

public static final int CIM_ERR_INVALID_PARAMETER

Invalid parameter is passed to a method. This error message uses one parameter, the parameter which caused the exception.

See Also:

Constant Field Values

CIM_ERR_INVALID_CLASS

public static final int CIM_ERR_INVALID_CLASS

Invalid class specified. For e.g. when one tries to add an instance for a class that does not exist. This error message uses one parameter, the invalid class name.

See Also:

Constant Field Values

CIM_ERR_NOT_FOUND

public static final int CIM_ERR_NOT_FOUND

Element cannot be found. This error message uses one parameter, the element that cannot be found.

See Also:

Constant Field Values

CIM_ERR_NOT_SUPPORTED

public static final int CIM_ERR_NOT_SUPPORTED

The action is not supported. This can be thrown by a provider or the WBEM Server itself when it does not support a particular method.

See Also:

Constant Field Values

CIM_ERR_CLASS_HAS_CHILDREN

public static final int CIM_ERR_CLASS_HAS_CHILDREN

Class has subclasses. The exception is thrown by the WBEM Server to disallow invalidation of the subclasses by the super class deletion. Clients must explicitly delete the subclasses first. The check for subclasses is made before the check for class instances.

See Also:

Constant Field Values

CIM_ERR_CLASS_HAS_INSTANCES

public static final int CIM_ERR_CLASS_HAS_INSTANCES

Class has instances. The exception is thrown by to disallow invalidation of the instances by the class deletion. Clients must explicitly delete the instances first. The check for subclasses is made before the check for class instances i.e. CIM_ERR_CLASS_HAS_CHILDREN is thrown before CIM_ERR_CLASS_HAS_INSTANCES

See Also:

Constant Field Values

CIM_ERR_INVALID_SUPERCLASS

public static final int CIM_ERR_INVALID_SUPERCLASS

The super class does not exist.

See Also:

Constant Field Values

CIM_ERR_ALREADY_EXISTS

public static final int CIM_ERR_ALREADY_EXISTS

Element already exists.

See Also:

Constant Field Values

CIM_ERR_NO_SUCH_PROPERTY

public static final int CIM_ERR_NO_SUCH_PROPERTY

The property does not exist in the class/instance being manipulated. This error message uses has one parameter, the name of the property that does not exist.

See Also:

Constant Field Values

CIM_ERR_TYPE_MISMATCH

public static final int CIM_ERR_TYPE_MISMATCH

The value supplied is not compatible with the type.

See Also:

Constant Field Values

CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED

public static final int CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED

The requested query language is not recognized. This error message has one parameter, the invalid query language string.

See Also:

Constant Field Values

CIM_ERR_INVALID_QUERY

public static final int CIM_ERR_INVALID_QUERY

Invalid query. This error message uses has two parameters, the invalid snippet of the query, and additional info with the actual error in the query.

See Also:

Constant Field Values

CIM_ERR_METHOD_NOT_AVAILABLE

public static final int CIM_ERR_METHOD_NOT_AVAILABLE

The method is not available.

See Also:

Constant Field Values

CIM_ERR_METHOD_NOT_FOUND

public static final int CIM_ERR_METHOD_NOT_FOUND

The method is not found.

See Also:

Constant Field Values

CIM_ERR_INVALID_RESPONSE_DESTINATION

public static final int CIM_ERR_INVALID_RESPONSE_DESTINATION

The destination is invalid.

See Also:

Constant Field Values

CIM_ERR_NAMESPACE_NOT_EMPTY

public static final int CIM_ERR_NAMESPACE_NOT_EMPTY

The namespace is not empty.

See Also:

Constant Field Values

CIM_ERR_INVALID_ENUMERATION_CONTEXT

public static final int CIM_ERR_INVALID_ENUMERATION_CONTEXT

The enumeration identified by the specified context cannot be found, is in a closed state, does not exist, or is otherwise invalid.

See Also:

Constant Field Values

CIM_ERR_INVALID_OPERATION_TIMEOUT

public static final int CIM_ERR_INVALID_OPERATION_TIMEOUT

The specified operation timeout is not supported by the WBEM Server.

See Also:

Constant Field Values

CIM_ERR_PULL_HAS_BEEN_ABANDONED

public static final int CIM_ERR_PULL_HAS_BEEN_ABANDONED

The Pull operation has been abandoned due to execution of a concurrent CloseEnumeration operation on the same enumeration.

See Also:

Constant Field Values

CIM_ERR_PULL_CANNOT_BE_ABANDONED

public static final int CIM_ERR_PULL_CANNOT_BE_ABANDONED

The attempt to abandon a concurrent Pull operation on the same enumeration failed, the concurrent Pull operation proceeds normally.

See Also:

Constant Field Values

CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED

public static final int CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED

Using a filter in the enumeration is not supported by the WBEM Server.

See Also:

Constant Field Values

CIM_ERR_CONTINUATION_ON_ERROR_NOT_SUPPORTED

public static final int CIM_ERR_CONTINUATION_ON_ERROR_NOT_SUPPORTED

The WBEM Server does not support continuation on error.

See Also:

Constant Field Values

CIM_ERR_SERVER_LIMITS_EXCEEDED

public static final int CIM_ERR_SERVER_LIMITS_EXCEEDED

The WBEM Server has failed the operation based upon exceeding server limits.

See Also:

Constant Field Values

CIM_ERR_SERVER_IS_SHUTTING_DOWN

public static final int CIM_ERR_SERVER_IS_SHUTTING_DOWN

The WBEM Server is in the process of shutting down and cannot process the operation at this time.

See Also:

Constant Field Values

Constructor Detail

WBEMException

public WBEMException(int pID)

Constructs a new exception using the specified ID. The detailed message will be null.

Parameters:

pID - - The Error ID to use.

WBEMException

public WBEMException(int pID,
                     java.lang.String pMessage)

Constructs a new exception using the specified ID and detailed message.

Parameters:

pID - - The error ID.

pMessage - - The detailed message.

WBEMException

public WBEMException(int pID,
                     java.lang.String pMessage,
                     CIMInstance[] pErrors)

Constructs a new exception using the specified ID, detailed message and CIM_Error instances.

Parameters:

pID - - The error ID

pMessage - - The detailed message.

pErrors - - Array of CIM_Error instances.

WBEMException

public WBEMException(int pID,
                     java.lang.String pMessage,
                     CIMInstance[] pErrors,
                     java.lang.Throwable pCause)

Constructs a new exception using the specified ID, detailed message, CIM_Error instances and cause.

Parameters:

pID - - The error ID.

pMessage - - The detailed message.

pErrors - - Array of CIM_Error instances.

pCause - - Throwable cause.

WBEMException

public WBEMException(java.lang.String pMessage)

Constructs a new exception using the specified detailed message. The ID will be CIM_ERR_FAILED.

Parameters:

pMessage - - The detailed message.

Method Detail

getCIMErrors

public CIMInstance[] getCIMErrors()

Get the CIM Error Instances.

Returns:

Any CIM Error instances associated with this exception; null if none.

getID

public int getID()

Returns the ID of the error

Returns:

The ID of the error

getMessage

public java.lang.String getMessage()

Overrides:

getMessage in class java.lang.Throwable

toString

public java.lang.String toString()

Prints out the ID and the optional detailed message.

Overrides:

toString in class java.lang.Throwable

Returns:

A String representation of the exception.

See Also:

Object.toString()