org.springframework.social.connect.web

Class ConnectController

java.lang.Object

org.springframework.social.connect.web.ConnectController

All Implemented Interfaces:

InitializingBean

@Controller
@RequestMapping(value="/connect")
public class ConnectController
extends Object
implements InitializingBean

Generic UI controller for managing the account-to-service-provider connection flow.

• GET /connect/{providerId} - Get a web page showing connection status to {providerId}.
• POST /connect/{providerId} - Initiate an connection with {providerId}.
• GET /connect/{providerId}?oauth_verifier||code - Receive {providerId} authorization callback and establish the connection.
• DELETE /connect/{providerId} - Disconnect from {providerId}.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	AUTHORIZATION_ERROR_ATTRIBUTE
protected static String	DUPLICATE_CONNECTION_ATTRIBUTE
protected static String	PROVIDER_ERROR_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
ConnectController(ConnectionFactoryLocator connectionFactoryLocator, ConnectionRepository connectionRepository) Constructs a ConnectController.

Method Summary

Methods

Modifier and Type	Method and Description
void	addDisconnectInterceptor(DisconnectInterceptor<?> interceptor) Adds a DisconnectInterceptor to receive callbacks during the disconnection process.
void	addInterceptor(ConnectInterceptor<?> interceptor) Adds a ConnectInterceptor to receive callbacks during the connection process.
void	afterPropertiesSet()
RedirectView	connect(String providerId, NativeWebRequest request) Process a connect form submission by commencing the process of establishing a connection to the provider on behalf of the member.
protected String	connectedView(String providerId) Returns the view name of a page to display for a provider when the user is connected to the provider.
String	connectionStatus(NativeWebRequest request, Model model) Render the status of connections across all providers to the user as HTML in their web browser.
String	connectionStatus(String providerId, NativeWebRequest request, Model model) Render the status of the connections to the service provider to the user as HTML in their web browser.
protected RedirectView	connectionStatusRedirect(String providerId, NativeWebRequest request) Returns a RedirectView with the URL to redirect to after a connection is created or deleted.
protected String	connectView() Returns the view name of a general connection status page, typically displaying the user's connection status for all providers.
protected String	connectView(String providerId) Returns the view name of a page to display for a provider when the user is not connected to the provider.
RedirectView	oauth1Callback(String providerId, NativeWebRequest request) Process the authorization callback from an OAuth 1 service provider.
RedirectView	oauth2Callback(String providerId, NativeWebRequest request) Process the authorization callback from an OAuth 2 service provider.
RedirectView	oauth2ErrorCallback(String providerId, String error, String errorDescription, String errorUri, NativeWebRequest request) Process an error callback from an OAuth 2 authorization as described at http://tools.ietf.org/html/rfc6749#section-4.1.2.1.
RedirectView	removeConnection(String providerId, String providerUserId, NativeWebRequest request) Remove a single provider connection associated with a user account.
RedirectView	removeConnections(String providerId, NativeWebRequest request) Remove all provider connections for a user account.
void	setApplicationUrl(String applicationUrl) Configures the base secure URL for the application this controller is being used in e.g.
void	setConnectInterceptors(List<ConnectInterceptor<?>> interceptors) Configure the list of connect interceptors that should receive callbacks during the connection process.
void	setDisconnectInterceptors(List<DisconnectInterceptor<?>> interceptors) Configure the list of discconnect interceptors that should receive callbacks when connections are removed.
void	setInterceptors(List<ConnectInterceptor<?>> interceptors) Deprecated. Use setConnectInterceptors(List) instead.
void	setSessionStrategy(SessionStrategy sessionStrategy) Sets a strategy to use when persisting information that is to survive past the boundaries of a request.
void	setViewPath(String viewPath) Sets the path to connection status views.

Methods inherited from class java.lang.Object

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

Field Detail

DUPLICATE_CONNECTION_ATTRIBUTE

protected static final String DUPLICATE_CONNECTION_ATTRIBUTE

See Also:

Constant Field Values

PROVIDER_ERROR_ATTRIBUTE

protected static final String PROVIDER_ERROR_ATTRIBUTE

See Also:

Constant Field Values

AUTHORIZATION_ERROR_ATTRIBUTE

protected static final String AUTHORIZATION_ERROR_ATTRIBUTE

See Also:

Constant Field Values

Constructor Detail

ConnectController

@Inject
public ConnectController(ConnectionFactoryLocator connectionFactoryLocator,
                        ConnectionRepository connectionRepository)

Constructs a ConnectController.

