Spring Social
A B C D E F G H I J K M N O P Q R S T U V W

A

AbstractConnection<A> - Class in org.springframework.social.connect.support
Base support class for Connection implementations.
AbstractConnection(ApiAdapter<A>) - Constructor for class org.springframework.social.connect.support.AbstractConnection
Creates a new connection.
AbstractConnection(ConnectionData, ApiAdapter<A>) - Constructor for class org.springframework.social.connect.support.AbstractConnection
Creates a connection from the data provider.
AbstractOAuth1ApiBinding - Class in org.springframework.social.oauth1
Base class for OAuth 1-based provider API bindings.
AbstractOAuth1ApiBinding() - Constructor for class org.springframework.social.oauth1.AbstractOAuth1ApiBinding
Constructs the API template without user authorization.
AbstractOAuth1ApiBinding(String, String, String, String) - Constructor for class org.springframework.social.oauth1.AbstractOAuth1ApiBinding
Constructs the API template with OAuth credentials necessary to perform operations on behalf of a user.
AbstractOAuth1ServiceProvider<S> - Class in org.springframework.social.oauth1
Base class for ServiceProviders that use the OAuth1 protocol.
AbstractOAuth1ServiceProvider(String, String, OAuth1Operations) - Constructor for class org.springframework.social.oauth1.AbstractOAuth1ServiceProvider
Creates a OAuth1ServiceProvider.
AbstractOAuth2ApiBinding - Class in org.springframework.social.oauth2
Base class for OAuth 2-based provider API bindings.
AbstractOAuth2ApiBinding() - Constructor for class org.springframework.social.oauth2.AbstractOAuth2ApiBinding
Constructs the API template without user authorization.
AbstractOAuth2ApiBinding(String) - Constructor for class org.springframework.social.oauth2.AbstractOAuth2ApiBinding
Constructs the API template with OAuth credentials necessary to perform operations on behalf of a user.
AbstractOAuth2ServiceProvider<S> - Class in org.springframework.social.oauth2
Base class for ServiceProviders that use the OAuth2 protocol.
AbstractOAuth2ServiceProvider(OAuth2Operations) - Constructor for class org.springframework.social.oauth2.AbstractOAuth2ServiceProvider
Create a new OAuth2ServiceProvider.
AccessGrant - Class in org.springframework.social.oauth2
OAuth2 access token.
AccessGrant(String) - Constructor for class org.springframework.social.oauth2.AccessGrant
 
AccessGrant(String, String, String, Integer) - Constructor for class org.springframework.social.oauth2.AccessGrant
 
add(String, String) - Method in class org.springframework.social.support.ParameterMap
 
addConnection(Connection<?>) - Method in interface org.springframework.social.connect.ConnectionRepository
Add a new connection to this repository for the current user.
addConnectionFactory(ConnectionFactory<?>) - Method in class org.springframework.social.connect.support.ConnectionFactoryRegistry
Add a ConnectionFactory to this registry.
addCustomAuthorizationParameters(MultiValueMap<String, String>) - Method in class org.springframework.social.oauth1.OAuth1Template
Subclassing hook to add custom authorization parameters to the authorization URL.
addInterceptor(ConnectInterceptor<?>) - Method in class org.springframework.social.connect.web.ConnectController
Adds a ConnectInterceptor to receive callbacks during the connection process.
andExpect(RequestMatcher) - Method in class org.springframework.social.test.client.MockClientHttpRequest
 
andExpect(RequestMatcher) - Method in interface org.springframework.social.test.client.ResponseActions
Allows for further expectations to be set on the request.
andRespond(ResponseCreator) - Method in class org.springframework.social.test.client.MockClientHttpRequest
 
andRespond(ResponseCreator) - Method in interface org.springframework.social.test.client.ResponseActions
Sets the ResponseCreator for this mock.
anything() - Static method in class org.springframework.social.test.client.RequestMatchers
Expects any request.
ApiAdapter<A> - Interface in org.springframework.social.connect
An adapter that bridges between the uniform Connection model and a specific provider API model.
ApiBinding - Interface in org.springframework.social
Base interface that may be implemented by API bindings.
ApiException - Exception in org.springframework.social
Indicates that an error occurred while consuming a provider API.
ApiException(String) - Constructor for exception org.springframework.social.ApiException
 
ApiException(String, Throwable) - Constructor for exception org.springframework.social.ApiException
 
assertEquals(String, Object, Object) - Static method in class org.springframework.social.test.client.AssertionErrors
Asserts that two objects are equal.
AssertionErrors - Class in org.springframework.social.test.client
JUnit independent assertion class.
assertTrue(String, boolean) - Static method in class org.springframework.social.test.client.AssertionErrors
Asserts that a condition is true.
authenticateClient() - Method in interface org.springframework.social.oauth2.OAuth2Operations
Retrieves the client access grant using OAuth 2 client password flow.
authenticateClient(String) - Method in interface org.springframework.social.oauth2.OAuth2Operations
Retrieves the client access grant using OAuth 2 client password flow.
authenticateClient() - Method in class org.springframework.social.oauth2.OAuth2Template
 
authenticateClient(String) - Method in class org.springframework.social.oauth2.OAuth2Template
 
AuthorizedRequestToken - Class in org.springframework.social.oauth1
A OAuth 1.0 request token that has been authorized by the user.
AuthorizedRequestToken(OAuthToken, String) - Constructor for class org.springframework.social.oauth1.AuthorizedRequestToken
Creates an authorized request token.

B

BaseSocialConnectedTag - Class in org.springframework.social.connect.web.taglib
SocialConnectedTag and SocialNotConnectedTag extend to provide functionality within a JSP to determine if you are connected to a provider or not.
BaseSocialConnectedTag() - Constructor for class org.springframework.social.connect.web.taglib.BaseSocialConnectedTag
 
body(String) - Static method in class org.springframework.social.test.client.RequestMatchers
Expects the given request body content
bufferRequests(ClientHttpRequestFactory) - Static method in class org.springframework.social.support.ClientHttpRequestFactorySelector
Decorates a request factory to buffer responses so that the responses may be repeatedly read.
build() - Method in class org.springframework.social.connect.UserProfileBuilder
Builds the user profile.
build() - Method in class org.springframework.social.support.URIBuilder
Builds the URI
buildAuthenticateUrl(String, OAuth1Parameters) - Method in interface org.springframework.social.oauth1.OAuth1Operations
Construct the URL to redirect the user to for authentication.
buildAuthenticateUrl(String, OAuth1Parameters) - Method in class org.springframework.social.oauth1.OAuth1Template
 
buildAuthenticateUrl(GrantType, OAuth2Parameters) - Method in interface org.springframework.social.oauth2.OAuth2Operations
Construct the URL to redirect the user to for authentication.
buildAuthenticateUrl(GrantType, OAuth2Parameters) - Method in class org.springframework.social.oauth2.OAuth2Template
 
buildAuthorizeUrl(String, OAuth1Parameters) - Method in interface org.springframework.social.oauth1.OAuth1Operations
Construct the URL to redirect the user to for authorization.
buildAuthorizeUrl(String, OAuth1Parameters) - Method in class org.springframework.social.oauth1.OAuth1Template
 
buildAuthorizeUrl(GrantType, OAuth2Parameters) - Method in interface org.springframework.social.oauth2.OAuth2Operations
Construct the URL to redirect the user to for authorization.
buildAuthorizeUrl(GrantType, OAuth2Parameters) - Method in class org.springframework.social.oauth2.OAuth2Template
 
buildOAuthUrl(ConnectionFactory<?>, NativeWebRequest) - Method in class org.springframework.social.connect.web.ConnectSupport
Builds the provider URL to redirect the user to for connection authorization.
buildOAuthUrl(ConnectionFactory<?>, NativeWebRequest, MultiValueMap<String, String>) - Method in class org.springframework.social.connect.web.ConnectSupport
Builds the provider URL to redirect the user to for connection authorization.

