public class ErrorMessage extends AcknowledgeMessage
ErrorMessage
- The ErrorMessage class is used to report errors
within the messaging system.
An error message only occurs in response to a message sent within the system.Modifier and Type | Field and Description |
---|---|
java.lang.Object |
extendedData
Extended data that the remote destination has chosen to associate with
this error to facilitate custom error processing on the client.
|
java.lang.String |
faultCode
The fault code for the error.
|
java.lang.String |
faultDetail
Detailed description of what caused the error.
|
java.lang.String |
faultString
A simple description of the error.
|
static java.lang.String |
MESSAGE_DELIVERY_IN_DOUBT
MESSAGE_DELIVERY_IN_DOUBT - "Client.Error.DeliveryInDoubt" :
if a message may not have been delivered, the faultCode will contain this constant. |
static java.lang.String |
RETRYABLE_HINT_HEADER
RETRYABLE_HINT_HEADER - "DSRetryableErrorHint" :
header name for the retryable hint header. |
java.lang.Object |
rootCause
Should a root cause exist for the error, this property contains those details.
|
ERROR_HINT_HEADER
correlationId, SUBTOPIC_HEADER
body, clientId, destination, DESTINATION_CLIENT_ID_HEADER, ENDPOINT_HEADER, FLEX_CLIENT_ID_HEADER, headers, messageId, PRIORITY_HEADER, REMOTE_CREDENTIALS_CHARSET_HEADER, REMOTE_CREDENTIALS_HEADER, REQUEST_TIMEOUT_HEADER, STATUS_CODE_HEADER, timestamp, timeToLive
Constructor and Description |
---|
ErrorMessage()
Constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
readExternal(java.io.ObjectInput in) |
void |
writeExternal(java.io.ObjectOutput out) |
createUUID, readFlags
public static final java.lang.String MESSAGE_DELIVERY_IN_DOUBT
MESSAGE_DELIVERY_IN_DOUBT
- "Client.Error.DeliveryInDoubt" :
if a message may not have been delivered, the faultCode will contain this constant.public static final java.lang.String RETRYABLE_HINT_HEADER
RETRYABLE_HINT_HEADER
- "DSRetryableErrorHint" :
header name for the retryable hint header.public java.lang.Object extendedData
public java.lang.String faultCode
public java.lang.String faultDetail
public java.lang.String faultString
public java.lang.Object rootCause
public void readExternal(java.io.ObjectInput in) throws java.io.IOException, java.lang.ClassNotFoundException
readExternal
in interface java.io.Externalizable
readExternal
in class AcknowledgeMessage
java.io.IOException
java.lang.ClassNotFoundException
public void writeExternal(java.io.ObjectOutput out) throws java.io.IOException
writeExternal
in interface java.io.Externalizable
writeExternal
in class AcknowledgeMessage
java.io.IOException