Class AuthenticationRequestMessage

  extended by com.adobe.flashaccess.sdk.protocol.AbstractRequestMessage
      extended by com.adobe.flashaccess.sdk.protocol.RequestMessageBase
          extended by 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
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


public AuthenticationData getUserCredentials()
Retrieves authentication data from an authentication request.

The authentication data from an authentication request.


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.

expiration - The expiration information for the authentication token.
customData - (Optional). Custom application-defined properties for the authentication token.
The authentication token which will be sent to the user.
InvalidAuthTokenException - if the expiration data or the user information is missing.

[an error occurred while processing this directive] [an error occurred while processing this directive]