com.sun.slamd.protocol
Class ClientUpgradeRequest

java.lang.Object
  com.sun.slamd.protocol.SLAMDMessage
      com.sun.slamd.protocol.ClientUpgradeRequest

public class ClientUpgradeRequest
extends SLAMDMessage

This class defines a SLAMD message that will be sent from the client to the server whenever the server version is newer than the client version. This will prompt the server to send the client a JAR file containing the updated client code.

Author:

Neil A. Wilson

Constructor Summary

ClientUpgradeRequest()
Creates a new instance of this client upgrade request message which is intended for use in decoding a message transmitted between the server and the client.

ClientUpgradeRequest(int messageID, java.util.HashMap extraProperties, java.lang.String upgradeFile)
Creates a new instance of this client upgrade request message with the provided information.

Method Summary

void	decodeMessagePayload(ASN1Element payloadElement) Decodes the provided ASN.1 element and uses it as the payload for this SLAMD message.
ASN1Element	encodeMessagePayload() Encodes the payload component of this SLAMD message to an ASN.1 element for inclusion in the message envelope.
java.lang.String	getUpgradeFile() Retrieves the filename (without any path information) for the upgrade JAR file being requested.
void	payloadToString(java.lang.StringBuffer buffer, int indent) Appends a string representation of the payload for this SLAMD message to the provided buffer.
void	setUpgradeFile(java.lang.String upgradeFile) Specifies the filename (without any path information) for the upgrade JAR file being requested.

Methods inherited from class com.sun.slamd.protocol.SLAMDMessage

decode, decodeNameValuePair, decodeNameValuePairSequence, encode, encodeNameValuePair, getExtraProperties, getExtraProperty, getMessageID, toString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientUpgradeRequest

public ClientUpgradeRequest()

Creates a new instance of this client upgrade request message which is intended for use in decoding a message transmitted between the server and the client. It is not intended for general use.

ClientUpgradeRequest

public ClientUpgradeRequest(int messageID,
                            java.util.HashMap extraProperties,
                            java.lang.String upgradeFile)

Creates a new instance of this client upgrade request message with the provided information.

Parameters:

messageID - The message ID for this SLAMD message.

extraProperties - The "extra" properties for this SLAMD message. Both the names and values for the properties must be strings.

upgradeFile - The filename (without any path information) for the upgrade JAR file being requested.

Method Detail

getUpgradeFile

public java.lang.String getUpgradeFile()

Retrieves the filename (without any path information) for the upgrade JAR file being requested.

Returns:

The filename for the upgrade JAR file being requested.

setUpgradeFile

public void setUpgradeFile(java.lang.String upgradeFile)

Specifies the filename (without any path information) for the upgrade JAR file being requested.

Parameters:

upgradeFile - The filename for the upgrade JAR file being requested.

encodeMessagePayload

public ASN1Element encodeMessagePayload()

Encodes the payload component of this SLAMD message to an ASN.1 element for inclusion in the message envelope.

Specified by:

encodeMessagePayload in class SLAMDMessage

Returns:

The ASN.1 element containing the encoded message payload.

decodeMessagePayload

public void decodeMessagePayload(ASN1Element payloadElement)
                          throws SLAMDException

Decodes the provided ASN.1 element and uses it as the payload for this SLAMD message.

Specified by:

decodeMessagePayload in class SLAMDMessage

Parameters:

payloadElement - The ASN.1 element to decode as the payload for this SLAMD message.

Throws:

SLAMDException - If a problem occurs while attempting to decode the provided ASN.1 element as the payload for this SLAMD message.

payloadToString

public void payloadToString(java.lang.StringBuffer buffer,
                            int indent)

Appends a string representation of the payload for this SLAMD message to the provided buffer. The string representation may contain multiple lines, but the last line should not end with an end-of-line marker.

Specified by:

payloadToString in class SLAMDMessage

Parameters:

buffer - The buffer to which the string representation is to be appended.

indent - The number of spaces to indent the payload content.