Parameters:

connectionFactoryLocator - the locator for ConnectionFactory instances needed to establish connections

connectionRepository - the current user's ConnectionRepository needed to persist connections; must be a proxy to a request-scoped bean

Method Detail

setInterceptors

@Deprecated
public void setInterceptors(List<ConnectInterceptor<?>> interceptors)

Deprecated. Use setConnectInterceptors(List) instead.

Configure the list of connect interceptors that should receive callbacks during the connection process. Convenient when an instance of this class is configured using a tool that supports JavaBeans-based configuration.

Parameters:

interceptors - the connect interceptors to add

setConnectInterceptors

public void setConnectInterceptors(List<ConnectInterceptor<?>> interceptors)

Configure the list of connect interceptors that should receive callbacks during the connection process. Convenient when an instance of this class is configured using a tool that supports JavaBeans-based configuration.

Parameters:

interceptors - the connect interceptors to add

setDisconnectInterceptors

public void setDisconnectInterceptors(List<DisconnectInterceptor<?>> interceptors)

Configure the list of discconnect interceptors that should receive callbacks when connections are removed. Convenient when an instance of this class is configured using a tool that supports JavaBeans-based configuration.

Parameters:

interceptors - the connect interceptors to add

setApplicationUrl

public void setApplicationUrl(String applicationUrl)

Configures the base secure URL for the application this controller is being used in e.g. https://myapp.com. Defaults to null. If specified, will be used to generate OAuth callback URLs. If not specified, OAuth callback URLs are generated from web request info. You may wish to set this property if requests into your application flow through a proxy to your application server. In this case, the request URI may contain a scheme, host, and/or port value that points to an internal server not appropriate for an external callback URL. If you have this problem, you can set this property to the base external URL for your application and it will be used to construct the callback URL instead.

Parameters:

applicationUrl - the application URL value

setViewPath

public void setViewPath(String viewPath)

Sets the path to connection status views. Prepended to provider-specific views (e.g., "connect/facebookConnected") to create the complete view name. Defaults to "connect/".

Parameters:

viewPath - The path to connection status views.

setSessionStrategy

public void setSessionStrategy(SessionStrategy sessionStrategy)

Sets a strategy to use when persisting information that is to survive past the boundaries of a request. The default strategy is to set the data as attributes in the HTTP Session.

Parameters:

sessionStrategy - the session strategy.

addInterceptor

public void addInterceptor(ConnectInterceptor<?> interceptor)

Adds a ConnectInterceptor to receive callbacks during the connection process. Useful for programmatic configuration.

Parameters:

interceptor - the connect interceptor to add

addDisconnectInterceptor

public void addDisconnectInterceptor(DisconnectInterceptor<?> interceptor)

Adds a DisconnectInterceptor to receive callbacks during the disconnection process. Useful for programmatic configuration.

Parameters:

interceptor - the connect interceptor to add

connectionStatus

@RequestMapping(method=GET)
public String connectionStatus(NativeWebRequest request,
                                              Model model)

Render the status of connections across all providers to the user as HTML in their web browser.

Parameters:

request - the request

model - the model

Returns:

the view name of the connection status page for all providers

connectionStatus

@RequestMapping(value="/{providerId}",
                method=GET)
public String connectionStatus(@PathVariable
                                                   String providerId,
                                                   NativeWebRequest request,
                                                   Model model)

Render the status of the connections to the service provider to the user as HTML in their web browser.

Parameters:

providerId - the ID of the provider to show connection status

request - the request

model - the model

Returns:

the view name of the connection status page for all providers

connect

@RequestMapping(value="/{providerId}",
                method=POST)
public RedirectView connect(@PathVariable
                                                 String providerId,
                                                 NativeWebRequest request)

Process a connect form submission by commencing the process of establishing a connection to the provider on behalf of the member. For OAuth1, fetches a new request token from the provider, temporarily stores it in the session, then redirects the member to the provider's site for authorization. For OAuth2, redirects the user to the provider's site for authorization.

Parameters:

providerId - the provider ID to connect to

request - the request

Returns:

a RedirectView to the provider's authorization page or to the connection status page if there is an error

oauth1Callback

@RequestMapping(value="/{providerId}",
                method=GET,
                params="oauth_token")
public RedirectView oauth1Callback(@PathVariable
                                                             String providerId,
                                                             NativeWebRequest request)

Process the authorization callback from an OAuth 1 service provider. Called after the user authorizes the connection, generally done by having he or she click "Allow" in their web browser at the provider's site. On authorization verification, connects the user's local account to the account they hold at the service provider Removes the request token from the session since it is no longer valid after the connection is established.