C

canceledAuthorizationCallback() - Method in class org.springframework.social.connect.web.ProviderSignInController
Process the authentication callback when neither the oauth_token or code parameter is given, likely indicating that the user denied authorization with the provider.
clear() - Method in class org.springframework.social.support.ParameterMap
 
ClientHttpRequestFactorySelector - Class in org.springframework.social.support
Chooses a request factory.
ClientHttpRequestFactorySelector() - Constructor for class org.springframework.social.support.ClientHttpRequestFactorySelector
 
close() - Method in class org.springframework.social.test.client.MockClientHttpResponse
 
completeConnection(OAuth1ConnectionFactory<?>, NativeWebRequest) - Method in class org.springframework.social.connect.web.ConnectSupport
Complete the connection to the OAuth1 provider.
completeConnection(OAuth2ConnectionFactory<?>, NativeWebRequest) - Method in class org.springframework.social.connect.web.ConnectSupport
Complete the connection to the OAuth2 provider.
configureRestTemplate(RestTemplate) - Method in class org.springframework.social.oauth1.AbstractOAuth1ApiBinding
Subclassing hook to enable customization of the RestTemplate used to consume provider API resources.
configureRestTemplate(RestTemplate) - Method in class org.springframework.social.oauth2.AbstractOAuth2ApiBinding
Subclassing hook to enable customization of the RestTemplate used to consume provider API resources.
connect(String, NativeWebRequest) - Method in class org.springframework.social.connect.web.ConnectController
Process a connect form submission by commencing the process of establishing a connection to the provider on behalf of the member.
ConnectController - Class in org.springframework.social.connect.web
Generic UI controller for managing the account-to-service-provider connection flow.
ConnectController(ConnectionFactoryLocator, ConnectionRepository) - Constructor for class org.springframework.social.connect.web.ConnectController
Constructs a ConnectController.
connectedView(String) - Method in class org.springframework.social.connect.web.ConnectController
Returns the view name of a page to display for a provider when the user is connected to the provider.
ConnectInterceptor<S> - Interface in org.springframework.social.connect.web
Listens for service provider connection events.
Connection<A> - Interface in org.springframework.social.connect
A link to a service provider user.
ConnectionData - Class in org.springframework.social.connect
A data transfer object that allows the internal state of a Connection to be persisted and transferred between layers of an application.
ConnectionData(String, String, String, String, String, String, String, String, Long) - Constructor for class org.springframework.social.connect.ConnectionData
 
ConnectionFactory<A> - Class in org.springframework.social.connect
Base abstraction for factories that construct service provider Connection instances.
ConnectionFactory(String, ServiceProvider<A>, ApiAdapter<A>) - Constructor for class org.springframework.social.connect.ConnectionFactory
Creates a new ConnectionFactory.
ConnectionFactoryLocator - Interface in org.springframework.social.connect
A ServiceLocator for ConnectionFactory instances.
ConnectionFactoryRegistry - Class in org.springframework.social.connect.support
A registry for service provider connection factories.
ConnectionFactoryRegistry() - Constructor for class org.springframework.social.connect.support.ConnectionFactoryRegistry
 
ConnectionKey - Class in org.springframework.social.connect
The unique business key for a Connection instance.
ConnectionKey(String, String) - Constructor for class org.springframework.social.connect.ConnectionKey
Creates a new ConnectionKey.
ConnectionRepository - Interface in org.springframework.social.connect
Data access interface for saving and restoring Connection objects from a persistent store.
ConnectionRepositoryException - Exception in org.springframework.social.connect
Base exception class for ConnectionRepository failures.
ConnectionRepositoryException(String) - Constructor for exception org.springframework.social.connect.ConnectionRepositoryException
 
ConnectionRepositoryException(String, Throwable) - Constructor for exception org.springframework.social.connect.ConnectionRepositoryException
 
ConnectionSignUp - Interface in org.springframework.social.connect
A command that signs up a new user in the event no user id could be mapped from a Connection.
connectionStatus(NativeWebRequest, Model) - Method in class org.springframework.social.connect.web.ConnectController
Render the status of connections across all providers to the user as HTML in their web browser.
connectionStatus(String, NativeWebRequest, Model) - Method in class org.springframework.social.connect.web.ConnectController
Render the status of the connections to the service provider to the user as HTML in their web browser.
connectionStatusRedirect(String, NativeWebRequest) - Method in class org.springframework.social.connect.web.ConnectController
Returns a RedirectView with the URL to redirect to after a connection is created or deleted.
ConnectionValues - Interface in org.springframework.social.connect
A configuration interface used to set values on a Connection from a specific service provider API instance.
ConnectSupport - Class in org.springframework.social.connect.web
Provides common connect support and utilities for Java web/servlet environments.
ConnectSupport() - Constructor for class org.springframework.social.connect.web.ConnectSupport
 
connectView() - Method in class org.springframework.social.connect.web.ConnectController
Returns the view name of a general connection status page, typically displaying the user's connection status for all providers.
connectView(String) - Method in class org.springframework.social.connect.web.ConnectController
Returns the view name of a page to display for a provider when the user is not connected to the provider.
containsKey(Object) - Method in class org.springframework.social.support.ParameterMap
 
containsValue(Object) - Method in class org.springframework.social.support.ParameterMap
 
createAccessGrant(String, String, String, Integer, Map<String, Object>) - Method in class org.springframework.social.oauth2.OAuth2Template
Creates an AccessGrant given the response from the access token exchange with the provider.
createConnection(ConnectionData) - Method in class org.springframework.social.connect.ConnectionFactory
 
createConnection(OAuthToken) - Method in class org.springframework.social.connect.support.OAuth1ConnectionFactory
Create a OAuth1-based Connection from the access token response returned after completing the OAuth1 flow.
createConnection(ConnectionData) - Method in class org.springframework.social.connect.support.OAuth1ConnectionFactory
Create a OAuth1-based Connection from the connection data.
createConnection(AccessGrant) - Method in class org.springframework.social.connect.support.OAuth2ConnectionFactory
Create a OAuth2-based Connection from the AccessGrant returned after completing the OAuth2 flow.
createConnection(ConnectionData) - Method in class org.springframework.social.connect.support.OAuth2ConnectionFactory
Create a OAuth2-based Connection from the connection data.
createConnectionRepository(String) - Method in class org.springframework.social.connect.jdbc.JdbcUsersConnectionRepository
 
createConnectionRepository(String) - Method in interface org.springframework.social.connect.UsersConnectionRepository
Create a single-user ConnectionRepository instance for the user assigned the given id.
createData() - Method in interface org.springframework.social.connect.Connection
Creates a data transfer object that can be used to persist the state of this connection.
createData() - Method in class org.springframework.social.connect.support.AbstractConnection
 
createData() - Method in class org.springframework.social.connect.support.OAuth1Connection
 
createData() - Method in class org.springframework.social.connect.support.OAuth2Connection
 
createOAuthToken(String, String, MultiValueMap<String, String>) - Method in class org.springframework.social.oauth1.OAuth1Template
Creates an OAuthToken given the response from the request token or access token exchange with the provider.
createRequest(URI, HttpMethod) - Method in class org.springframework.social.test.client.MockClientHttpRequestFactory
 
createResponse(ClientHttpRequest) - Method in interface org.springframework.social.test.client.ResponseCreator
Create a response for the given request
createRestTemplate() - Method in class org.springframework.social.oauth2.OAuth2Template
Creates the RestTemplate used to communicate with the provider's OAuth 2 API.
createServer(RestTemplate) - Static method in class org.springframework.social.test.client.MockRestServiceServer
Creates a MockRestServiceServer instance based on the given RestTemplate.
createServer(RestGatewaySupport) - Static method in class org.springframework.social.test.client.MockRestServiceServer
Creates a MockRestServiceServer instance based on the given RestGatewaySupport.

