com.sun.slamd.message
Class StopClientResponseMessage

java.lang.Object
  com.sun.slamd.message.Message
      com.sun.slamd.message.StopClientResponseMessage

public class StopClientResponseMessage

extends Message

This class defines a message that will be sent as a response to a stop client message. It provides a response code that indicates whether the request was processed successfully, or if not the reason that it was not successful. It may also optionally contain a message explaining the reason for the failure.

Field Summary

Fields inherited from class com.sun.slamd.message.Message

ASN1_TYPE_CLASS_TRANSFER_REQUEST, ASN1_TYPE_CLASS_TRANSFER_RESPONSE, ASN1_TYPE_CLIENT_HELLO, ASN1_TYPE_CLIENT_MANAGER_HELLO, ASN1_TYPE_HELLO_RESPONSE, ASN1_TYPE_JOB_COMPLETED, ASN1_TYPE_JOB_CONTROL_REQUEST, ASN1_TYPE_JOB_CONTROL_RESPONSE, ASN1_TYPE_JOB_REQUEST, ASN1_TYPE_JOB_RESPONSE, ASN1_TYPE_KEEPALIVE, ASN1_TYPE_REGISTER_STAT, ASN1_TYPE_REPORT_STAT, ASN1_TYPE_SERVER_HELLO, ASN1_TYPE_SERVER_SHUTDOWN, ASN1_TYPE_START_CLIENT_REQUEST, ASN1_TYPE_START_CLIENT_RESPONSE, ASN1_TYPE_STATUS_REQUEST, ASN1_TYPE_STATUS_RESPONSE, ASN1_TYPE_STOP_CLIENT_REQUEST, ASN1_TYPE_STOP_CLIENT_RESPONSE, messageID

Constructor Summary

StopClientResponseMessage(int messageID, int responseCode)
Creates a new stop client response message with the specified response code.

StopClientResponseMessage(int messageID, int responseCode, java.lang.String responseMessage)
Creates a new stop client response message with the specified response code and message

Method Summary

static StopClientResponseMessage	decodeStopClientResponse(int messageID, ASN1Element element) Decodes the provided ASN.1 element as a stop client response message.
ASN1Element	encode() Encodes this message into an ASN.1 element.
int	getResponseCode() Retrieves the response code associated with this message.
java.lang.String	getResponseMessage() Retrieves the text message included in this stop client response.
java.lang.String	toString() Retrieves a string representation of this message.

Methods inherited from class com.sun.slamd.message.Message

decode, getMessageID, getMessageType, send

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

StopClientResponseMessage

public StopClientResponseMessage(int messageID,
                                 int responseCode)

Creates a new stop client response message with the specified response code. It will not contain a response message.

Parameters:

messageID - The message ID for this message.

responseCode - The response code to include in this response message.

StopClientResponseMessage

public StopClientResponseMessage(int messageID,
                                 int responseCode,
                                 java.lang.String responseMessage)

Creates a new stop client response message with the specified response code and message

Parameters:

messageID - The message ID for this message.

responseCode - The response code to include in this response message.

responseMessage - The text to include in this response message.

Method Detail

getResponseCode

public int getResponseCode()

Retrieves the response code associated with this message. The value will be that of one of the MESSAGE_RESPONSE_* constants.

Returns:

The response code associated with this response message.

getResponseMessage

public java.lang.String getResponseMessage()

Retrieves the text message included in this stop client response.

Returns:

The text message included in this stop client response.

toString

public java.lang.String toString()

Retrieves a string representation of this message.

Overrides:

toString in class Message

Returns:

A string representation of this message.

decodeStopClientResponse

public static StopClientResponseMessage decodeStopClientResponse(int messageID,
                                                                 ASN1Element element)
                                                          throws SLAMDException

Decodes the provided ASN.1 element as a stop client response message.

Parameters:

messageID - The message ID to use for this message.

element - The ASN.1 element containing the StopClientResponse sequence.

Returns:

The stop client response message decoded from the ASN.1 element.

Throws:

SLAMDException - If the provided ASN.1 element cannot be decoded as a stop client response message.

encode

public ASN1Element encode()

Encodes this message into an ASN.1 element. A stop client response message has the following syntax:

StopClientResponse ::= [APPLICATION 16] SEQUENCE { responseCode ResponseCode, responseMessage OCTET STRING }

Specified by:

encode in class Message

Returns:

An ASN.1 encoded representation of this message.