com.metamatrix.platform.security.api.service
Class FailedAuthenticationToken

java.lang.Object
  com.metamatrix.platform.security.api.service.FailedAuthenticationToken

All Implemented Interfaces:

AuthenticationToken, java.io.Serializable

public final class FailedAuthenticationToken
extends java.lang.Object
implements AuthenticationToken

FailedAuthenticationToken

Marker indicating failed authentication attempt. Membership SPI domain implementations should wrap the Serializable payload in an instance of this class to signify to the Membgership service that the domian failed to authenticate the given payload token.

This wrapper class will not be exposed outside of the Mebership framework.

See Also:

Serialized Form

Constructor Summary

FailedAuthenticationToken()
FailedAuthenticationToken

Method Summary

java.io.Serializable	getPayload() Get the payload token that failed to authentcation 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() The attempt to authenticate the given payload failed.

Methods inherited from class java.lang.Object

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

Constructor Detail

FailedAuthenticationToken

public FailedAuthenticationToken()

FailedAuthenticationToken

Parameters:

payload - The failed authentication token - may be null.

Method Detail

getPayload

public java.io.Serializable getPayload()

Get the payload token that failed to authentcation by a membership domain.

Specified by:

getPayload in interface AuthenticationToken

Returns:

The failed authentication token unmodified - may be null.

getUserName

public 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.

Specified by:

getUserName in interface AuthenticationToken

Returns:

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

Since:

5.0

isAuthenticated

public boolean isAuthenticated()

The attempt to authenticate the given payload failed.

Specified by:

isAuthenticated in interface AuthenticationToken

Returns:

false - always.