D

doStartTagInternal() - Method in class org.springframework.social.connect.web.taglib.SocialConnectedTag
 
doStartTagInternal() - Method in class org.springframework.social.connect.web.taglib.SocialNotConnectedTag
 
DuplicateConnectionException - Exception in org.springframework.social.connect
Thrown by a ConnectionRepository when attempting to add a Connection and a connection already exists with the given key.
DuplicateConnectionException(ConnectionKey) - Constructor for exception org.springframework.social.connect.DuplicateConnectionException
 
DuplicateStatusException - Exception in org.springframework.social
Exception thrown when a duplicate status is posted.
DuplicateStatusException(String) - Constructor for exception org.springframework.social.DuplicateStatusException
 

E

EMPTY - Static variable in class org.springframework.social.connect.UserProfile
Shared, empty profile that when used indicates no profile data is available (all property values are null).
entrySet() - Method in class org.springframework.social.support.ParameterMap
 
equals(Object) - Method in class org.springframework.social.connect.ConnectionKey
 
equals(Object) - Method in class org.springframework.social.connect.support.AbstractConnection
 
evaluateBodyIfConnected(boolean) - Method in class org.springframework.social.connect.web.taglib.BaseSocialConnectedTag
 
exchangeCredentialsForAccess(String, String, MultiValueMap<String, String>) - Method in interface org.springframework.social.oauth2.OAuth2Operations
Exchanges user credentials for an access grant using OAuth2's Resource Owner Credentials Grant (aka, "password" grant).
exchangeCredentialsForAccess(String, String, MultiValueMap<String, String>) - Method in class org.springframework.social.oauth2.OAuth2Template
 
exchangeForAccess(String, String, MultiValueMap<String, String>) - Method in interface org.springframework.social.oauth2.OAuth2Operations
Exchange the authorization code for an access grant.
exchangeForAccess(String, String, MultiValueMap<String, String>) - Method in class org.springframework.social.oauth2.OAuth2Template
 
exchangeForAccessToken(AuthorizedRequestToken, MultiValueMap<String, String>) - Method in interface org.springframework.social.oauth1.OAuth1Operations
Exchange the authorized request token for an access token.
exchangeForAccessToken(AuthorizedRequestToken, MultiValueMap<String, String>) - Method in class org.springframework.social.oauth1.OAuth1Template
 
execute(Connection<?>) - Method in interface org.springframework.social.connect.ConnectionSignUp
Sign up a new user of the application from the connection.
execute() - Method in class org.springframework.social.test.client.MockClientHttpRequest
 
expect(RequestMatcher) - Method in class org.springframework.social.test.client.MockRestServiceServer
Records an expectation specified by the given RequestMatcher.
ExpiredAuthorizationException - Exception in org.springframework.social
Exception indicating that the authorization presented to the server has expired.
ExpiredAuthorizationException() - Constructor for exception org.springframework.social.ExpiredAuthorizationException
 
extractProviderUserId(OAuthToken) - Method in class org.springframework.social.connect.support.OAuth1ConnectionFactory
Hook for extracting the providerUserId from the returned access token response, if it is available.
extractProviderUserId(AccessGrant) - Method in class org.springframework.social.connect.support.OAuth2ConnectionFactory
Hook for extracting the providerUserId from the returned AccessGrant, if it is available.

F

fail(String) - Static method in class org.springframework.social.test.client.AssertionErrors
Fails a test with the given message.
fetchRequestToken(String, MultiValueMap<String, String>) - Method in interface org.springframework.social.oauth1.OAuth1Operations
Begin a new authorization flow by fetching a new request token from this service provider.
fetchRequestToken(String, MultiValueMap<String, String>) - Method in class org.springframework.social.oauth1.OAuth1Template
 
fetchUserProfile(A) - Method in interface org.springframework.social.connect.ApiAdapter
Implements Connection.fetchUserProfile() for connections to the given API.
fetchUserProfile() - Method in interface org.springframework.social.connect.Connection
Fetch a normalized model of the user's profile on the provider system.
fetchUserProfile() - Method in class org.springframework.social.connect.support.AbstractConnection
 
findAllConnections() - Method in interface org.springframework.social.connect.ConnectionRepository
Find all connections the current user has across all providers.
findConnections(String) - Method in interface org.springframework.social.connect.ConnectionRepository
Find the connections the current user has to the provider registered by the given id e.g.
findConnections(Class<A>) - Method in interface org.springframework.social.connect.ConnectionRepository
Find the connections the current user has to the provider of the given API e.g.
findConnectionsToUsers(MultiValueMap<String, String>) - Method in interface org.springframework.social.connect.ConnectionRepository
Find the connections the current user has to the given provider users.
findPrimaryConnection(Class<A>) - Method in interface org.springframework.social.connect.ConnectionRepository
Find the "primary" connection the current user has to the provider of the given API e.g.
findUserIdsConnectedTo(String, Set<String>) - Method in class org.springframework.social.connect.jdbc.JdbcUsersConnectionRepository
 
findUserIdsConnectedTo(String, Set<String>) - Method in interface org.springframework.social.connect.UsersConnectionRepository
Find the ids of the users who are connected to the specific provider user accounts.
findUserIdsWithConnection(Connection<?>) - Method in class org.springframework.social.connect.jdbc.JdbcUsersConnectionRepository
 
findUserIdsWithConnection(Connection<?>) - Method in interface org.springframework.social.connect.UsersConnectionRepository
Find the ids for local application users that have the given Connection.
fromUri(String) - Static method in class org.springframework.social.support.URIBuilder
Creates a URIBuilder with a base URI string as the starting point

G

get(Object) - Method in class org.springframework.social.support.ParameterMap
 
getAccessToken() - Method in class org.springframework.social.connect.ConnectionData
The access token required to make authorized API calls.
getAccessToken() - Method in class org.springframework.social.oauth2.AccessGrant
The access token value.
getApi() - Method in interface org.springframework.social.connect.Connection
A Java binding to the service provider's native API.
getApi() - Method in class org.springframework.social.connect.support.AbstractConnection
 
getApi() - Method in class org.springframework.social.connect.support.OAuth1Connection
 
getApi() - Method in class org.springframework.social.connect.support.OAuth2Connection
 
getApi(String, String) - Method in class org.springframework.social.oauth1.AbstractOAuth1ServiceProvider
 
getApi(String, String) - Method in interface org.springframework.social.oauth1.OAuth1ServiceProvider
Returns an API interface allowing the client application to access protected resources on behalf of a user.
getApi(String) - Method in class org.springframework.social.oauth2.AbstractOAuth2ServiceProvider
 
getApi(String) - Method in interface org.springframework.social.oauth2.OAuth2ServiceProvider
Returns an API interface allowing the client application to access protected resources on behalf of a user.
getApiAdapter() - Method in class org.springframework.social.connect.ConnectionFactory
Exposes the ApiAdapter to subclasses.
getAuthorizationHeaderValue(String) - Method in enum org.springframework.social.oauth2.OAuth2Version
 
getBody() - Method in class org.springframework.social.test.client.MockClientHttpRequest
 
getBody() - Method in class org.springframework.social.test.client.MockClientHttpResponse
 
getBodyContent() - Method in class org.springframework.social.test.client.MockClientHttpRequest
 
