com.sun.slamd.message
Class RegisterStatisticMessage

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

public class RegisterStatisticMessage

extends Message

This class defines a message that clients will use to register statistics with the SLAMD server's real-time stat colleciton facility.

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

RegisterStatisticMessage(int messageID, java.lang.String jobID, java.lang.String clientID, java.lang.String threadID, java.lang.String displayName)
Creates a new register statistic message with the provided information.

Method Summary

static RegisterStatisticMessage	decodeRegisterStatMessage(int messageID, ASN1Element element) Decodes the provided ASN.1 element as a register statistic message.
ASN1Element	encode() Encodes this message into an ASN.1 element.
java.lang.String	getClientID() Retrieves the ID of the client that registered this statistic.
java.lang.String	getDisplayName() Retrieves the display name of the statistic being registered.
java.lang.String	getJobID() Retrieves the job ID of the job to which this message applies.
java.lang.String	getThreadID() Retrieves the ID of the client thread that registered this statistic.
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

RegisterStatisticMessage

public RegisterStatisticMessage(int messageID,
                                java.lang.String jobID,
                                java.lang.String clientID,
                                java.lang.String threadID,
                                java.lang.String displayName)

Creates a new register statistic message with the provided information.

Parameters:

messageID - The message ID to use for this message.

jobID - The ID of the job with which the message is associated.

clientID - The ID of the client registering the statistic.

threadID - The ID of the client thread registering the statistic.

displayName - The display name of the statistic being registered.

Method Detail

getJobID

public java.lang.String getJobID()

Retrieves the job ID of the job to which this message applies.

Returns:

The job ID of the job to which this message applies.

getClientID

public java.lang.String getClientID()

Retrieves the ID of the client that registered this statistic.

Returns:

The ID of the client that registered this statistic.

getThreadID

public java.lang.String getThreadID()

Retrieves the ID of the client thread that registered this statistic.

Returns:

The ID of the client thread that registered this statistic.

getDisplayName

public java.lang.String getDisplayName()

Retrieves the display name of the statistic being registered.

Returns:

The display name of the statistic being registered.

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.

decodeRegisterStatMessage

public static RegisterStatisticMessage decodeRegisterStatMessage(int messageID,
                                                                 ASN1Element element)
                                                          throws SLAMDException

Decodes the provided ASN.1 element as a register statistic message.

Parameters:

messageID - The message ID to use for this message.

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

Returns:

The register statistic message decoded from the ASN.1 element.

Throws:

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

encode

public ASN1Element encode()

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

RegisterStat ::= [APPLICATION 19] SEQUENCE {
jobID OCTET STRING,
clientID OCTET STRING,
threadID OCTET STRING,
displayName OCTET STRING }

Specified by:

encode in class Message

Returns:

An ASN.1 encoded representation of this message.