com.sun.slamd.message
Class ServerShutdownMessage

java.lang.Object
  extended bycom.sun.slamd.message.Message
      extended bycom.sun.slamd.message.ServerShutdownMessage

public class ServerShutdownMessage
extends Message

This class defines a message type that the server uses to indicate that it is shutting down and that the connection to the client will be terminated.


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
ServerShutdownMessage(int messageID)
          Creates a new message type that the server uses to indicate that it is shutting down.
 
Method Summary
static ServerShutdownMessage decodeShutdown(int messageID, ASN1Element element)
          Decodes the provided ASN.1 element as a server shutdown message.
 ASN1Element encode()
          Encodes this message into an ASN.1 element.
 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

ServerShutdownMessage

public ServerShutdownMessage(int messageID)
Creates a new message type that the server uses to indicate that it is shutting down.

Parameters:
messageID - The message ID for this message.
Method Detail

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.

decodeShutdown

public static ServerShutdownMessage decodeShutdown(int messageID,
                                                   ASN1Element element)
                                            throws SLAMDException
Decodes the provided ASN.1 element as a server shutdown message.

Parameters:
messageID - The message ID to use for this message.
element - The ASN.1 server shutdown element.
Returns:
The server shutdown message decoded from the ASN.1 element.
Throws:
SLAMDException - If the provided ASN.1 element cannot be decoded as a server shutdown message.

encode

public ASN1Element encode()
Encodes this message into an ASN.1 element. A server shutdown message has the following syntax:

ServerShutdown ::= [APPLICATION 10] NULL

Specified by:
encode in class Message
Returns:
An ASN.1 encoded representation of this message.