Parameters:

providerId - the provider ID to connect to

request - the request

Returns:

a RedirectView to the connection status page

oauth2Callback

@RequestMapping(value="/{providerId}",
                method=GET,
                params="code")
public RedirectView oauth2Callback(@PathVariable
                                                             String providerId,
                                                             NativeWebRequest request)

Process the authorization callback from an OAuth 2 service provider. Called after the user authorizes the connection, generally done by having he or she click "Allow" in their web browser at the provider's site. On authorization verification, connects the user's local account to the account they hold at the service provider.

Parameters:

providerId - the provider ID to connect to

request - the request

Returns:

a RedirectView to the connection status page

oauth2ErrorCallback

@RequestMapping(value="/{providerId}",
                method=GET,
                params="error")
public RedirectView oauth2ErrorCallback(@PathVariable
                                                                  String providerId,
                                                                  @RequestParam(value="error")
                                                                  String error,
                                                                  @RequestParam(value="error_description",required=false)
                                                                  String errorDescription,
                                                                  @RequestParam(value="error_uri",required=false)
                                                                  String errorUri,
                                                                  NativeWebRequest request)

Process an error callback from an OAuth 2 authorization as described at http://tools.ietf.org/html/rfc6749#section-4.1.2.1. Called after upon redirect from an OAuth 2 provider when there is some sort of error during authorization, typically because the user denied authorization.

Parameters:

providerId - the provider ID that the connection was attempted for

error - the error parameter sent from the provider

errorDescription - the error_description parameter sent from the provider

errorUri - the error_uri parameter sent from the provider

request - the request

Returns:

a RedirectView to the connection status page

removeConnections

@RequestMapping(value="/{providerId}",
                method=DELETE)
public RedirectView removeConnections(@PathVariable
                                                             String providerId,
                                                             NativeWebRequest request)

Remove all provider connections for a user account. The user has decided they no longer wish to use the service provider from this application. Note: requires HiddenHttpMethodFilter to be registered with the '_method' request parameter set to 'DELETE' to convert web browser POSTs to DELETE requests.

Parameters:

providerId - the provider ID to remove the connections for

request - the request

Returns:

a RedirectView to the connection status page

removeConnection

@RequestMapping(value="/{providerId}/{providerUserId}",
                method=DELETE)
public RedirectView removeConnection(@PathVariable
                                                            String providerId,
                                                            @PathVariable
                                                            String providerUserId,
                                                            NativeWebRequest request)

Remove a single provider connection associated with a user account. The user has decided they no longer wish to use the service provider account from this application. Note: requires HiddenHttpMethodFilter to be registered with the '_method' request parameter set to 'DELETE' to convert web browser POSTs to DELETE requests.

Parameters:

providerId - the provider ID to remove connections for

providerUserId - the user's ID at the provider

request - the request

Returns:

a RedirectView to the connection status page

connectView

protected String connectView()

Returns the view name of a general connection status page, typically displaying the user's connection status for all providers. Defaults to "/connect/status". May be overridden to return a custom view name.

Returns:

the view name of the connection status page

connectView

protected String connectView(String providerId)

Returns the view name of a page to display for a provider when the user is not connected to the provider. Typically this page would offer the user an opportunity to create a connection with the provider. Defaults to "connect/{providerId}Connect". May be overridden to return a custom view name.

Parameters:

providerId - the ID of the provider to display the connection status for.

Returns:

the view name of a page to display when the user isn't connected to the provider

connectedView

protected String connectedView(String providerId)

Returns the view name of a page to display for a provider when the user is connected to the provider. Typically this page would allow the user to disconnect from the provider. Defaults to "connect/{providerId}Connected". May be overridden to return a custom view name.

Parameters:

providerId - the ID of the provider to display the connection status for.

Returns:

the view name of a page to display when the user is connected to the provider

connectionStatusRedirect

protected RedirectView connectionStatusRedirect(String providerId,
                                    NativeWebRequest request)

Returns a RedirectView with the URL to redirect to after a connection is created or deleted. Defaults to "/connect/{providerId}" relative to DispatcherServlet's path. May be overridden to handle custom redirection needs.

Parameters:

providerId - the ID of the provider for which a connection was created or deleted.

request - the NativeWebRequest used to access the servlet path when constructing the redirect path.

Returns:

a RedirectView to the page to be displayed after a connection is created or deleted

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

Exception