org.springframework.social.security

Class SocialAuthenticationToken

java.lang.Object

org.springframework.security.authentication.AbstractAuthenticationToken

org.springframework.social.security.SocialAuthenticationToken

All Implemented Interfaces:

Serializable, Principal, org.springframework.security.core.Authentication, org.springframework.security.core.CredentialsContainer

public class SocialAuthenticationToken
extends org.springframework.security.authentication.AbstractAuthenticationToken

Authentication token for social authentication, e.g. Twitter or Facebook

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SocialAuthenticationToken(Connection<?> connection, Map<String,String> providerAccountData)
SocialAuthenticationToken(Connection<?> connection, Serializable details, Map<String,String> providerAccountData, Collection<? extends org.springframework.security.core.GrantedAuthority> authorities)

Method Summary

Methods

Modifier and Type	Method and Description
Connection<?>	getConnection()
Object	getCredentials()
Serializable	getPrincipal()
Map<String,String>	getProviderAccountData()
String	getProviderId()
void	setAuthenticated(boolean isAuthenticated)

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SocialAuthenticationToken

public SocialAuthenticationToken(Connection<?> connection,
                         Map<String,String> providerAccountData)

Parameters:

connection - connection data

providerAccountData - optional extra account data

SocialAuthenticationToken

public SocialAuthenticationToken(Connection<?> connection,
                         Serializable details,
                         Map<String,String> providerAccountData,
                         Collection<? extends org.springframework.security.core.GrantedAuthority> authorities)

Parameters:

connection - Connection

details - user details, typically as returned by SocialUserDetailsService

providerAccountData - optional extra account data

authorities - any GrantedAuthoritys for this user

Method Detail

getProviderId

public String getProviderId()

Returns:

ServiceProvider id

getCredentials

public Object getCredentials()

Returns:

always null

getPrincipal

public Serializable getPrincipal()

Returns:

The user's principal. Null if not authenticated.

getConnection

public Connection<?> getConnection()

getProviderAccountData

public Map<String,String> getProviderAccountData()

Returns:

unmodifiable map, never null

setAuthenticated

public void setAuthenticated(boolean isAuthenticated)
                      throws IllegalArgumentException

Specified by:

setAuthenticated in interface org.springframework.security.core.Authentication

Overrides:

setAuthenticated in class org.springframework.security.authentication.AbstractAuthenticationToken

Throws:

IllegalArgumentException - when trying to authenticate a previously unauthenticated token