com.sun.slamd.message
Class StatusRequestMessage

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

public class StatusRequestMessage

extends Message

This class defines a message type that the server can use to request status information from a client. It can be a request about just the availability of the client or also about the status of a job that may be in progress.

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

StatusRequestMessage(int messageID)
Creates a new status request message that is intended only to determine the current status of the client.

StatusRequestMessage(int messageID, java.lang.String jobID)
Creates a new status request message that is intended to find information about the specified job.

Method Summary

static StatusRequestMessage	decodeStatusRequest(int messageID, ASN1Element element) Decodes the provided ASN.1 element as a status request message.
ASN1Element	encode() Encodes this message into an ASN.1 element.
java.lang.String	getJobID() Retrieves the ID of the job for which to find status information.
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

StatusRequestMessage

public StatusRequestMessage(int messageID)

Creates a new status request message that is intended only to determine the current status of the client.

Parameters:

messageID - The message ID for this message.

StatusRequestMessage

public StatusRequestMessage(int messageID,
                            java.lang.String jobID)

Creates a new status request message that is intended to find information about the specified job.

Parameters:

messageID - The message ID for this message.

jobID - The ID of the job for which to retrieve status information.

Method Detail

getJobID

public java.lang.String getJobID()

Retrieves the ID of the job for which to find status information.

Returns:

The ID of the job for which to find status information.

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.

decodeStatusRequest

public static StatusRequestMessage decodeStatusRequest(int messageID,
                                                       ASN1Element element)
                                                throws SLAMDException

Decodes the provided ASN.1 element as a status request message.

Parameters:

messageID - The message ID to use for this message.

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

Returns:

The status request message decoded from the ASN.1 element.

Throws:

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

encode

public ASN1Element encode()

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

StatusRequest ::= [APPLICATION 8] SEQUENCE { jobID OCTET STRING OPTIONAL }

Specified by:

encode in class Message

Returns:

An ASN.1 encoded representation of this message.