org.springframework.social.connect.support

Class ConnectionFactoryRegistry

java.lang.Object

org.springframework.social.connect.support.ConnectionFactoryRegistry

All Implemented Interfaces:

ConnectionFactoryLocator

Direct Known Subclasses:

SocialAuthenticationServiceRegistry

public class ConnectionFactoryRegistry
extends Object
implements ConnectionFactoryLocator

A registry for service provider connection factories. Implements ConnectionFactoryLocator for locating registered factory instances. Call addConnectionFactory(ConnectionFactory) to add to this registry.

Constructor Summary

Constructors

Constructor and Description
ConnectionFactoryRegistry()

Method Summary

Methods

Modifier and Type	Method and Description
void	addConnectionFactory(ConnectionFactory<?> connectionFactory) Add a ConnectionFactory to this registry.
<A> ConnectionFactory<A>	getConnectionFactory(Class<A> apiType) Lookup a ConnectionFactory by apiType; for example, FacebookApi.class.
ConnectionFactory<?>	getConnectionFactory(String providerId) Lookup a ConnectionFactory by providerId; for example, "facebook".
Set<String>	registeredProviderIds() Returns the set of providerIds for which a ConnectionFactory is registered; for example, { "twitter", "facebook", "foursquare" } Elements in this set can be passed to ConnectionFactoryLocator.getConnectionFactory(String) to fetch a specific factory instance.
void	setConnectionFactories(List<ConnectionFactory<?>> connectionFactories) Set the group of service provider connection factories registered in this registry.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectionFactoryRegistry

public ConnectionFactoryRegistry()

Method Detail

addConnectionFactory

public void addConnectionFactory(ConnectionFactory<?> connectionFactory)

Add a ConnectionFactory to this registry.

Parameters:

connectionFactory - the connection factory

setConnectionFactories

public void setConnectionFactories(List<ConnectionFactory<?>> connectionFactories)

Set the group of service provider connection factories registered in this registry. JavaBean setter that allows for this object to be more easily configured by tools. For programmatic configuration, prefer addConnectionFactory(ConnectionFactory).

Parameters:

connectionFactories - the set of connection factories to register

getConnectionFactory

public ConnectionFactory<?> getConnectionFactory(String providerId)

Description copied from interface: ConnectionFactoryLocator

Lookup a ConnectionFactory by providerId; for example, "facebook". The returned factory can be used to create connections to the provider. Used to support connection creation in a dynamic manner across the set of registered providers.

Specified by:

getConnectionFactory in interface ConnectionFactoryLocator

Parameters:

providerId - the provider ID used to look up the ConnectionFactory.

Returns:

the requested ConnectionFactory

getConnectionFactory

public <A> ConnectionFactory<A> getConnectionFactory(Class<A> apiType)

Description copied from interface: ConnectionFactoryLocator

Lookup a ConnectionFactory by apiType; for example, FacebookApi.class. The returned factory can be used to create connections to the provider. Primarily used in support of connection restoration requested by application code.

Specified by:

getConnectionFactory in interface ConnectionFactoryLocator

Type Parameters:

A - the API binding type

Parameters:

apiType - the Java type of the API binding used to lookup a matching ConnectionFactory

Returns:

the requested ConnectionFactory

See Also:

ConnectionRepository.getPrimaryConnection(Class)

registeredProviderIds

public Set<String> registeredProviderIds()

Description copied from interface: ConnectionFactoryLocator

Returns the set of providerIds for which a ConnectionFactory is registered; for example, { "twitter", "facebook", "foursquare" } Elements in this set can be passed to ConnectionFactoryLocator.getConnectionFactory(String) to fetch a specific factory instance.

Specified by:

registeredProviderIds in interface ConnectionFactoryLocator

Returns:

a Set of String containing all of the provider IDs registered with this ConnectionFactoryLocator.