Package org.osgi.service.zigbee

Class ZCLException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.osgi.service.zigbee.ZigBeeException

org.osgi.service.zigbee.ZCLException

All Implemented Interfaces:

Serializable

public class ZCLException
extends ZigBeeException

This class represents root exception for all the code related to ZigBee/ZCL. The provided constants names, but not the values, maps to the ZCL error codes defined in the ZCL specification.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CALIBRATION_ERROR	ZCL Calibration Error error code.
static final int	CLUSTER_COMMAND_NOT_SUPPORTED	ZCL Cluster Command Not Supported error code.
static final int	DUPLICATE_EXISTS	ZCL Duplicate Exists error code.
static final int	FAILURE	ZCL Failure error code.
static final int	GENERAL_COMMAND_NOT_SUPPORTED	ZCL General Command Not Supported error code.
static final int	HARDWARE_FAILURE	HARDWARE_FAILURE - in this case, an additional exception describing the problem can be nested.
static final int	INSUFFICIENT_SPACE	ZCL Insufficient Space error code.
static final int	INVALID_DATA_TYPE	ZCL Invalid Data Type error code.
static final int	INVALID_FIELD	ZCL Invalid Field error code.
static final int	INVALID_VALUE	ZCL Invalid Value error code.
static final int	MALFORMED_COMMAND	ZCL Malformed Command error code.
static final int	MANUF_CLUSTER_COMMAND_NOT_SUPPORTED	ZCL Manuf Cluster Command Not Supported error code.
static final int	MANUF_GENERAL_COMMAND_NOT_SUPPORTED	ZCL Manuf General Command Not Supported error code.
static final int	NOT_FOUND	ZCL Not Found error code.
static final int	READ_ONLY	ZCL Read Only error code.
static final int	SOFTWARE_FAILURE	Software Failure error code - in this case, an additional exception describing the problem can be nested.
static final int	SUCCESS	ZCL Success error code.
static final int	UNREPORTABLE_TYPE	Unreportable Type error code.
static final int	UNSUPPORTED_ATTRIBUTE	ZCL Unsupported Attribute error code.

Fields inherited from class org.osgi.service.zigbee.ZigBeeException

errorCode, OSGI_EXISTING_ID, OSGI_MULTIPLE_HOSTS, TIMEOUT, UNKNOWN_ERROR, zigBeeErrorCode

Constructor Summary

Constructors

Constructor	Description
ZCLException(int errorCode, int zigBeeErrorCode, String errorDesc)	Creates a ZCLException containing a specific errorCode or zigBeeErrorCode.
ZCLException(int errorCode, String errorDesc)	Creates a ZCLException containing a specific errorCode.
ZCLException(String errorDesc)	Creates a ZCLException containing only a description, but no error codes.

Method Summary

Methods inherited from class org.osgi.service.zigbee.ZigBeeException

getErrorCode, getZigBeeErrorCode, hasZigBeeErrorCode

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Details

SUCCESS

public static final int SUCCESS

ZCL Success error code.

See Also:

• Constant Field Values

FAILURE

public static final int FAILURE

ZCL Failure error code.

See Also:

• Constant Field Values

MALFORMED_COMMAND

public static final int MALFORMED_COMMAND

ZCL Malformed Command error code.

See Also:

• Constant Field Values

CLUSTER_COMMAND_NOT_SUPPORTED

public static final int CLUSTER_COMMAND_NOT_SUPPORTED

ZCL Cluster Command Not Supported error code.

See Also:

• Constant Field Values

GENERAL_COMMAND_NOT_SUPPORTED

public static final int GENERAL_COMMAND_NOT_SUPPORTED

ZCL General Command Not Supported error code.

See Also:

• Constant Field Values

MANUF_CLUSTER_COMMAND_NOT_SUPPORTED

public static final int MANUF_CLUSTER_COMMAND_NOT_SUPPORTED

