org.springframework.social.connect.support

Class OAuth1Connection<A>

java.lang.Object

org.springframework.social.connect.support.AbstractConnection<A>

org.springframework.social.connect.support.OAuth1Connection<A>

Type Parameters:

A - the service API type

All Implemented Interfaces:

Serializable, Connection<A>

public class OAuth1Connection<A>
extends AbstractConnection<A>

An OAuth1-based Connection implementation. In general, this implementation is expected to be suitable for all OAuth1-based providers and should not require subclassing. Subclasses of OAuth1ConnectionFactory should be favored to encapsulate details specific to an OAuth1-based provider.

See Also:

OAuth1ConnectionFactory, Serialized Form

Constructor Summary

Constructors

Constructor and Description
OAuth1Connection(ConnectionData data, OAuth1ServiceProvider<A> serviceProvider, ApiAdapter<A> apiAdapter) Creates a new OAuth1Connection from the data provided.
OAuth1Connection(String providerId, String providerUserId, String accessToken, String secret, OAuth1ServiceProvider<A> serviceProvider, ApiAdapter<A> apiAdapter) Creates a new OAuth1Connection from a OAuth1 access token response.

Method Summary

Methods

Modifier and Type	Method and Description
ConnectionData	createData() Creates a data transfer object that can be used to persist the state of this connection.
boolean	equals(Object obj)
A	getApi() A Java binding to the service provider's native API.
int	hashCode()

Methods inherited from class org.springframework.social.connect.support.AbstractConnection

fetchUserProfile, getDisplayName, getImageUrl, getKey, getMonitor, getProfileUrl, hasExpired, initKey, refresh, sync, test, updateStatus

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuth1Connection

public OAuth1Connection(String providerId,
                String providerUserId,
                String accessToken,
                String secret,
                OAuth1ServiceProvider<A> serviceProvider,
                ApiAdapter<A> apiAdapter)

Creates a new OAuth1Connection from a OAuth1 access token response. Designed to be called to establish a new OAuth1Connection after receiving an access token response successfully. The providerUserId may be null in this case: if so, this constructor will try to resolve it using the service API obtained from the OAuth1ServiceProvider.

Parameters:

providerId - the provider id e.g. "twitter"

providerUserId - the provider user ID (may be null if not returned as part of the access token response)

accessToken - the granted access token

secret - the access token secret (OAuth1-specific)

serviceProvider - the OAuth1-based ServiceProvider

apiAdapter - the ApiAdapter for the ServiceProvider

OAuth1Connection

public OAuth1Connection(ConnectionData data,
                OAuth1ServiceProvider<A> serviceProvider,
                ApiAdapter<A> apiAdapter)

Creates a new OAuth1Connection from the data provided. Designed to be called when re-constituting an existing Connection using ConnectionData.

Parameters:

data - the data holding the state of this connection

serviceProvider - the OAuth1-based ServiceProvider

apiAdapter - the ApiAdapter for the ServiceProvider

Method Detail

getApi

public A getApi()

Description copied from interface: Connection

A Java binding to the service provider's native API.

Specified by:

getApi in interface Connection<A>

Specified by:

getApi in class AbstractConnection<A>

Returns:

the provider-specific API binding

createData

public ConnectionData createData()

Description copied from interface: Connection

Creates a data transfer object that can be used to persist the state of this connection. Used to support the transfer of connection state between layers of the application, such as to the database layer.

Specified by:

createData in interface Connection<A>

Specified by:

createData in class AbstractConnection<A>

Returns:

a data transfer object containing details about the connection.

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractConnection<A>

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractConnection<A>