org.opensocial.auth

Class OAuth3LeggedScheme

java.lang.Object

org.opensocial.auth.OAuth3LeggedScheme

All Implemented Interfaces:

Serializable, AuthScheme

public class OAuth3LeggedScheme
extends Object
implements AuthScheme, Serializable

Authentication class that exposes methods for retrieving request and access tokens and an appropriate authorization URL for the 3-Legged OAuth "dance." For reference: http://sites.google.com/site/oauthgoog/2leggedoauth/2opensocialrestapi

Author:

Christoph Renner, Jason Cooper

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OAuth3LeggedScheme.Token

Field Summary

Fields

Modifier and Type	Field and Description
protected String	consumerKey
protected String	consumerSecret

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OAuth3LeggedScheme()
	OAuth3LeggedScheme(Provider provider, String consumerKey, String consumerSecret) Creates and returns a new OAuth3LeggedScheme configured with the passed Provider, key, and secret.
	OAuth3LeggedScheme(Provider provider, String consumerKey, String consumerSecret, HttpClient httpClient) Creates and returns a new OAuth3LeggedScheme configured with the passed Provider, key, secret, and HttpClient.

Method Summary

Methods

Modifier and Type	Method and Description
protected InputStream	byteArrayToStream(byte[] bytes)
OAuth3LeggedScheme.Token	getAccessToken() Returns the access token for which the original request token was exchanged or null if the exchange hasn't occurred and no access token is associated with the current instance.
String	getAuthorizationUrl(String callbackUrl) Sends a signed request to the associated provider to retrieve an initial request token.
String	getConsumerKey()
String	getConsumerSecret()
protected net.oauth.http.HttpMessage	getHttpMessage(net.oauth.OAuthMessage message, net.oauth.OAuthAccessor accessor, byte[] body, boolean signBodyHash)
net.oauth.http.HttpMessage	getHttpMessage(Provider provider, String method, String url, Map<String,String> headers, byte[] body)
net.oauth.http.HttpMessage	getHttpMessage(Provider provider, String method, String url, Map<String,String> headers, byte[] body, Collection<? extends Map.Entry> parameters)
Provider	getProvider() Returns the associated provider.
OAuth3LeggedScheme.Token	getRequestToken() Returns the request token previously retrieved from the provider when getAuthorizationUrl was executed or null if no request token is associated with the current instance.
void	requestAccessToken(String oAuthToken) Sends a signed request to the associated provider to exchange the passed request token for an access token; if successfully exchanged, this token can then be accessed using getAccessToken().
void	requestAccessToken(String oAuthToken, String oAuthVerifier) Sends a signed request to the associated provider to exchange the passed request token for an access token; if successfully exchanged, this token can then be accessed using getAccessToken().
void	setAccessToken(OAuth3LeggedScheme.Token token) Associates the specified access token with the current instance.
void	setRequestToken(OAuth3LeggedScheme.Token token) Associates the specified request token with the current instance.

Methods inherited from class java.lang.Object

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

Field Detail

consumerKey

protected String consumerKey

consumerSecret

protected String consumerSecret

Constructor Detail

OAuth3LeggedScheme

protected OAuth3LeggedScheme()

OAuth3LeggedScheme

public OAuth3LeggedScheme(Provider provider,
                  String consumerKey,
                  String consumerSecret)

Creates and returns a new OAuth3LeggedScheme configured with the passed Provider, key, and secret.

Parameters:

provider - OpenSocial provider that the current user should be authenticated against; must have the three required 3-legged OAuth endpoints set (see GoogleProvider and MySpaceProvider for reference)

consumerKey - key provided by an OpenSocial container after registering a new application

consumerSecret - secret provided by an OpenSocial container after registering a new application

OAuth3LeggedScheme

public OAuth3LeggedScheme(Provider provider,
                  String consumerKey,
                  String consumerSecret,
                  HttpClient httpClient)

Creates and returns a new OAuth3LeggedScheme configured with the passed Provider, key, secret, and HttpClient.

