com.metamatrix.platform.security.api.service
Interface AuthenticationToken

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
FailedAuthenticationToken, SuccessfulAuthenticationToken

public interface AuthenticationToken
extends java.io.Serializable

Interface AuthenticationToken.


Method Summary
 java.io.Serializable getPayload()
          Get the payload token that has been successfully authentcated by a membership domain.
 java.lang.String getUserName()
          Get the exact username of the authenticated user as it is known to the authenticating membership domain.
 boolean isAuthenticated()
          Find out whether or not the user was authenticated.
 

Method Detail

getPayload

java.io.Serializable getPayload()
Get the payload token that has been successfully authentcated by a membership domain.

Returns:
The successfully authenticated token unmodified.

getUserName

java.lang.String getUserName()
Get the exact username of the authenticated user as it is known to the authenticating membership domain.
Will be null if the user was not authenticated.

Returns:
The username (including case) of this authenticated user exactly as it is known by the authenticating memebership domain.
Since:
5.0

isAuthenticated

boolean isAuthenticated()
Find out whether or not the user was authenticated.

Returns:
true iff the membership domain was able to authenticate this user.
Since:
5.0


Copyright © 2009. All Rights Reserved.