ZCL Manuf Cluster Command Not Supported error code.

See Also:

• Constant Field Values

MANUF_GENERAL_COMMAND_NOT_SUPPORTED

public static final int MANUF_GENERAL_COMMAND_NOT_SUPPORTED

ZCL Manuf General Command Not Supported error code.

See Also:

• Constant Field Values

INVALID_FIELD

public static final int INVALID_FIELD

ZCL Invalid Field error code.

See Also:

• Constant Field Values

UNSUPPORTED_ATTRIBUTE

public static final int UNSUPPORTED_ATTRIBUTE

ZCL Unsupported Attribute error code.

See Also:

• Constant Field Values

INVALID_VALUE

public static final int INVALID_VALUE

ZCL Invalid Value error code.

See Also:

• Constant Field Values

READ_ONLY

public static final int READ_ONLY

ZCL Read Only error code.

See Also:

• Constant Field Values

INSUFFICIENT_SPACE

public static final int INSUFFICIENT_SPACE

ZCL Insufficient Space error code.

See Also:

• Constant Field Values

DUPLICATE_EXISTS

public static final int DUPLICATE_EXISTS

ZCL Duplicate Exists error code.

See Also:

• Constant Field Values

NOT_FOUND

public static final int NOT_FOUND

ZCL Not Found error code.

See Also:

• Constant Field Values

UNREPORTABLE_TYPE

public static final int UNREPORTABLE_TYPE

Unreportable Type error code.

See Also:

• Constant Field Values

INVALID_DATA_TYPE

public static final int INVALID_DATA_TYPE

ZCL Invalid Data Type error code.

See Also:

• Constant Field Values

HARDWARE_FAILURE

public static final int HARDWARE_FAILURE

HARDWARE_FAILURE - in this case, an additional exception describing the problem can be nested.

See Also:

• Constant Field Values

SOFTWARE_FAILURE

public static final int SOFTWARE_FAILURE

Software Failure error code - in this case, an additional exception describing the problem can be nested.

See Also:

• Constant Field Values

CALIBRATION_ERROR

public static final int CALIBRATION_ERROR

ZCL Calibration Error error code.

See Also:

• Constant Field Values

Constructor Details

ZCLException

public ZCLException(String errorDesc)

Creates a ZCLException containing only a description, but no error codes. If issued on this exception the ZigBeeException.getErrorCode() and ZigBeeException.getZigBeeErrorCode() methods return the ZigBeeException.UNKNOWN_ERROR constant.

Parameters:

errorDesc - exception error description.

ZCLException

public ZCLException(int errorCode,
 String errorDesc)

Creates a ZCLException containing a specific errorCode. Using this constructor with errorCode set to ZigBeeException.UNKNOWN_ERROR is equivalent to call ZCLException(String).

Parameters:

errorCode - One of the error codes defined in this interface or ZigBeeException.UNKNOWN_ERROR if the actual error is not listed in this interface. In this case if the native ZigBee error code is known, it is preferred to use the ZCLException(int, int, String) constructor, passing ZigBeeException.UNKNOWN_ERROR as first parameter and the native ZigBee error as the second.

errorDesc - An error description which explain the type of problem.

ZCLException

public ZCLException(int errorCode,
 int zigBeeErrorCode,
 String errorDesc)

Creates a ZCLException containing a specific errorCode or zigBeeErrorCode. Using this constructor with both the errorCode and zigBeeErrorCode set to ZigBeeException.UNKNOWN_ERROR is equivalent to call ZCLException(String).

Parameters:

errorCode - One of the error codes defined in this interface or ZigBeeException.UNKNOWN_ERROR the actual error is not covered in this interface. In this case the zigBeeErrorCode parameter must be the actual status code returned by the ZigBee stack.

zigBeeErrorCode - The actual ZCL status code or ZigBeeException.UNKNOWN_ERROR if this status is unknown.

errorDesc - An error description which explain the type of problem.