org.springframework.social.connect.web

Interface ProviderSignInInterceptor<S>

Type Parameters:

S - The service API hosted by the intercepted service provider.

public interface ProviderSignInInterceptor<S>

Listens for service provider sign in events. Allows for custom logic to be executed before and after sign in is performed via a specific service provider. Note that this interceptor only handles events during ProviderSignInController's flow. It does not handle events that take place in the case where ProviderSignInController redirects to the application-defined signup process. In that case, interceptors are not necessary and any post-signup logic can be performed using the connection carried in the ProviderSignInAttempt.

Method Summary

Methods

Modifier and Type	Method and Description
void	postSignIn(Connection<S> connection, WebRequest request) Called immediately after the sign in is complete.
void	preSignIn(ConnectionFactory<S> connectionFactory, MultiValueMap<String,String> parameters, WebRequest request) Called during sign in initiation, immediately before user authorization.

Method Detail

preSignIn

void preSignIn(ConnectionFactory<S> connectionFactory,
             MultiValueMap<String,String> parameters,
             WebRequest request)

Called during sign in initiation, immediately before user authorization. May be used to store custom connection attributes in the session before redirecting the user to the provider's site or to contribute parameters to the authorization URL.

Parameters:

connectionFactory - The connection factory

parameters - the parameters to be sent to the provider during authentication

request - The web request

postSignIn

void postSignIn(Connection<S> connection,
              WebRequest request)

Called immediately after the sign in is complete. Used to invoke the service API on behalf of the user upon signing in.

Parameters:

connection - the connection that was created in the course of provider sign-in

request - the request