org.springframework.social.security

Class SocialAuthenticationServiceRegistry

java.lang.Object

org.springframework.social.connect.support.ConnectionFactoryRegistry

org.springframework.social.security.SocialAuthenticationServiceRegistry

All Implemented Interfaces:

ConnectionFactoryLocator, SocialAuthenticationServiceLocator

public class SocialAuthenticationServiceRegistry
extends ConnectionFactoryRegistry
implements SocialAuthenticationServiceLocator

Constructor Summary

Constructors

Constructor and Description
SocialAuthenticationServiceRegistry()

Method Summary

Methods

Modifier and Type	Method and Description
void	addAuthenticationService(SocialAuthenticationService<?> authenticationService) Add a SocialAuthenticationService to this registry.
SocialAuthenticationService<?>	getAuthenticationService(String providerId) Lookup a SocialAuthenticationService by providerId; for example, "facebook".
Set<String>	registeredAuthenticationProviderIds() Returns the set of providerIds for which a SocialAuthenticationService is registered; for example, {"twitter", "facebook", "foursquare" }.
void	setAuthenticationServices(Iterable<SocialAuthenticationService<?>> authenticationServices) Set the group of SocialAuthenticationServices registered in this registry.

Methods inherited from class org.springframework.social.connect.support.ConnectionFactoryRegistry

addConnectionFactory, getConnectionFactory, getConnectionFactory, registeredProviderIds, setConnectionFactories

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.social.connect.ConnectionFactoryLocator

getConnectionFactory, getConnectionFactory, registeredProviderIds

Constructor Detail

SocialAuthenticationServiceRegistry

public SocialAuthenticationServiceRegistry()

Method Detail

getAuthenticationService

public SocialAuthenticationService<?> getAuthenticationService(String providerId)

Description copied from interface: SocialAuthenticationServiceLocator

Lookup a SocialAuthenticationService by providerId; for example, "facebook".

Specified by:

getAuthenticationService in interface SocialAuthenticationServiceLocator

Parameters:

providerId - the provider ID used to find an authentication service

Returns:

a SocialAuthenticationServer for the given provider ID

addAuthenticationService

public void addAuthenticationService(SocialAuthenticationService<?> authenticationService)

Add a SocialAuthenticationService to this registry.

Parameters:

authenticationService - a SocialAuthenticationService to register

setAuthenticationServices

public void setAuthenticationServices(Iterable<SocialAuthenticationService<?>> authenticationServices)

Set the group of SocialAuthenticationServices registered in this registry. JavaBean setter that allows for this object to be more easily configured by tools. For programmatic configuration, prefer addAuthenticationService(SocialAuthenticationService).

Parameters:

authenticationServices - the set of social authentication services to register

registeredAuthenticationProviderIds

public Set<String> registeredAuthenticationProviderIds()

Description copied from interface: SocialAuthenticationServiceLocator

Returns the set of providerIds for which a SocialAuthenticationService is registered; for example, {"twitter", "facebook", "foursquare" }. Elements in this set can be passed to SocialAuthenticationServiceLocator.getAuthenticationService(String) to fetch a specific authentication service.

Specified by:

registeredAuthenticationProviderIds in interface SocialAuthenticationServiceLocator

Returns:

a Set of provider IDs for which a SocialAuthenticationService has been registered with this provider.