Package org.osgi.service.zigbee

Class ZDPException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.osgi.service.zigbee.ZigBeeException

org.osgi.service.zigbee.ZDPException

All Implemented Interfaces:

java.io.Serializable

public class ZDPException
extends ZigBeeException

This class represents root exception for all the code related to ZDP.

See Table 2.137 ZDP Enumerations Description in ZIGBEE SPECIFICATION: 1_053474r17ZB_TSC-ZigBee-Specification.pdf.

Author:

$Id: 4f15dbbcc7751f43e84cefc4e5a5c1c3e02dee99 $

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEVICE_NOT_FOUND	The requested device did not exist on a device following a child descriptor request to a parent.
static int	INSUFFICIENT_SPACE	The device does not have storage space to support the requested operation.
static int	INV_REQUESTTYPE	The supplied request type was invalid.
static int	INVALID_EP	The supplied endpoint was equal to 0x00 or between 0xf1 and 0xff.
static int	NO_DESCRIPTOR	A child descriptor was not available following a discovery request to a parent.
static int	NO_ENTRY	The unbind request was unsuccessful due to the coordinator or source device not having an entry in its binding table to unbind.
static int	NO_MATCH	The end device bind request was unsuccessful due to a failure to match any suitable clusters.
static int	NOT_ACTIVE	The requested endpoint is not described by a simple descriptor.
static int	NOT_AUTHORIZED	The permissions configuration table on the target indicates that the request is not authorized from this device.
static int	NOT_PERMITTED	The device is not in the proper state to support the requested operation.
static int	NOT_SUPPORTED	The requested optional feature is not supported on the target device.
static int	SUCCESS	The requested operation or transmission was completed successfully.
static int	TABLE_FULL	The device does not have table space to support the operation.
static int	TIMEOUT	A timeout has occurred with the requested operation.

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

errorCode, OSGI_EXISTING_ID, OSGI_MULTIPLE_HOSTS, UNKNOWN_ERROR, zigBeeErrorCode

Constructor Summary

Constructors

Constructor	Description
ZDPException(int errorCode, int zigBeeErrorCode, java.lang.String errorDesc)	Creates a ZDPException containing a specific errorCode or zigBeeErrorCode.
ZDPException(int errorCode, java.lang.String errorDesc)	Creates a ZDPException containing a specific errorCode.
ZDPException(java.lang.String errorDesc)	Creates a ZDPException 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 Detail

SUCCESS

public static final int SUCCESS

The requested operation or transmission was completed successfully.

See Also:

Constant Field Values

INV_REQUESTTYPE

public static final int INV_REQUESTTYPE

The supplied request type was invalid.

See Also:

Constant Field Values

DEVICE_NOT_FOUND

public static final int DEVICE_NOT_FOUND

The requested device did not exist on a device following a child descriptor request to a parent.

See Also:

Constant Field Values

INVALID_EP

public static final int INVALID_EP

The supplied endpoint was equal to 0x00 or between 0xf1 and 0xff.

See Also:

Constant Field Values

NOT_ACTIVE

public static final int NOT_ACTIVE

The requested endpoint is not described by a simple descriptor.

See Also:

Constant Field Values

NOT_SUPPORTED

public static final int NOT_SUPPORTED

The requested optional feature is not supported on the target device.

See Also:

Constant Field Values

TIMEOUT

public static final int TIMEOUT

A timeout has occurred with the requested operation.

See Also:

Constant Field Values

NO_MATCH

public static final int NO_MATCH

The end device bind request was unsuccessful due to a failure to match any suitable clusters.

See Also:

Constant Field Values

NO_ENTRY

public static final int NO_ENTRY

The unbind request was unsuccessful due to the coordinator or source device not having an entry in its binding table to unbind.

See Also:

Constant Field Values

NO_DESCRIPTOR

public static final int NO_DESCRIPTOR

A child descriptor was not available following a discovery request to a parent.

See Also:

Constant Field Values

INSUFFICIENT_SPACE

public static final int INSUFFICIENT_SPACE

The device does not have storage space to support the requested operation.

See Also:

Constant Field Values

NOT_PERMITTED

public static final int NOT_PERMITTED

The device is not in the proper state to support the requested operation.

See Also:

Constant Field Values

TABLE_FULL

public static final int TABLE_FULL

The device does not have table space to support the operation.

See Also:

Constant Field Values

NOT_AUTHORIZED

public static final int NOT_AUTHORIZED

The permissions configuration table on the target indicates that the request is not authorized from this device.

See Also:

Constant Field Values

Constructor Detail

ZDPException

public ZDPException(java.lang.String errorDesc)

Creates a ZDPException 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.

ZDPException

public ZDPException(int errorCode,
                    java.lang.String errorDesc)

Creates a ZDPException containing a specific errorCode. Using this constructor with errorCode set to ZigBeeException.UNKNOWN_ERROR is equivalent to call ZDPException(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 ZDPException(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.

ZDPException

public ZDPException(int errorCode,
                    int zigBeeErrorCode,
                    java.lang.String errorDesc)

Creates a ZDPException containing a specific errorCode or zigBeeErrorCode. Using this constructor with both the errorCode and zigBeeErrorCode set to ZigBeeException.UNKNOWN_ERROR is equivalent to call ZDPException(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 ZDP status code or ZigBeeException.UNKNOWN_ERROR if this status is unknown.

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