getByteArrayMessageConverter() - Method in class org.springframework.social.oauth1.AbstractOAuth1ApiBinding
Returns a ByteArrayHttpMessageConverter to be used by the internal RestTemplate when consuming image or other binary resources.
getByteArrayMessageConverter() - Method in class org.springframework.social.oauth2.AbstractOAuth2ApiBinding
Returns a ByteArrayHttpMessageConverter to be used by the internal RestTemplate when consuming image or other binary resources.
getCallbackUrl() - Method in class org.springframework.social.oauth1.OAuth1Parameters
The authorization callback url.
getConnection(ConnectionKey) - Method in interface org.springframework.social.connect.ConnectionRepository
Get a connection for the current user by its key, which consists of the providerId + providerUserId.
getConnection(Class<A>, String) - Method in interface org.springframework.social.connect.ConnectionRepository
Get a connection between the current user and the given provider user.
getConnection() - Method in class org.springframework.social.connect.web.ProviderSignInAttempt
Get the connection to the provider user account the client attempted to sign-in as.
getConnection(RequestAttributes) - Static method in class org.springframework.social.connect.web.ProviderSignInUtils
Get the connection to the provider user the client attempted to sign-in as.
getConnectionFactory(String) - Method in interface org.springframework.social.connect.ConnectionFactoryLocator
Lookup a ConnectionFactory by providerId; for example, "facebook".
getConnectionFactory(Class<A>) - Method in interface org.springframework.social.connect.ConnectionFactoryLocator
Lookup a ConnectionFactory by apiType; for example, FacebookApi.class.
getConnectionFactory(String) - Method in class org.springframework.social.connect.support.ConnectionFactoryRegistry
 
getConnectionFactory(Class<A>) - Method in class org.springframework.social.connect.support.ConnectionFactoryRegistry
 
getConnectionKey() - Method in exception org.springframework.social.connect.DuplicateConnectionException
The connection key that already exists.
getConnectionKey() - Method in exception org.springframework.social.connect.NoSuchConnectionException
The invalid key value.
getConsumerKey() - Method in class org.springframework.social.oauth1.AbstractOAuth1ServiceProvider
The consumer (or client) key assigned to the application by the provider.
getConsumerKey() - Method in class org.springframework.social.oauth1.OAuth1Template
Exposes the consumer key to be read by subclasses.
getConsumerSecret() - Method in class org.springframework.social.oauth1.AbstractOAuth1ServiceProvider
The consumer (or client) secret assigned to the application by the provider.
getDisplayName() - Method in interface org.springframework.social.connect.Connection
A display name or label for this connection.
getDisplayName() - Method in class org.springframework.social.connect.ConnectionData
A display name for the connection.
getDisplayName() - Method in class org.springframework.social.connect.support.AbstractConnection
 
getEmail() - Method in class org.springframework.social.connect.UserProfile
The user's registered email address.
getExpireTime() - Method in class org.springframework.social.connect.ConnectionData
The time the connection expires.
getExpireTime() - Method in class org.springframework.social.oauth2.AccessGrant
The time (in milliseconds since Jan 1, 1970 UTC) when this access grant will expire.
getFirst(String) - Method in class org.springframework.social.support.ParameterMap
 
getFirstName() - Method in class org.springframework.social.connect.UserProfile
The user's registered first name e.g.
getFormMessageConverter() - Method in class org.springframework.social.oauth1.AbstractOAuth1ApiBinding
Returns an FormHttpMessageConverter to be used by the internal RestTemplate.
getFormMessageConverter() - Method in class org.springframework.social.oauth2.AbstractOAuth2ApiBinding
Returns an FormHttpMessageConverter to be used by the internal RestTemplate.
getHeaders() - Method in class org.springframework.social.support.HttpRequestDecorator
 
getHeaders() - Method in class org.springframework.social.test.client.MockClientHttpRequest
 
getHeaders() - Method in class org.springframework.social.test.client.MockClientHttpResponse
 
getHeaders() - Method in class org.springframework.social.test.client.MockHttpRequest
 
getImageUrl() - Method in interface org.springframework.social.connect.Connection
A link to a image that visualizes this connection.
getImageUrl() - Method in class org.springframework.social.connect.ConnectionData
An image visualizing the connection.
getImageUrl() - Method in class org.springframework.social.connect.support.AbstractConnection
 
getJsonMessageConverter() - Method in class org.springframework.social.oauth1.AbstractOAuth1ApiBinding
Returns a MappingJacksonHttpMessageConverter to be used by the internal RestTemplate.
getJsonMessageConverter() - Method in class org.springframework.social.oauth2.AbstractOAuth2ApiBinding
Returns a MappingJacksonHttpMessageConverter to be used by the internal RestTemplate.
getKey() - Method in interface org.springframework.social.connect.Connection
The key identifying this connection.
getKey() - Method in class org.springframework.social.connect.support.AbstractConnection
 
getLastName() - Method in class org.springframework.social.connect.UserProfile
The user's registered last name e.g.
getMessageConverters() - Method in class org.springframework.social.oauth1.AbstractOAuth1ApiBinding
Returns a list of HttpMessageConverters to be used by the internal RestTemplate.
getMessageConverters() - Method in class org.springframework.social.oauth2.AbstractOAuth2ApiBinding
Returns a list of HttpMessageConverters to be used by the internal RestTemplate.
getMethod() - Method in class org.springframework.social.test.client.MockClientHttpRequest
 
getMethod() - Method in class org.springframework.social.test.client.MockHttpRequest
 
getMonitor() - Method in class org.springframework.social.connect.support.AbstractConnection
Provides subclasses with access to a monitor that can be used to synchronize access to this connection.
getName() - Method in class org.springframework.social.connect.UserProfile
The user's registered full name e.g.
getOAuth2Version() - Method in class org.springframework.social.oauth2.AbstractOAuth2ApiBinding
Returns the version of OAuth2 the API implements.
getOAuthOperations() - Method in class org.springframework.social.connect.support.OAuth1ConnectionFactory
Get the ServiceProvider's OAuth1Operations that allows the client application to conduct the OAuth1 flow with the provider.
getOAuthOperations() - Method in class org.springframework.social.connect.support.OAuth2ConnectionFactory
Get the ServiceProvider's OAuth2Operations that allows the client application to conduct the OAuth2 flow with the provider.
getOAuthOperations() - Method in class org.springframework.social.oauth1.AbstractOAuth1ServiceProvider
 
getOAuthOperations() - Method in interface org.springframework.social.oauth1.OAuth1ServiceProvider
Get the service interface for carrying out the "OAuth dance" with this provider.
getOAuthOperations() - Method in class org.springframework.social.oauth2.AbstractOAuth2ServiceProvider
 
getOAuthOperations() - Method in interface org.springframework.social.oauth2.OAuth2ServiceProvider
Get the service interface for carrying out the "OAuth dance" with this provider.
getPrimaryConnection(Class<A>) - Method in interface org.springframework.social.connect.ConnectionRepository
Get the "primary" connection the current user has to the provider of the given API e.g.
getProfileUrl() - Method in interface org.springframework.social.connect.Connection
The public URL of the connected user's profile at the provider's site.
getProfileUrl() - Method in class org.springframework.social.connect.ConnectionData
A link to the provider's user profile page.
getProfileUrl() - Method in class org.springframework.social.connect.support.AbstractConnection
 
getProviderId() - Method in class org.springframework.social.connect.ConnectionData
The id of the provider the connection is associated with.
getProviderId() - Method in class org.springframework.social.connect.ConnectionFactory
The unique id of the provider this factory creates connections to.
getProviderId() - Method in class org.springframework.social.connect.ConnectionKey
The id of the provider as it is registered in the system.
getProviderId() - Method in exception org.springframework.social.connect.NotConnectedException
The id of the provider the current user is not connected to.
getProviderUserId() - Method in class org.springframework.social.connect.ConnectionData
The id of the provider user this connection is connected to.
getProviderUserId() - Method in class org.springframework.social.connect.ConnectionKey
The id of the external provider user representing the remote end of the connection.
getRawStatusCode() - Method in class org.springframework.social.test.client.MockClientHttpResponse
 
getRedirectUri() - Method in class org.springframework.social.oauth2.OAuth2Parameters
The authorization callback url.
getRefreshToken() - Method in class org.springframework.social.connect.ConnectionData
A token use to renew this connection.
getRefreshToken() - Method in class org.springframework.social.oauth2.AccessGrant
The refresh token that can be used to renew the access token.
getRequestFactory() - Static method in class org.springframework.social.support.ClientHttpRequestFactorySelector
 
