Package org.osgi.service.zigbee

Class APSException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.osgi.service.zigbee.ZigBeeException

org.osgi.service.zigbee.APSException

All Implemented Interfaces:

Serializable

public class APSException
extends ZigBeeException

This exception class is specialized for the APS errors. See "Table 2.26 APS Sub-layer Status Values" of the ZigBee specification 1_053474r17ZB_TSC-ZigBee-Specification.pdf.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ASDU_TOO_LONG	A transmit request failed since the ASDU is too large and fragmentation is not supported.
static final int	DEFRAG_DEFERRED	A received fragmented frame could not be defragmented at the current time.
static final int	DEFRAG_UNSUPPORTED	A received fragmented frame could not be defragmented since the device does not support fragmentation.
static final int	ILLEGAL_REQUEST	A parameter value was out of range.
static final int	INVALID_BINDING	An APSME-UNBIND.request failed due to the requested binding link not existing in the binding table.
static final int	INVALID_GROUP	An APSME-REMOVE-GROUP.request has been issued with a group identifier that does not appear in the group table.
static final int	INVALID_PARAMETER	A parameter value was invalid or out of range.
static final int	NO_ACK	An APSDE-DATA.request requesting acknowledged transmission failed due to no acknowledgment being received.
static final int	NO_BOUND_DEVICE	An APSDE-DATA.request with a destination addressing mode set to 0x00 failed due to there being no devices bound to this device.
static final int	NO_SHORT_ADDRESS	An APSDE-DATA.request with a destination addressing mode set to 0x03 failed due to no corresponding short address found in the address map table.
static final int	NOT_SUPPORTED	An APSDE-DATA.request with a destination addressing mode set to 0x00 failed due to a binding table not being supported on the device.
static final int	SECURED_LINK_KEY	An ASDU was received that was secured using a link key.
static final int	SECURED_NWK_KEY	An ASDU was received that was secured using a network key.
static final int	SECURITY_FAIL	An APSDE-DATA.request requesting security has resulted in an error during the corresponding security processing.
static final int	SUCCESS	A request has been executed successfully.
static final int	TABLE_FULL	An APSME-BIND.request or APSME.ADDGROUP.
static final int	UNSECURED	An ASDU was received without any security.
static final int	UNSUPPORTED_ATTRIBUTE	An APSME-GET.request or APSMESET.

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
APSException(int errorCode, int zigBeeErrorCode, String errorDesc)	Creates a APSException containing a specific errorCode or zigBeeErrorCode.
APSException(int errorCode, String errorDesc)	Creates a APSException containing a specific errorCode.
APSException(String errorDesc)	Creates a APSException 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

A request has been executed successfully.

See Also:

• Constant Field Values

ASDU_TOO_LONG

public static final int ASDU_TOO_LONG

A transmit request failed since the ASDU is too large and fragmentation is not supported.

See Also:

• Constant Field Values

DEFRAG_DEFERRED

public static final int DEFRAG_DEFERRED

A received fragmented frame could not be defragmented at the current time.

See Also:

• Constant Field Values

DEFRAG_UNSUPPORTED

public static final int DEFRAG_UNSUPPORTED

A received fragmented frame could not be defragmented since the device does not support fragmentation.

See Also:

• Constant Field Values

ILLEGAL_REQUEST

public static final int ILLEGAL_REQUEST

A parameter value was out of range.

See Also:

• Constant Field Values

INVALID_BINDING

public static final int INVALID_BINDING

An APSME-UNBIND.request failed due to the requested binding link not existing in the binding table.

See Also:

• Constant Field Values

INVALID_GROUP

public static final int INVALID_GROUP

An APSME-REMOVE-GROUP.request has been issued with a group identifier that does not appear in the group table.

See Also:

• Constant Field Values

INVALID_PARAMETER

public static final int INVALID_PARAMETER

A parameter value was invalid or out of range.

See Also:

• Constant Field Values

NO_ACK

public static final int NO_ACK

An APSDE-DATA.request requesting acknowledged transmission failed due to no acknowledgment being received.

See Also:

• Constant Field Values

NO_BOUND_DEVICE

public static final int NO_BOUND_DEVICE

An APSDE-DATA.request with a destination addressing mode set to 0x00 failed due to there being no devices bound to this device.

See Also:

• Constant Field Values

NO_SHORT_ADDRESS

public static final int NO_SHORT_ADDRESS

An APSDE-DATA.request with a destination addressing mode set to 0x03 failed due to no corresponding short address found in the address map table.

See Also:

• Constant Field Values

NOT_SUPPORTED

public static final int NOT_SUPPORTED

An APSDE-DATA.request with a destination addressing mode set to 0x00 failed due to a binding table not being supported on the device.

See Also:

• Constant Field Values

SECURED_LINK_KEY

public static final int SECURED_LINK_KEY

An ASDU was received that was secured using a link key.

See Also:

• Constant Field Values

SECURED_NWK_KEY

public static final int SECURED_NWK_KEY

An ASDU was received that was secured using a network key.

See Also:

• Constant Field Values

SECURITY_FAIL

public static final int SECURITY_FAIL

An APSDE-DATA.request requesting security has resulted in an error during the corresponding security processing.

See Also:

• Constant Field Values

TABLE_FULL

public static final int TABLE_FULL

An APSME-BIND.request or APSME.ADDGROUP. request issued when the binding or group tables, respectively, were full.

See Also:

• Constant Field Values

UNSECURED

public static final int UNSECURED

An ASDU was received without any security.

See Also:

• Constant Field Values

UNSUPPORTED_ATTRIBUTE

public static final int UNSUPPORTED_ATTRIBUTE

An APSME-GET.request or APSMESET. request has been issued with an unknown attribute identifier.

See Also:

• Constant Field Values

Constructor Details

APSException

public APSException(String errorDesc)

Creates a APSException 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 an error description.

APSException

public APSException(int errorCode,
 String errorDesc)

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

APSException

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

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

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