org.springframework.social.security

Class SocialAuthenticationToken

java.lang.Object

org.springframework.security.authentication.AbstractAuthenticationToken

org.springframework.social.security.SocialAuthenticationToken

All Implemented Interfaces:

java.io.Serializable, java.security.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

Author:

Stefan Fussennegger, Yuan Ji

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
org.springframework.social.connect.Connection<?>	getConnection()
java.lang.Object	getCredentials()
java.io.Serializable	getPrincipal()
java.util.Map<java.lang.String,java.lang.String>	getProviderAccountData()
java.lang.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(org.springframework.social.connect.Connection<?> connection,
                         java.util.Map<java.lang.String,java.lang.String> providerAccountData)

Parameters:

connection - connection data

providerAccountData - optional extra account data

SocialAuthenticationToken

public SocialAuthenticationToken(org.springframework.social.connect.Connection<?> connection,
                         java.io.Serializable details,
                         java.util.Map<java.lang.String,java.lang.String> providerAccountData,
                         java.util.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 java.lang.String getProviderId()

Returns:

ServiceProvider id

getCredentials

public java.lang.Object getCredentials()

Returns:

always null

getPrincipal

public java.io.Serializable getPrincipal()

Returns:

The user's principal. Null if not authenticated.

getConnection

public org.springframework.social.connect.Connection<?> getConnection()

getProviderAccountData

public java.util.Map<java.lang.String,java.lang.String> getProviderAccountData()

Returns:

unmodifiable map, never null

setAuthenticated

public void setAuthenticated(boolean isAuthenticated)
                      throws java.lang.IllegalArgumentException

Specified by:

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

Overrides:

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

Throws:

java.lang.IllegalArgumentException - when trying to authenticate a previously unauthenticated token