getRequiredPermission() - Method in exception org.springframework.social.InsufficientPermissionException
The permission required to access the resource.
getRestTemplate() - Method in class org.springframework.social.oauth1.AbstractOAuth1ApiBinding
Obtains a reference to the REST client backing this API binding and used to perform API calls.
getRestTemplate() - Method in class org.springframework.social.oauth2.AbstractOAuth2ApiBinding
Obtains a reference to the REST client backing this API binding and used to perform API calls.
getRestTemplate() - Method in class org.springframework.social.oauth2.OAuth2Template
 
getScope() - Method in class org.springframework.social.oauth2.AccessGrant
The scope of the access grant.
getScope() - Method in class org.springframework.social.oauth2.OAuth2Parameters
The permissions the application is seeking with the authorization (optional).
getSecret() - Method in class org.springframework.social.connect.ConnectionData
The secret token needed to make authorized API calls.
getSecret() - Method in class org.springframework.social.oauth1.AuthorizedRequestToken
The request token secret.
getSecret() - Method in class org.springframework.social.oauth1.OAuthToken
The token secret.
getServiceProvider() - Method in class org.springframework.social.connect.ConnectionFactory
Exposes the ServiceProvider instance to subclasses.
getState() - Method in class org.springframework.social.oauth2.OAuth2Parameters
An opaque key that must be included in the provider's authorization callback (optional).
getStatusCode() - Method in class org.springframework.social.test.client.MockClientHttpResponse
 
getStatusText() - Method in class org.springframework.social.test.client.MockClientHttpResponse
 
getURI() - Method in class org.springframework.social.test.client.MockClientHttpRequest
 
getURI() - Method in class org.springframework.social.test.client.MockHttpRequest
 
getUsername() - Method in class org.springframework.social.connect.UserProfile
The user's registered username e.g.
getValue() - Method in class org.springframework.social.oauth1.AuthorizedRequestToken
The request token value.
getValue() - Method in class org.springframework.social.oauth1.OAuthToken
The token value.
getVerifier() - Method in class org.springframework.social.oauth1.AuthorizedRequestToken
The verifier string generated by the provider.
getVersion() - Method in interface org.springframework.social.oauth1.OAuth1Operations
The version of OAuth1 implemented by this operations instance.
getVersion() - Method in class org.springframework.social.oauth1.OAuth1Template
 
GrantType - Enum in org.springframework.social.oauth2
OAuth2 supports two types of authorization flow, typically referred to as "Client-side" and "Server-side".

H

handlePostSignUp(String, RequestAttributes) - Static method in class org.springframework.social.connect.web.ProviderSignInUtils
Add the connection to the provider user the client attempted to sign-in with to the new local user's set of connections.
hasExpired() - Method in interface org.springframework.social.connect.Connection
Returns true if this connection has expired.
hasExpired() - Method in class org.springframework.social.connect.support.AbstractConnection
 
hasExpired() - Method in class org.springframework.social.connect.support.OAuth2Connection
 
hashCode() - Method in class org.springframework.social.connect.ConnectionKey
 
hashCode() - Method in class org.springframework.social.connect.support.AbstractConnection
 
header(String, String) - Static method in class org.springframework.social.test.client.RequestMatchers
Expects the given request header
headerContains(String, String) - Static method in class org.springframework.social.test.client.RequestMatchers
Expects that the specified request header contains a subtring
HttpRequestDecorator - Class in org.springframework.social.support
Extension of HttpRequestWrapper that supports adding new HttpHeaders to the wrapped HttpRequest.
HttpRequestDecorator(HttpRequest) - Constructor for class org.springframework.social.support.HttpRequestDecorator
 

I

initKey(String, String) - Method in class org.springframework.social.connect.support.AbstractConnection
Hook that should be called by subclasses to initialize the key property when establishing a new connection.
InsufficientPermissionException - Exception in org.springframework.social
Exception thrown when attempting an operation that requires a permission not granted to the caller.
InsufficientPermissionException() - Constructor for exception org.springframework.social.InsufficientPermissionException
 
InsufficientPermissionException(String) - Constructor for exception org.springframework.social.InsufficientPermissionException
 
InternalServerErrorException - Exception in org.springframework.social
Exception indicating an internal error occurred on the server.
InternalServerErrorException(String) - Constructor for exception org.springframework.social.InternalServerErrorException
 
InvalidAuthorizationException - Exception in org.springframework.social
Exception indicating that the authorization used during an operation invocation is invalid.
InvalidAuthorizationException(String) - Constructor for exception org.springframework.social.InvalidAuthorizationException
 
isAuthorized() - Method in interface org.springframework.social.ApiBinding
Returns true if this API binding has been authorized on behalf of a specific user.
isAuthorized() - Method in class org.springframework.social.oauth1.AbstractOAuth1ApiBinding
 
isAuthorized() - Method in class org.springframework.social.oauth2.AbstractOAuth2ApiBinding
 
isEmpty() - Method in class org.springframework.social.support.ParameterMap
 

J

JdbcUsersConnectionRepository - Class in org.springframework.social.connect.jdbc
UsersConnectionRepository that uses the JDBC API to persist connection data to a relational database.
JdbcUsersConnectionRepository(DataSource, ConnectionFactoryLocator, TextEncryptor) - Constructor for class org.springframework.social.connect.jdbc.JdbcUsersConnectionRepository
 

K

keySet() - Method in class org.springframework.social.support.ParameterMap
 

M

match(ClientHttpRequest) - Method in interface org.springframework.social.test.client.RequestMatcher
Matches the given request message against the expectations.
method(HttpMethod) - Static method in class org.springframework.social.test.client.RequestMatchers
Expects the given HttpMethod.
MissingAuthorizationException - Exception in org.springframework.social
Exception indicating that an operation requiring authorization was attempted without providing authorization.
MissingAuthorizationException() - Constructor for exception org.springframework.social.MissingAuthorizationException
 
MockClientHttpRequest - Class in org.springframework.social.test.client
Mock implementation of ClientHttpRequest.
MockClientHttpRequest() - Constructor for class org.springframework.social.test.client.MockClientHttpRequest
 
MockClientHttpRequestFactory - Class in org.springframework.social.test.client
Mock implementation of ClientHttpRequestFactory.
MockClientHttpRequestFactory() - Constructor for class org.springframework.social.test.client.MockClientHttpRequestFactory
 
MockClientHttpResponse - Class in org.springframework.social.test.client
Mock implementation of ClientHttpResponse.
MockClientHttpResponse(String, HttpHeaders, HttpStatus, String) - Constructor for class org.springframework.social.test.client.MockClientHttpResponse
 
MockClientHttpResponse(InputStream, HttpHeaders, HttpStatus, String) - Constructor for class org.springframework.social.test.client.MockClientHttpResponse
 
MockHttpRequest - Class in org.springframework.social.test.client
 
MockHttpRequest(String) - Constructor for class org.springframework.social.test.client.MockHttpRequest
 
MockHttpRequest(HttpMethod, String) - Constructor for class org.springframework.social.test.client.MockHttpRequest
 
MockRestServiceServer - Class in org.springframework.social.test.client
Main entry point for client-side REST testing.

N

NONE - Static variable in class org.springframework.social.oauth1.OAuth1Parameters
Shared instance for passing zero authorization parameters (common for OAuth 1.0a-based flows).
NoSuchConnectionException - Exception in org.springframework.social.connect
Thrown by a ConnectionRepository when attempting to fetch a Connection and no such connection exists with the provided key.
NoSuchConnectionException(ConnectionKey) - Constructor for exception org.springframework.social.connect.NoSuchConnectionException
 
