com.sun.slamd.message
Class KeepAliveMessage

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

public class KeepAliveMessage

extends Message

This class defines a keepalive message that is used to ensure that a connection is still alive, and in some cases to ensure that the connection does not get closed (e.g., if a firewall between the client and server automatically closes idle connections).

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

KeepAliveMessage(int messageID)
Creates a new keepalive message.

Method Summary

static KeepAliveMessage	decodeKeepAlive(int messageID, ASN1Element element) Decodes the provided ASN.1 element as a keepalive 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

KeepAliveMessage

public KeepAliveMessage(int messageID)

Creates a new keepalive message.

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.

decodeKeepAlive

public static KeepAliveMessage decodeKeepAlive(int messageID,
                                               ASN1Element element)
                                        throws SLAMDException

Decodes the provided ASN.1 element as a keepalive message.

Parameters:

messageID - The message ID to use for this message.

element - The ASN.1 keepalive element.

Returns:

The keepalive message decoded from the ASN.1 element.

Throws:

SLAMDException - If the provided ASN.1 element cannot be decoded as a keepalive message.

encode

public ASN1Element encode()

Encodes this message into an ASN.1 element. A keepalive message has the following syntax:

KeepAlive ::= [APPLICATION 11] NULL

Specified by:

encode in class Message

Returns:

An ASN.1 encoded representation of this message.