Parameters:

provider - OpenSocial provider that the current user should be authenticated against; must have the three required 3-legged OAuth endpoints set (see GoogleProvider and MySpaceProvider for reference)

consumerKey - key provided by an OpenSocial container after registering a new application

consumerSecret - secret provided by an OpenSocial container after registering a new application

httpClient - HttpClient to use to execute the OAuth requests

Method Detail

getHttpMessage

public net.oauth.http.HttpMessage getHttpMessage(Provider provider,
                                        String method,
                                        String url,
                                        Map<String,String> headers,
                                        byte[] body)
                                          throws RequestException,
                                                 IOException

Specified by:

getHttpMessage in interface AuthScheme

Throws:

RequestException

IOException

getHttpMessage

public net.oauth.http.HttpMessage getHttpMessage(Provider provider,
                                        String method,
                                        String url,
                                        Map<String,String> headers,
                                        byte[] body,
                                        Collection<? extends Map.Entry> parameters)
                                          throws RequestException,
                                                 IOException

Throws:

RequestException

IOException

getAuthorizationUrl

public String getAuthorizationUrl(String callbackUrl)
                           throws net.oauth.OAuthException,
                                  URISyntaxException,
                                  IOException

Sends a signed request to the associated provider to retrieve an initial request token. If successful, returns a URL to the associated provider's authorization page; after being forwarded to this URL, the user will be prompted to enter their account credentials and upon successful sign-in, will be forwarded again to the specified callback URL.

Parameters:

callbackUrl - URL to forward user to after successful sign-in

Returns:

URL to provider's authorization page as a string

Throws:

net.oauth.OAuthException

URISyntaxException

IOException

requestAccessToken

public void requestAccessToken(String oAuthToken)
                        throws net.oauth.OAuthException,
                               URISyntaxException,
                               IOException

Sends a signed request to the associated provider to exchange the passed request token for an access token; if successfully exchanged, this token can then be accessed using getAccessToken().

Parameters:

oAuthToken - previously fetched request token to exchange for access token

Throws:

net.oauth.OAuthException

URISyntaxException

IOException

requestAccessToken

public void requestAccessToken(String oAuthToken,
                      String oAuthVerifier)
                        throws net.oauth.OAuthException,
                               URISyntaxException,
                               IOException

Sends a signed request to the associated provider to exchange the passed request token for an access token; if successfully exchanged, this token can then be accessed using getAccessToken().

Parameters:

oAuthToken - previously fetched request token to exchange for access token

oAuthVerifier - verification code returned by some providers, e.g. Yahoo

Throws:

net.oauth.OAuthException

URISyntaxException

IOException

getProvider

public Provider getProvider()

Returns the associated provider.

getRequestToken

public OAuth3LeggedScheme.Token getRequestToken()

Returns the request token previously retrieved from the provider when getAuthorizationUrl was executed or null if no request token is associated with the current instance.

See Also:

getAuthorizationUrl(String)

getAccessToken

public OAuth3LeggedScheme.Token getAccessToken()

Returns the access token for which the original request token was exchanged or null if the exchange hasn't occurred and no access token is associated with the current instance.

See Also:

requestAccessToken(String)

setRequestToken

public void setRequestToken(OAuth3LeggedScheme.Token token)

Associates the specified request token with the current instance.

Parameters:

token - request token to associate

setAccessToken

public void setAccessToken(OAuth3LeggedScheme.Token token)

Associates the specified access token with the current instance.

Parameters:

token - access token to associate

getConsumerKey

public String getConsumerKey()

getConsumerSecret

public String getConsumerSecret()

byteArrayToStream

protected InputStream byteArrayToStream(byte[] bytes)

getHttpMessage

protected net.oauth.http.HttpMessage getHttpMessage(net.oauth.OAuthMessage message,
                                        net.oauth.OAuthAccessor accessor,
                                        byte[] body,
                                        boolean signBodyHash)
                                             throws IOException,
                                                    RequestException

Throws:

IOException

RequestException