NotAuthorizedException - Exception in org.springframework.social
Indicates the client is not authorized to invoke the API.
NotAuthorizedException(String) - Constructor for exception org.springframework.social.NotAuthorizedException
 
NotConnectedException - Exception in org.springframework.social.connect
Thrown by a ConnectionRepository when attempting to fetch a "primary" connection and the user is not connected to the provider in question.
NotConnectedException(String) - Constructor for exception org.springframework.social.connect.NotConnectedException
 

O

oauth1Callback(String, NativeWebRequest) - Method in class org.springframework.social.connect.web.ConnectController
Process the authorization callback from an OAuth 1 service provider.
oauth1Callback(String, NativeWebRequest) - Method in class org.springframework.social.connect.web.ProviderSignInController
Process the authentication callback from an OAuth 1 service provider.
OAuth1Connection<A> - Class in org.springframework.social.connect.support
An OAuth1-based Connection implementation.
OAuth1Connection(String, String, String, String, OAuth1ServiceProvider<A>, ApiAdapter<A>) - Constructor for class org.springframework.social.connect.support.OAuth1Connection
Creates a new OAuth1Connection from a OAuth1 access token response.
OAuth1Connection(ConnectionData, OAuth1ServiceProvider<A>, ApiAdapter<A>) - Constructor for class org.springframework.social.connect.support.OAuth1Connection
Creates a new OAuth1Connection from the data provided.
OAuth1ConnectionFactory<A> - Class in org.springframework.social.connect.support
Factory for creating OAuth1-based Connections.
OAuth1ConnectionFactory(String, OAuth1ServiceProvider<A>, ApiAdapter<A>) - Constructor for class org.springframework.social.connect.support.OAuth1ConnectionFactory
Create a OAuth1ConnectionFactory.
OAuth1Operations - Interface in org.springframework.social.oauth1
A service interface for the OAuth 1 flow.
OAuth1Parameters - Class in org.springframework.social.oauth1
Parameters for building an OAuth1 authorize URL.
OAuth1Parameters() - Constructor for class org.springframework.social.oauth1.OAuth1Parameters
Creates a new OAuth1Parameters map that is initially empty.
OAuth1Parameters(Map<String, List<String>>) - Constructor for class org.springframework.social.oauth1.OAuth1Parameters
Creates a new OAuth1Parameters populated from the initial parameters provided.
OAuth1ServiceProvider<A> - Interface in org.springframework.social.oauth1
A ServiceProvider that uses the OAuth 1.0 protocol.
OAuth1Template - Class in org.springframework.social.oauth1
OAuth10Operations implementation that uses REST-template to make the OAuth calls.
OAuth1Template(String, String, String, String, String) - Constructor for class org.springframework.social.oauth1.OAuth1Template
 
OAuth1Template(String, String, String, String, String, OAuth1Version) - Constructor for class org.springframework.social.oauth1.OAuth1Template
 
OAuth1Template(String, String, String, String, String, String) - Constructor for class org.springframework.social.oauth1.OAuth1Template
 
OAuth1Template(String, String, String, String, String, String, OAuth1Version) - Constructor for class org.springframework.social.oauth1.OAuth1Template
 
OAuth1Version - Enum in org.springframework.social.oauth1
Various versions ofthe OAuth1 Core specification.
oauth2Callback(String, NativeWebRequest) - Method in class org.springframework.social.connect.web.ConnectController
Process the authorization callback from an OAuth 2 service provider.
oauth2Callback(String, String, NativeWebRequest) - Method in class org.springframework.social.connect.web.ProviderSignInController
Process the authentication callback from an OAuth 2 service provider.
OAuth2Connection<A> - Class in org.springframework.social.connect.support
An OAuth2-based Connection implementation.
OAuth2Connection(String, String, String, String, Long, OAuth2ServiceProvider<A>, ApiAdapter<A>) - Constructor for class org.springframework.social.connect.support.OAuth2Connection
Creates a new OAuth2Connection from a access grant response.
OAuth2Connection(ConnectionData, OAuth2ServiceProvider<A>, ApiAdapter<A>) - Constructor for class org.springframework.social.connect.support.OAuth2Connection
Creates a new OAuth2Connection from the data provided.
OAuth2ConnectionFactory<S> - Class in org.springframework.social.connect.support
Factory for creating OAuth2-based Connections.
OAuth2ConnectionFactory(String, OAuth2ServiceProvider<S>, ApiAdapter<S>) - Constructor for class org.springframework.social.connect.support.OAuth2ConnectionFactory
Create a OAuth2ConnectionFactory.
OAuth2Operations - Interface in org.springframework.social.oauth2
A service interface for the OAuth2 flow.
OAuth2Parameters - Class in org.springframework.social.oauth2
Parameters for building an OAuth2 authorize URL.
OAuth2Parameters() - Constructor for class org.springframework.social.oauth2.OAuth2Parameters
Creates a new OAuth2Parameters map that is initially empty.
OAuth2Parameters(Map<String, List<String>>) - Constructor for class org.springframework.social.oauth2.OAuth2Parameters
Creates a new OAuth2Parameters populated from the initial parameters provided.
OAuth2ServiceProvider<A> - Interface in org.springframework.social.oauth2
A ServiceProvider that uses the OAuth 2.0 protocol.
OAuth2Template - Class in org.springframework.social.oauth2
OAuth2Operations implementation that uses REST-template to make the OAuth calls.
OAuth2Template(String, String, String, String) - Constructor for class org.springframework.social.oauth2.OAuth2Template
Constructs an OAuth2Template for a given set of client credentials.
OAuth2Template(String, String, String, String, String) - Constructor for class org.springframework.social.oauth2.OAuth2Template
Constructs an OAuth2Template for a given set of client credentials.
OAuth2Version - Enum in org.springframework.social.oauth2
Enum encapsulating the differences between the various versions of the OAuth2 specification.
OAuthToken - Class in org.springframework.social.oauth1
Holds an OAuth token and secret.
OAuthToken(String, String) - Constructor for class org.springframework.social.oauth1.OAuthToken
Create a new OAuth token with a token value and secret.
OperationNotPermittedException - Exception in org.springframework.social
Indicates an operation was attempted that is not permitted.
OperationNotPermittedException(String) - Constructor for exception org.springframework.social.OperationNotPermittedException
 
org.springframework.social - package org.springframework.social
Core Spring Social classes
org.springframework.social.connect - package org.springframework.social.connect
Framework for establishing connections between local users and users of ServiceProviders such as Twitter and Facebook.
org.springframework.social.connect.jdbc - package org.springframework.social.connect.jdbc
JDBC-based ConnectionRepository implementation.
org.springframework.social.connect.support - package org.springframework.social.connect.support
ServiceProvider Connect API implementation support.
org.springframework.social.connect.web - package org.springframework.social.connect.web
Spring MVC Controller for controlling ServiceProvider connect operations.
org.springframework.social.connect.web.taglib - package org.springframework.social.connect.web.taglib
 
org.springframework.social.oauth1 - package org.springframework.social.oauth1
OAuth1 client.
org.springframework.social.oauth2 - package org.springframework.social.oauth2
OAuth2 client.
org.springframework.social.support - package org.springframework.social.support
Internal utilities and helpers used by the Spring Social core module.
org.springframework.social.test.client - package org.springframework.social.test.client
Test framework for ServiceProvider APIs.

P

ParameterMap - Class in org.springframework.social.support
Generally useful base class for creating MultiValueMaps that store HTTP query parameters.
ParameterMap() - Constructor for class org.springframework.social.support.ParameterMap
Creates a new MultiValueMap<String, String> that is initially empty.
ParameterMap(Map<String, List<String>>) - Constructor for class org.springframework.social.support.ParameterMap
Wraps the provided Map<String, List<String>> as a MultiValueMap<String, String>.
postConnect(Connection<S>, WebRequest) - Method in interface org.springframework.social.connect.web.ConnectInterceptor
Called immediately after the connection is established.
postForAccessGrant(String, MultiValueMap<String, String>) - Method in class org.springframework.social.oauth2.OAuth2Template
Posts the request for an access grant to the provider.
preConnect(ConnectionFactory<S>, MultiValueMap<String, String>, WebRequest) - Method in interface org.springframework.social.connect.web.ConnectInterceptor
Called during connection initiation, immediately before user authorization.
provider - Variable in class org.springframework.social.connect.web.taglib.BaseSocialConnectedTag
 
