org.springframework.security.providers.openid
Class OpenIDAuthenticationToken

java.lang.Object
  org.springframework.security.providers.AbstractAuthenticationToken
      org.springframework.security.providers.openid.OpenIDAuthenticationToken

All Implemented Interfaces:

Serializable, Principal, Authentication

public class OpenIDAuthenticationToken
extends AbstractAuthenticationToken

OpenID Authentication Token

Author:

Robin Bramley, Opsera Ltd

See Also:

Serialized Form

Constructor Summary

OpenIDAuthenticationToken(GrantedAuthority[] authorities, OpenIDAuthenticationStatus status, String identityUrl)
Created by the OpenIDAuthenticationProvider on successful authentication.

OpenIDAuthenticationToken(OpenIDAuthenticationStatus status, String identityUrl, String message)

Method Summary

Object	getCredentials() The credentials that prove the principal is correct.
String	getIdentityUrl()
String	getMessage()
Object	getPrincipal() The identity of the principal being authenticated.
OpenIDAuthenticationStatus	getStatus()

Methods inherited from class org.springframework.security.providers.AbstractAuthenticationToken

equals, getAuthorities, getDetails, getName, hashCode, isAuthenticated, setAuthenticated, setDetails, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OpenIDAuthenticationToken

public OpenIDAuthenticationToken(OpenIDAuthenticationStatus status,
                                 String identityUrl,
                                 String message)

OpenIDAuthenticationToken

public OpenIDAuthenticationToken(GrantedAuthority[] authorities,
                                 OpenIDAuthenticationStatus status,
                                 String identityUrl)

Created by the OpenIDAuthenticationProvider on successful authentication. Do not use directly

Method Detail

getCredentials

public Object getCredentials()

Description copied from interface: Authentication

The credentials that prove the principal is correct. This is usually a password, but could be anything relevant to the AuthenticationManager. Callers are expected to populate the credentials.

Returns:

the credentials that prove the identity of the Principal

getIdentityUrl

public String getIdentityUrl()

getMessage

public String getMessage()

getPrincipal

public Object getPrincipal()

Description copied from interface: Authentication

The identity of the principal being authenticated. This is usually a username. Callers are expected to populate the principal.

Returns:

the Principal being authenticated

getStatus

public OpenIDAuthenticationStatus getStatus()