Class ErrorReason
An application can check whether an ErrorReason is equal to some expected
value using Object.equals(Object)
. Equality is derived from the
reasonCode
, with instances with equal codes
considered equal.
Some common ErrorReason values are defined as constants in this class. More
specific reasons may be defined by individual
features
.
- Since:
- 5.1
- Author:
- DiffusionData Limited
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final ErrorReason
The request was rejected because the caller has insufficient permissions.static final ErrorReason
An application callback threw an exception.static final ErrorReason
A cluster operation failed because partition ownership changed during processing.static final ErrorReason
A cluster operation failed to be routed to a server within the cluster due to a communication failure, or the server that owns a partition is not currently known.static final ErrorReason
Communication with the server failed.static final ErrorReason
A conflicting registration exists.static final ErrorReason
A datatype operation has failed due to incompatibility.static final ErrorReason
A topic update could not be performed because the topic is managed by a component (for example, fan-out) which prohibits external updates.static final ErrorReason
An operation failed because invalid data was received.static final ErrorReason
An invalid path was supplied.static final ErrorReason
The session does not exist on the server.static final ErrorReason
Communication with the server failed because a service request timed out.static final ErrorReason
Communication with the server failed because the session is closed.static final ErrorReason
A conflicting registration exists on the same branch of the topic tree.static final ErrorReason
A message was not handled by the server.static final ErrorReason
The request was rejected because the requested service is unsupported for this caller. -
Constructor Summary
Constructors -
Method Summary
-
Field Details
-
COMMUNICATION_FAILURE
Communication with the server failed. -
SESSION_CLOSED
Communication with the server failed because the session is closed. -
REQUEST_TIME_OUT
Communication with the server failed because a service request timed out. -
ACCESS_DENIED
The request was rejected because the caller has insufficient permissions. -
UNSUPPORTED
The request was rejected because the requested service is unsupported for this caller.- Since:
- 5.9
-
CALLBACK_EXCEPTION
An application callback threw an exception. Check logs for more information.- Since:
- 5.9
-
INVALID_DATA
An operation failed because invalid data was received.- Since:
- 6.0
-
NO_SUCH_SESSION
The session does not exist on the server.- Since:
- 6.0
-
INCOMPATIBLE_DATATYPE
A datatype operation has failed due to incompatibility.- Since:
- 6.0
-
UNHANDLED_MESSAGE
A message was not handled by the server.- Since:
- 6.0
-
CLUSTER_REPARTITION
A cluster operation failed because partition ownership changed during processing.This is a transient error that occurs while the cluster is recovering from failure. The session can retry the operation.
- Since:
- 6.0
- See Also:
-
INCOMPATIBLE_STATE
A topic update could not be performed because the topic is managed by a component (for example, fan-out) which prohibits external updates.- Since:
- 6.0
-
CLUSTER_ROUTING
A cluster operation failed to be routed to a server within the cluster due to a communication failure, or the server that owns a partition is not currently known.This is a transient error that occurs while the cluster is recovering from failure. The session can retry the operation.
- Since:
- 6.5
- See Also:
-
TOPIC_TREE_REGISTRATION_CONFLICT
A conflicting registration exists on the same branch of the topic tree. -
HANDLER_CONFLICT
A conflicting registration exists. -
INVALID_PATH
An invalid path was supplied.
-
-
Constructor Details
-
ErrorReason
Constructor.Application code should prefer pre-defined constants such as
COMMUNICATION_FAILURE
, rather than calling this.- Parameters:
reasonCode
- a unique codedescription
- a description of the reason, may be context-specific
-
-
Method Details
-
getReasonCode
public int getReasonCode()A code that uniquely identifies this reason.Applications should rarely need to call this method and prefer
equals(Object)
to compare instances for equality.Reasons defined by DiffusionData have reason codes in the range 0 to 65535 inclusive.
- Returns:
- the code
-
getDescription
Description of the error reason, may be context-specific.- Returns:
- the description
-
hashCode
public int hashCode() -
equals
-
toString
-