ProviderSignInAttempt - Class in org.springframework.social.connect.web
Models an attempt to sign-in to the application using a provider user identity.
ProviderSignInAttempt(Connection<?>, ConnectionFactoryLocator, UsersConnectionRepository) - Constructor for class org.springframework.social.connect.web.ProviderSignInAttempt
 
ProviderSignInController - Class in org.springframework.social.connect.web
Spring MVC Controller for handling the provider user sign-in flow.
ProviderSignInController(ConnectionFactoryLocator, UsersConnectionRepository, SignInAdapter) - Constructor for class org.springframework.social.connect.web.ProviderSignInController
Creates a new provider sign-in controller.
ProviderSignInUtils - Class in org.springframework.social.connect.web
Helper methods that support provider user sign-in scenarios.
put(String, List<String>) - Method in class org.springframework.social.support.ParameterMap
 
putAll(Map<? extends String, ? extends List<String>>) - Method in class org.springframework.social.support.ParameterMap
 

Q

queryParam(String, String) - Method in class org.springframework.social.support.URIBuilder
Adds a query parameter to the URI
queryParams(MultiValueMap<String, String>) - Method in class org.springframework.social.support.URIBuilder
Adds a query parameters to the URI

R

RateLimitExceededException - Exception in org.springframework.social
Exception thrown when API calls are being rate-limited.
RateLimitExceededException() - Constructor for exception org.springframework.social.RateLimitExceededException
 
refresh() - Method in interface org.springframework.social.connect.Connection
Refresh this connection.
refresh() - Method in class org.springframework.social.connect.support.AbstractConnection
 
refresh() - Method in class org.springframework.social.connect.support.OAuth2Connection
 
refreshAccess(String, String, MultiValueMap<String, String>) - Method in interface org.springframework.social.oauth2.OAuth2Operations
Deprecated. Set the scope via additional parameters. This can be done conveniently user OAuth2Parameters.
refreshAccess(String, MultiValueMap<String, String>) - Method in interface org.springframework.social.oauth2.OAuth2Operations
Refreshes a previous access grant.
refreshAccess(String, String, MultiValueMap<String, String>) - Method in class org.springframework.social.oauth2.OAuth2Template
 
refreshAccess(String, MultiValueMap<String, String>) - Method in class org.springframework.social.oauth2.OAuth2Template
 
registeredProviderIds() - Method in interface org.springframework.social.connect.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.
registeredProviderIds() - Method in class org.springframework.social.connect.support.ConnectionFactoryRegistry
 
RejectedAuthorizationException - Exception in org.springframework.social
Exception indicating that the authorization used during an operation invocation is rejected by the server.
RejectedAuthorizationException(String) - Constructor for exception org.springframework.social.RejectedAuthorizationException
 
remove(Object) - Method in class org.springframework.social.support.ParameterMap
 
removeConnection(ConnectionKey) - Method in interface org.springframework.social.connect.ConnectionRepository
Remove a single Connection for the current user from this repository.
removeConnection(String, String, NativeWebRequest) - Method in class org.springframework.social.connect.web.ConnectController
Remove a single provider connection associated with a user account.
removeConnections(String) - Method in interface org.springframework.social.connect.ConnectionRepository
Remove all Connections between the current user and the provider from this repository.
removeConnections(String, NativeWebRequest) - Method in class org.springframework.social.connect.web.ConnectController
Remove all provider connections for a user account.
RequestMatcher - Interface in org.springframework.social.test.client
Defines the contract for matching requests to expectations.
RequestMatchers - Class in org.springframework.social.test.client
Factory methods for RequestMatcher classes.
requestTo(String) - Static method in class org.springframework.social.test.client.RequestMatchers
Expects a request to the given URI.
requestTo(URI) - Static method in class org.springframework.social.test.client.RequestMatchers
Expects a request to the given URI.
ResourceNotFoundException - Exception in org.springframework.social
Indicates that the requested provider API resource could not be found.
ResourceNotFoundException(String) - Constructor for exception org.springframework.social.ResourceNotFoundException
 
ResponseActions - Interface in org.springframework.social.test.client
Allows for setting up responses and additional expectations.
ResponseCreator - Interface in org.springframework.social.test.client
Allows for creating up responses.
ResponseCreators - Class in org.springframework.social.test.client
Factory methods for ResponseCreator classes.
RevokedAuthorizationException - Exception in org.springframework.social
Exception indicating that the authorization used during an operation invocation has been revoked.
RevokedAuthorizationException() - Constructor for exception org.springframework.social.RevokedAuthorizationException
 
RevokedAuthorizationException(String) - Constructor for exception org.springframework.social.RevokedAuthorizationException
 

S

ServerDownException - Exception in org.springframework.social
Exception indicating that the server is down or being upgraded.
ServerDownException(String) - Constructor for exception org.springframework.social.ServerDownException
 
ServerException - Exception in org.springframework.social
Exception thrown when a server error occurs.
ServerException(String) - Constructor for exception org.springframework.social.ServerException
 
ServerOverloadedException - Exception in org.springframework.social
Exception indicating that the server is experiencing high load.
ServerOverloadedException(String) - Constructor for exception org.springframework.social.ServerOverloadedException
 
ServiceProvider<A> - Interface in org.springframework.social
Top-level marker interface defining a ServiceProvider.
set(String, String) - Method in class org.springframework.social.support.ParameterMap
 
setAll(Map<String, String>) - Method in class org.springframework.social.support.ParameterMap
 
setApplicationUrl(String) - Method in class org.springframework.social.connect.web.ConnectController
Configures the base secure URL for the application this controller is being used in e.g.
setApplicationUrl(String) - Method in class org.springframework.social.connect.web.ConnectSupport
Configures the base secure URL for the application this controller is being used in e.g.
setApplicationUrl(String) - Method in class org.springframework.social.connect.web.ProviderSignInController
Configures the base secure URL for the application this controller is being used in e.g.
setCallbackUrl(String) - Method in class org.springframework.social.oauth1.OAuth1Parameters
Sets the authorization callback url.
setConnectionFactories(List<ConnectionFactory<?>>) - Method in class org.springframework.social.connect.support.ConnectionFactoryRegistry
Set the group of service provider connection factories registered in this registry.
setConnectionSignUp(ConnectionSignUp) - Method in class org.springframework.social.connect.jdbc.JdbcUsersConnectionRepository
The command to execute to create a new local user profile in the event no user id could be mapped to a connection.
setConnectionValues(A, ConnectionValues) - Method in interface org.springframework.social.connect.ApiAdapter
Sets values for ConnectionKey.getProviderUserId(), Connection.getDisplayName(), Connection.getProfileUrl(), and Connection.getImageUrl() for connections to the given API.
setDisplayName(String) - Method in interface org.springframework.social.connect.ConnectionValues
Sets value mapped to Connection.getDisplayName().
setEmail(String) - Method in class org.springframework.social.connect.UserProfileBuilder
Sets the profile email field.
setFirstName(String) - Method in class org.springframework.social.connect.UserProfileBuilder
Sets the profile firstName field.
setHttpMethod(HttpMethod) - Method in class org.springframework.social.test.client.MockClientHttpRequest
 
