org.springframework.social.connect.ConnectionFactoryLocator Maven / Gradle / Ivy
/*
* Copyright 2015 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.social.connect;
import java.util.Set;
/**
* A ServiceLocator for {@link ConnectionFactory} instances.
* Supports lookup by providerId and by apiType.
* @author Keith Donald
* @see ConnectionFactory
*/
public 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.
* @param providerId the provider ID used to look up the ConnectionFactory.
* @return the requested ConnectionFactory
*/
ConnectionFactory getConnectionFactory(String providerId);
/**
* 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.
* @param apiType the Java type of the API binding used to lookup a matching ConnectionFactory
* @param the API binding type
* @return the requested ConnectionFactory
* @see ConnectionRepository#getPrimaryConnection(Class)
*/
ConnectionFactory getConnectionFactory(Class apiType);
/**
* Returns the set of providerIds for which a {@link ConnectionFactory} is registered; for example, { "twitter", "facebook", "foursquare" }
* Elements in this set can be passed to {@link #getConnectionFactory(String)} to fetch a specific factory instance.
* @return a Set of String containing all of the provider IDs registered with this ConnectionFactoryLocator.
*/
Set registeredProviderIds();
}