org.springframework.social.connect.ConnectionRepository 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.List;
import org.springframework.util.MultiValueMap;
/**
* Data access interface for saving and restoring Connection objects from a persistent store.
* The view is relative to a specific local user--it's not possible using this interface to access or update connections for multiple local users.
* If you need that capability, see {@link UsersConnectionRepository}.
* @author Keith Donald
* @see UsersConnectionRepository
*/
public interface ConnectionRepository {
/**
* Find all connections the current user has across all providers.
* The returned map contains an entry for each provider the user is connected to.
* The key for each entry is the providerId, and the value is the list of {@link Connection}s that exist between the user and that provider.
* For example, if the user is connected once to Facebook and twice to Twitter, the returned map would contain two entries with the following structure:
*
* {
* "facebook" -> Connection("Keith Donald") ,
* "twitter" -> Connection("kdonald"), Connection("springsource")
* }
*
* The returned map is sorted by providerId and entry values are ordered by rank.
* Returns an empty map if the user has no connections.
* @return all connections the current user has across all providers.
*/
MultiValueMap> findAllConnections();
/**
* Find the connections the current user has to the provider registered by the given id e.g. 'facebook'.
* The returned list is ordered by connection rank.
* Returns an empty list if the user has no connections to the provider.
* @param providerId the provider id e.g. "facebook"
* @return the connections the user has to the provider, or an empty list if none
*/
List> findConnections(String providerId);
/**
* Find the connections the current user has to the provider of the given API e.g. Facebook.class.
* Semantically equivalent to {@link #findConnections(String)}, but uses the apiType as the provider key instead of the providerId.
* Useful for direct use by application code to obtain parameterized Connection instances e.g. List<Connection<Facebook>>.
* @param the API parameterized type
* @param apiType the API type e.g. Facebook.class or Twitter.class
* @return the connections the user has to the provider of the API, or an empty list if none
*/
List> findConnections(Class apiType);
/**
* Find the connections the current user has to the given provider users.
* The providerUsers parameter accepts a map containing an entry for each provider the caller is interested in.
* The key for each entry is the providerId e.g. "facebook", and the value is a list of provider user ids to fetch connections to e.g. ("126500", "34521", "127243").
* The returned map has the same structure and order, except the provider userId values have been replaced by Connection instances.
* If no connection exists between the current user and a given provider user, a null value is returned for that position.
* @param providerUserIds the provider users map
* @return the provider user connection map
*/
MultiValueMap> findConnectionsToUsers(MultiValueMap providerUserIds);
/**
* Get a connection for the current user by its key, which consists of the providerId + providerUserId.
* @param connectionKey the service provider connection key
* @return the connection
* @throws NoSuchConnectionException if no such connection exists for the current user
*/
Connection getConnection(ConnectionKey connectionKey);
/**
* Get a connection between the current user and the given provider user.
* Semantically equivalent to {@link #getConnection(ConnectionKey)}, but uses the apiType as the provider key instead of the providerId.
* Useful for direct use by application code to obtain a parameterized Connection instance.
* @param the API parameterized type
* @param apiType the API type e.g. Facebook.class or Twitter.class
* @param providerUserId the provider user e.g. "126500".
* @return the connection
* @throws NoSuchConnectionException if no such connection exists for the current user
*/
Connection getConnection(Class apiType, String providerUserId);
/**
* Get the "primary" connection the current user has to the provider of the given API e.g. Facebook.class.
* If the user has multiple connections to the provider associated with the given apiType, this method returns the one with the top rank (or priority).
* Useful for direct use by application code to obtain a parameterized Connection instance.
* @param the API parameterized type
* @param apiType the API type e.g. Facebook.class or Twitter.class
* @return the primary connection
* @throws NotConnectedException if the user is not connected to the provider of the API
*/
Connection getPrimaryConnection(Class apiType);
/**
* Find the "primary" connection the current user has to the provider of the given API e.g. Facebook.class.
* Semantically equivalent to {@link #getPrimaryConnection(Class)} but returns null if no connection is found instead of throwing an exception.
* @param the API parameterized type
* @param apiType the API type e.g. Facebook.class or Twitter.class
* @return the primary connection, or null if not found
*/
Connection findPrimaryConnection(Class apiType);
/**
* Add a new connection to this repository for the current user.
* After the connection is added, it can be retrieved later using one of the finders defined in this interface.
* @param connection the new connection to add to this repository
* @throws DuplicateConnectionException if the user already has this connection
*/
void addConnection(Connection connection);
/**
* Update a Connection already added to this repository.
* Merges the field values of the given connection object with the values stored in the repository.
* @param connection the existing connection to update in this repository
*/
void updateConnection(Connection connection);
/**
* Remove all Connections between the current user and the provider from this repository.
* Does nothing if no provider connections exist.
* @param providerId the provider id e.g. 'facebook'
*/
void removeConnections(String providerId);
/**
* Remove a single Connection for the current user from this repository.
* Does nothing if no such connection exists.
* @param connectionKey the connection key
*/
void removeConnection(ConnectionKey connectionKey);
}