com.sun.slamd.protocol
Class ClientUpgradeResponse

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

public class ClientUpgradeResponse
extends SLAMDMessage

This class defines a SLAMD message that will be sent from the server to the client in response to an upgrade request. It will include a result code, and either the requested upgrade file or an error message.

Author:

Neil A. Wilson

Constructor Summary

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

ClientUpgradeResponse(int messageID, java.util.HashMap extraProperties, int resultCode, java.lang.String errorMessage, byte[] upgradeFileData)
Creates a new instance of this client upgrade response 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	getErrorMessage() Retrieves the error message for the client upgrade operation.
int	getResultCode() Retrieves the result code for the client upgrade operation.
byte[]	getUpgradeFileData() Retrieves the data for the requested upgrade file.
void	payloadToString(java.lang.StringBuffer buffer, int indent) Appends a string representation of the payload for this SLAMD message to the provided buffer.
void	setErrorMessage(java.lang.String errorMessage) Specifies the error message for the client upgrade operation.
void	setResultCode(int resultCode) Specifies the result code for the client upgrade operation.
void	setUpgradeFileData(byte[] upgradeFileData) Specifies the data for the requested upgrade file.

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

ClientUpgradeResponse

public ClientUpgradeResponse()

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

ClientUpgradeResponse

public ClientUpgradeResponse(int messageID,
                             java.util.HashMap extraProperties,
                             int resultCode,
                             java.lang.String errorMessage,
                             byte[] upgradeFileData)

Creates a new instance of this client upgrade response 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.

resultCode - The result code for the client upgrade operation.

errorMessage - The error message for the client upgrade operation.

upgradeFileData - The data for the requested upgrade file.

Method Detail

getResultCode

public int getResultCode()

Retrieves the result code for the client upgrade operation.

Returns:

The result code for the client upgrade operation.

setResultCode

public void setResultCode(int resultCode)

Specifies the result code for the client upgrade operation.

Parameters:

resultCode - The result code for the client upgrade operation.

getErrorMessage

public java.lang.String getErrorMessage()

Retrieves the error message for the client upgrade operation.

Returns:

The error message for the client upgrade operation, or null if none was provided.

setErrorMessage

public void setErrorMessage(java.lang.String errorMessage)

Specifies the error message for the client upgrade operation.

Parameters:

errorMessage - The error message for the client upgrade operation.

getUpgradeFileData

public byte[] getUpgradeFileData()

Retrieves the data for the requested upgrade file.

Returns:

The data for the requested upgrade file, or null if it was not provided.

setUpgradeFileData

public void setUpgradeFileData(byte[] upgradeFileData)

Specifies the data for the requested upgrade file.

Parameters:

upgradeFileData - The data for the requested upgrade file.

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.