com.adobe.flashaccess.sdk.protocol
Class AbstractRequestMessage

java.lang.Object
  com.adobe.flashaccess.sdk.protocol.AbstractRequestMessage

Direct Known Subclasses:

RequestMessageBase

public abstract class AbstractRequestMessage
extends java.lang.Object

This class contains a request message from the client.

Method Summary

java.util.Locale	getClientLocale() Retrieves the client's locale, which may be used to provide localized error messages.
ErrorData	getErrorData() Retrieves the error information to include in the response.
java.lang.String	getMessageId() Retrieves the message identifier (a random identifier generated by client for each request).
void	setErrorData(ErrorData error) Sets the error information to include in the response.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getClientLocale

public java.util.Locale getClientLocale()

Retrieves the client's locale, which may be used to provide localized error messages. This method may return null if parseRequest() has not been called or if parsing was not successful.

Returns:

locale

getMessageId

public java.lang.String getMessageId()

Retrieves the message identifier (a random identifier generated by client for each request). The server may choose to store message identifiers for a limited amount of time in order to detect replay attacks (message identifiers only need to be tracked until the request expires. This method may return null if parseRequest() has not been called or if parsing was not successful.

Returns:

The message identifier.

See Also:

HandlerConfiguration.setTimestampTolerance(int)

setErrorData

public void setErrorData(ErrorData error)

Sets the error information to include in the response.

Parameters:

error - The error data to include in the response.

getErrorData

public ErrorData getErrorData()

Retrieves the error information to include in the response.

Returns:

The error data, or null if there is no error.