com.adobe.flashaccess.sdk.protocol.authentication
Class AuthenticationRequestMessage

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

public final class AuthenticationRequestMessage
extends RequestMessageBase

An authentication request. To process an authentication request, call AuthenticationRequestMessage.getUserCredentials() to examine the credentials sent by the client (for example, the user's user name and password). If the credentials are valid, call AuthenticationRequestMessage.generateAuthToken(Date, ApplicationProperties); otherwise, call AbstractRequestMessage.setErrorData(com.adobe.flashaccess.sdk.protocol.ErrorData) and provide the error information.

Field Summary

Fields inherited from class com.adobe.flashaccess.sdk.protocol.RequestMessageBase

SERVER_CONFIG_NOT_PRESENT

Method Summary

AuthenticationToken	generateAuthToken(java.util.Date expiration, ApplicationProperties customData) Generates a signed authentication token for the specified user.
AuthenticationData	getUserCredentials() Retrieves authentication data from an authentication request.

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

getAuthenticationToken, getClientState, getMachineToken, getRawAuthenticationToken, getServerConfigVersion

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

Method Detail

getUserCredentials

public AuthenticationData getUserCredentials()

Retrieves authentication data from an authentication request.

Returns:

The authentication data from an authentication request.

generateAuthToken

public AuthenticationToken generateAuthToken(java.util.Date expiration,
                                             ApplicationProperties customData)
                                      throws InvalidAuthTokenException

Generates a signed authentication token for the specified user. Application-specific properties may be added to the token. This method returns the token that will be sent in the response when AuthenticationHandler sends its authentication response if getErrorData() returns null. If this method is called multiple times, only the last authentication token is returned to the user.

Parameters:

expiration - The expiration information for the authentication token.

customData - (Optional). Custom application-defined properties for the authentication token.

Returns:

The authentication token which will be sent to the user.

Throws:

InvalidAuthTokenException - if the expiration data or the user information is missing.