com.adobe.flashaccess.sdk.protocol
Class RequestMessageBase

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

Direct Known Subclasses:

AuthenticationRequestMessage, LicenseRequestMessage

public abstract class RequestMessageBase
extends AbstractRequestMessage

This class contains a request message from the client.

Field Summary

static int

SERVER_CONFIG_NOT_PRESENT Indicates that the server configuration data version was not sent in the request.

Method Summary

AuthenticationToken	getAuthenticationToken() Retrieves the authentication token sent by the client.
ClientState	getClientState() Retrieves the client state information.
MachineToken	getMachineToken() Retrieves the machine token for the machine requesting the license.
byte[]	getRawAuthenticationToken() Retrieves the raw authentication token bytes sent by the client.
int	getServerConfigVersion() Retrieves the version of the server configuration currently cached on client.

Methods inherited from class com.adobe.flashaccess.sdk.protocol.AbstractRequestMessage

getClientLocale, getErrorData, getMessageId, setErrorData

Methods inherited from class java.lang.Object

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

Field Detail

SERVER_CONFIG_NOT_PRESENT

public static final int SERVER_CONFIG_NOT_PRESENT

Indicates that the server configuration data version was not sent in the request.

See Also:

Constant Field Values

Method Detail

getServerConfigVersion

public int getServerConfigVersion()

Retrieves the version of the server configuration currently cached on client. If the version is present and is less than the version of the server configuration data, the updated configuration information will automatically be sent to the client in the response.

Returns:

the version of the server configuration currently cached on client, or RequestMessageBase.SERVER_CONFIG_NOT_PRESENT if the version information was not included in the request.

getClientState

public ClientState getClientState()

Retrieves the client state information. The server may choose to examine and store this information to perform advanced tamper detection.

Returns:

The client state information, or null if no state information was provided in the request.

getAuthenticationToken

public AuthenticationToken getAuthenticationToken()
                                           throws InvalidAuthTokenException

Retrieves the authentication token sent by the client. The token is validated before it is returned.

Returns:

The authentication token sent by the client, or null if no token was provided.

Throws:

InvalidAuthTokenException - if the token is found to be invalid (the token is expired or has been tampered with).

UnknownAuthTokenFormatException - if the token format is not recognized by the Flash Access SDK. Use RequestMessageBase.getRawAuthenticationToken() to retrieve custom authentication tokens

getRawAuthenticationToken

public byte[] getRawAuthenticationToken()

Retrieves the raw authentication token bytes sent by the client. Use this method if the client is using a custom authentication token format not generated by the Flash Access SDK. If a custom authentication token format is used, it is the server's responsibility to validate the authentication token and enforce the token expiration date, if applicable.

Returns:

The authentication token sent by the client, or null if no token was provided.

getMachineToken

public MachineToken getMachineToken()

Retrieves the machine token for the machine requesting the license. The machine token must be present in the request.

Returns:

The machine token for the machine requesting the license.