com.opendxl.client.message

Class ErrorResponse

java.lang.Object

com.opendxl.client.message.Message

com.opendxl.client.message.Response

com.opendxl.client.message.ErrorResponse

public class ErrorResponse
extends Response

ErrorResponse messages are sent by the DXL fabric itself or service instances upon receiving Request messages. The error response may indicate the inability to locate a service to handle the request or an internal error within the service itself. Error response messages are sent using the DxlClient.sendResponse(com.opendxl.client.message.Response) method of a client instance.

Field Summary

Fields inherited from class com.opendxl.client.message.Message

CHARSET_ASCII, CHARSET_UTF8, MESSAGE_TYPE_ERROR, MESSAGE_TYPE_EVENT, MESSAGE_TYPE_REQUEST, MESSAGE_TYPE_RESPONSE, MESSAGE_VERSION

Constructor Summary

Constructors

Constructor and Description
ErrorResponse(DxlClient client, Request request, int errorCode, java.lang.String errorMessage) Constructor for ErrorResponse
ErrorResponse(Request request, int errorCode, java.lang.String errorMessage) Constructor for ErrorResponse
ErrorResponse(java.lang.String sourceClientId, Request request, int errorCode, java.lang.String errorMessage) Constructor for ErrorResponse

Method Summary

Modifier and Type	Method and Description
int	getErrorCode() Returns the numeric error code for the error response
java.lang.String	getErrorMessage() Returns the textual error message
byte	getMessageType() Returns the numeric type of the message

Methods inherited from class com.opendxl.client.message.Response

getRequest, getRequestMessageId, getServiceId

Methods inherited from class com.opendxl.client.message.Message

fromBytes, getBrokerIds, getClientIds, getDestinationTopic, getDestTenantGuids, getMessageId, getMessagePack, getOtherFields, getPayload, getSourceBrokerId, getSourceClientId, getSourceClientInstanceId, getSourceTenantGuid, getVersion, setBrokerIds, setClientIds, setDestinationTopic, setDestTenantGuids, setOtherFields, setPayload, setSourceClientId, setSourceClientInstanceId, setSourceTenantGuid, toBytes

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ErrorResponse

public ErrorResponse(DxlClient client,
                     Request request,
                     int errorCode,
                     java.lang.String errorMessage)

Constructor for ErrorResponse

Parameters:

client - The client that will be sending this response

request - The Request message that this will be a Response for

errorCode - The numeric error code

errorMessage - The textual error message

ErrorResponse

public ErrorResponse(Request request,
                     int errorCode,
                     java.lang.String errorMessage)

Constructor for ErrorResponse

Parameters:

request - The Request message that this will be a Response for

errorCode - The numeric error code

errorMessage - The textual error message

ErrorResponse

public ErrorResponse(java.lang.String sourceClientId,
                     Request request,
                     int errorCode,
                     java.lang.String errorMessage)

Constructor for ErrorResponse

Parameters:

sourceClientId - The ID of the client that will be sending this message.

request - The Request message that this will be a Response for

errorCode - The numeric error code

errorMessage - The textual error message

Method Detail

getErrorCode

public int getErrorCode()

Returns the numeric error code for the error response

Returns:

The numeric error code for the error response

getErrorMessage

public java.lang.String getErrorMessage()

Returns the textual error message

Returns:

The textual error message

getMessageType

public byte getMessageType()

Returns the numeric type of the message

Overrides:

getMessageType in class Response

Returns:

The numeric type of the message