Top Description Fields Constructors Methods
org.osgi.service.zigbee

public Class APSException

extends ZigBeeException
Class Inheritance

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.
Author
$Id: 062f2177cad281a7bda9a2e5bd9a830fbea7b72e $

Field Summary

Modifier and TypeField and Description
public static final int
ASDU_TOO_LONG

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

public static final int
DEFRAG_DEFERRED

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

public static final int
DEFRAG_UNSUPPORTED

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

public static final int
ILLEGAL_REQUEST

A parameter value was out of range.

public static final int
INVALID_BINDING

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

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.

public static final int
INVALID_PARAMETER

A parameter value was invalid or out of range.

public static final int
NO_ACK

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

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.

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.

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.

public static final int
SECURED_NWK_KEY

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

public static final int
SECURITY_FAIL

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

private static final long
public static final int
SUCCESS

A request has been executed successfully.

public static final int
TABLE_FULL

An APSME-BIND.request or APSME.ADDGROUP.

public static final int
UNSECURED

An ASDU was received without any security.

public static final int
UNSUPPORTED_ATTRIBUTE

An APSME-GET.request or APSMESET.

Inherited from org.osgi.service.zigbee.ZigBeeException:
errorCodeOSGI_EXISTING_IDOSGI_MULTIPLE_HOSTSTIMEOUTUNKNOWN_ERRORzigBeeErrorCode

Constructor Summary

AccessConstructor and Description
public
APSException(String
exception an error description.
errorDesc
)

Creates a APSException containing only a description, but no error codes.

public
APSException(int
One of the error codes defined in this interface or 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 UNKNOWN_ERROR as first parameter and the native ZigBee error as the second.
errorCode
,
String
An error description which explain the type of problem.
errorDesc
)

Creates a APSException containing a specific errorCode.

public
APSException(int
One of the error codes defined in this interface or 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.
errorCode
,
int
The actual APS status code or UNKNOWN_ERROR if this status is unknown.
zigBeeErrorCode
,
String
An error description which explain the type of problem.
errorDesc
)

Creates a APSException containing a specific errorCode or zigBeeErrorCode.

Method Summary

Inherited from org.osgi.service.zigbee.ZigBeeException:
getErrorCodegetZigBeeErrorCodehasZigBeeErrorCode

Field Detail

ASDU_TOO_LONGback to summary
public static final int ASDU_TOO_LONG

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

DEFRAG_DEFERREDback to summary
public static final int DEFRAG_DEFERRED

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

DEFRAG_UNSUPPORTEDback to summary
public static final int DEFRAG_UNSUPPORTED

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

ILLEGAL_REQUESTback to summary
public static final int ILLEGAL_REQUEST

A parameter value was out of range.

INVALID_BINDINGback to summary
public static final int INVALID_BINDING

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

INVALID_GROUPback to summary
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.

INVALID_PARAMETERback to summary
public static final int INVALID_PARAMETER

A parameter value was invalid or out of range.

NO_ACKback to summary
public static final int NO_ACK

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

NO_BOUND_DEVICEback to summary
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.

NO_SHORT_ADDRESSback to summary
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.

NOT_SUPPORTEDback to summary
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.

SECURED_NWK_KEYback to summary
public static final int SECURED_NWK_KEY

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

SECURITY_FAILback to summary
public static final int SECURITY_FAIL

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

serialVersionUIDback to summary
private static final long serialVersionUID

Hides org.osgi.service.zigbee.ZigBeeException.serialVersionUID.

SUCCESSback to summary
public static final int SUCCESS

A request has been executed successfully.

TABLE_FULLback to summary
public static final int TABLE_FULL

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

UNSECUREDback to summary
public static final int UNSECURED

An ASDU was received without any security.

UNSUPPORTED_ATTRIBUTEback to summary
public static final int UNSUPPORTED_ATTRIBUTE

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

Constructor Detail

APSExceptionback to summary
public APSException(String errorDesc)

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

Parameters
errorDesc:String

exception an error description.

APSExceptionback to summary
public APSException(int errorCode, String errorDesc)

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

Parameters
errorCode:int

One of the error codes defined in this interface or 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 UNKNOWN_ERROR as first parameter and the native ZigBee error as the second.

errorDesc:String

An error description which explain the type of problem.

APSExceptionback to summary
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 UNKNOWN_ERROR is equivalent to call APSException(String).

Parameters
errorCode:int

One of the error codes defined in this interface or 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:int

The actual APS status code or UNKNOWN_ERROR if this status is unknown.

errorDesc:String

An error description which explain the type of problem.