setImageUrl(String) - Method in interface org.springframework.social.connect.ConnectionValues
Sets value mapped to Connection.getImageUrl()
setInterceptors(List<ConnectInterceptor<?>>) - Method in class org.springframework.social.connect.web.ConnectController
Configure the list of interceptors that should receive callbacks during the connection process.
setLastName(String) - Method in class org.springframework.social.connect.UserProfileBuilder
Sets the profile lastName field.
setName(String) - Method in class org.springframework.social.connect.UserProfileBuilder
Sets the profile name field.
setPostSignInUrl(String) - Method in class org.springframework.social.connect.web.ProviderSignInController
Sets the default URL to redirect the user to after signing in using a provider.
setProfileUrl(String) - Method in interface org.springframework.social.connect.ConnectionValues
Sets value mapped to Connection.getProfileUrl()
setProvider(String) - Method in class org.springframework.social.connect.web.taglib.BaseSocialConnectedTag
 
setProviderUserId(String) - Method in interface org.springframework.social.connect.ConnectionValues
Sets value mapped to ConnectionKey.getProviderUserId().
setRedirectUri(String) - Method in class org.springframework.social.oauth2.OAuth2Parameters
Sets the authorization callback url.
setRequestFactory(ClientHttpRequestFactory) - Method in class org.springframework.social.oauth1.AbstractOAuth1ApiBinding
Set the ClientHttpRequestFactory.
setRequestFactory(ClientHttpRequestFactory) - Method in class org.springframework.social.oauth1.OAuth1Template
Set the request factory on the underlying RestTemplate.
setRequestFactory(ClientHttpRequestFactory) - Method in class org.springframework.social.oauth2.AbstractOAuth2ApiBinding
Set the ClientHttpRequestFactory.
setRequestFactory(ClientHttpRequestFactory) - Method in class org.springframework.social.oauth2.OAuth2Template
Set the request factory on the underlying RestTemplate.
setScope(String) - Method in class org.springframework.social.oauth2.OAuth2Parameters
Sets the permissions the application is seeking with the authorization (optional).
setSignInUrl(String) - Method in class org.springframework.social.connect.web.ProviderSignInController
Sets the URL of the application's sign in page.
setSignUpUrl(String) - Method in class org.springframework.social.connect.web.ProviderSignInController
Sets the URL to redirect the user to if no local user account can be mapped when signing in using a provider.
setState(String) - Method in class org.springframework.social.oauth2.OAuth2Parameters
Sets an opaque key that must be included in the provider's authorization callback (optional).
setTablePrefix(String) - Method in class org.springframework.social.connect.jdbc.JdbcUsersConnectionRepository
Sets a table name prefix.
setUri(URI) - Method in class org.springframework.social.test.client.MockClientHttpRequest
 
setUseAuthenticateUrl(boolean) - Method in class org.springframework.social.connect.web.ConnectSupport
Flag indicating if this instance will support OAuth-based authentication instead of the traditional user authorization.
setUseParametersForClientAuthentication(boolean) - Method in class org.springframework.social.oauth2.OAuth2Template
Set to true to pass client credentials to the provider as parameters instead of using HTTP Basic authentication.
setUsername(String) - Method in class org.springframework.social.connect.UserProfileBuilder
Sets the profile username field.
signIn(String, NativeWebRequest) - Method in class org.springframework.social.connect.web.ProviderSignInController
Process a sign-in form submission by commencing the process of establishing a connection to the provider on behalf of the user.
signIn(String, Connection<?>, NativeWebRequest) - Method in interface org.springframework.social.connect.web.SignInAdapter
Complete a provider sign-in attempt by signing in the local user account with the specified id.
SignInAdapter - Interface in org.springframework.social.connect.web
Adapter that bridges between a ProviderSignInController and a application-specific user sign-in service.
size() - Method in class org.springframework.social.support.ParameterMap
 
SocialConnectedTag - Class in org.springframework.social.connect.web.taglib
JSP Tag to return true/false if you're connected to a provider.
SocialConnectedTag() - Constructor for class org.springframework.social.connect.web.taglib.SocialConnectedTag
 
SocialException - Exception in org.springframework.social
Exception class indicating a problem occurred performing an operation against a service provider.
SocialException(String) - Constructor for exception org.springframework.social.SocialException
 
SocialException(String, Throwable) - Constructor for exception org.springframework.social.SocialException
 
SocialNotConnectedTag - Class in org.springframework.social.connect.web.taglib
JSP Tag to return true/false if you're NOT connected to a provider.
SocialNotConnectedTag() - Constructor for class org.springframework.social.connect.web.taglib.SocialNotConnectedTag
 
sync() - Method in interface org.springframework.social.connect.Connection
Sync's this connection object with the current state of the external user's profile.
sync() - Method in class org.springframework.social.connect.support.AbstractConnection
 

T

test(A) - Method in interface org.springframework.social.connect.ApiAdapter
Implements Connection.test() for connections to the given API.
test() - Method in interface org.springframework.social.connect.Connection
Test this connection.
test() - Method in class org.springframework.social.connect.support.AbstractConnection
 
toSingleValueMap() - Method in class org.springframework.social.support.ParameterMap
 
toString() - Method in class org.springframework.social.connect.ConnectionKey
 

U

UncategorizedApiException - Exception in org.springframework.social
Indicates that an otherwise uncategorized error occurred while consuming a provider API.
UncategorizedApiException(String, Throwable) - Constructor for exception org.springframework.social.UncategorizedApiException
 
updateConnection(Connection<?>) - Method in interface org.springframework.social.connect.ConnectionRepository
Update a Connection already added to this repository.
updateStatus(A, String) - Method in interface org.springframework.social.connect.ApiAdapter
Implements Connection.updateStatus(String) for connections to the given API.
updateStatus(String) - Method in interface org.springframework.social.connect.Connection
Update the user's status on the provider's system.
updateStatus(String) - Method in class org.springframework.social.connect.support.AbstractConnection
 
URIBuilder - Class in org.springframework.social.support
Builds up a URI from individual URI components.
URIBuilderException - Exception in org.springframework.social.support
Exception thrown when URIBuilder can't build the specified URI.
URIBuilderException(String) - Constructor for exception org.springframework.social.support.URIBuilderException
 
URIBuilderException(String, Throwable) - Constructor for exception org.springframework.social.support.URIBuilderException
 
UserProfile - Class in org.springframework.social.connect
A normalized model representing a service provider user profile.
UserProfileBuilder - Class in org.springframework.social.connect
Builder for constructing a UserProfile instance returned by ApiAdapter.fetchUserProfile(Object) Makes it easy to construct a profile instance where some of the individual fields may be null.
UserProfileBuilder() - Constructor for class org.springframework.social.connect.UserProfileBuilder
 
UsersConnectionRepository - Interface in org.springframework.social.connect
A data access interface for managing a global store of users connections to service providers.

V

valueOf(String) - Static method in enum org.springframework.social.oauth1.OAuth1Version
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.springframework.social.oauth2.GrantType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.springframework.social.oauth2.OAuth2Version
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.springframework.social.oauth1.OAuth1Version
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.springframework.social.oauth2.GrantType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.springframework.social.oauth2.OAuth2Version
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Method in class org.springframework.social.support.ParameterMap
 
verify() - Method in class org.springframework.social.test.client.MockRestServiceServer
Verifies that all expectations were met.

W

withResponse(String, HttpHeaders, HttpStatus, String) - Static method in class org.springframework.social.test.client.ResponseCreators
Respond with a given response body, headers, status code, and status text.
withResponse(String, HttpHeaders) - Static method in class org.springframework.social.test.client.ResponseCreators
Response with a given response body and headers.
withResponse(Resource, HttpHeaders, HttpStatus, String) - Static method in class org.springframework.social.test.client.ResponseCreators
Respond with a given response body (from a Resource) and headers.
withResponse(Resource, HttpHeaders) - Static method in class org.springframework.social.test.client.ResponseCreators
Response with a given response body and headers.

A B C D E F G H I J K M N O P Q R S T U V W
Spring Social