org.springframework.social.connect

Interface ConnectionFactoryLocator

All Known Subinterfaces:

SocialAuthenticationServiceLocator

All Known Implementing Classes:

ConnectionFactoryRegistry, SocialAuthenticationServiceRegistry

public interface ConnectionFactoryLocator

A ServiceLocator for ConnectionFactory instances. Supports lookup by providerId and by apiType.

See Also:

ConnectionFactory

Method Summary

Methods

Modifier and Type	Method and Description
<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 getConnectionFactory(String) to fetch a specific factory instance.

Method Detail

getConnectionFactory

ConnectionFactory<?> getConnectionFactory(String providerId)

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.

Parameters:

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

Returns:

the requested ConnectionFactory

getConnectionFactory

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

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.

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

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 getConnectionFactory(String) to fetch a specific factory instance.

Returns:

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