org.springframework.social.connect.web

Class ProviderSignInUtils

java.lang.Object

org.springframework.social.connect.web.ProviderSignInUtils

public class ProviderSignInUtils
extends Object

Helper methods that support provider user sign-in scenarios.

Constructor Summary

Constructors

Constructor and Description
ProviderSignInUtils(ConnectionFactoryLocator connectionFactoryLocator, UsersConnectionRepository connectionRepository)
ProviderSignInUtils(SessionStrategy sessionStrategy, ConnectionFactoryLocator connectionFactoryLocator, UsersConnectionRepository connectionRepository)

Method Summary

Modifier and Type	Method and Description
void	doPostSignUp(String userId, RequestAttributes request) Add the connection to the provider user the client attempted to sign-in with to the new local user's set of connections.
Connection<?>	getConnectionFromSession(RequestAttributes request) Get the connection to the provider user the client attempted to sign-in as.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProviderSignInUtils

public ProviderSignInUtils(ConnectionFactoryLocator connectionFactoryLocator,
                           UsersConnectionRepository connectionRepository)

ProviderSignInUtils

public ProviderSignInUtils(SessionStrategy sessionStrategy,
                           ConnectionFactoryLocator connectionFactoryLocator,
                           UsersConnectionRepository connectionRepository)

Method Detail

getConnectionFromSession

public Connection<?> getConnectionFromSession(RequestAttributes request)

Get the connection to the provider user the client attempted to sign-in as. Using this connection you may fetch a provider user profile and use that to pre-populate a local user registration/signup form. You can also lookup the id of the provider and use that to display a provider-specific user-sign-in-attempt flash message e.g. "Your Facebook Account is not connected to a Local account. Please sign up." Must be called before handlePostSignUp() or else the sign-in attempt will have been cleared from the session. Returns null if no provider sign-in has been attempted for the current user session.

Parameters:

request - the current request attributes, used to extract sign-in attempt information from the current user session

Returns:

the connection

doPostSignUp

public void doPostSignUp(String userId,
                         RequestAttributes request)

Add the connection to the provider user the client attempted to sign-in with to the new local user's set of connections. Should be called after signing-up a new user in the context of a provider sign-in attempt. In this context, the user did not yet have a local account but attempted to sign-in using one of his or her existing provider accounts. Ensures provider sign-in attempt session context is cleaned up. Does nothing if no provider sign-in was attempted for the current user session (is safe to call in that case).

Parameters:

userId - the local application's user ID

request - the current request attributes, used to extract sign-in attempt information from the current user session