org.opensocial.auth

Class OAuth2LeggedScheme

java.lang.Object

org.opensocial.auth.OAuth2LeggedScheme

All Implemented Interfaces:

Serializable, AuthScheme

public class OAuth2LeggedScheme
extends Object
implements AuthScheme

Authentication class that uses 2-Legged OAuth to digitally sign requests using a shared secret; this scheme is also known as Signed Fetch and Phone Home. For reference: http://sites.google.com/site/oauthgoog/2leggedoauth/2opensocialrestapi

Author:

Jason Cooper

See Also:

Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
OAuth2LeggedScheme(String consumerKey, String consumerSecret) Creates and returns a new OAuth2LeggedScheme configured with the passed key and secret, leaving the requester ID field null.
OAuth2LeggedScheme(String consumerKey, String consumerSecret, String requesterId) Creates and returns a new OAuth2LeggedScheme configured with the passed key, secret, and requester ID.

Method Summary

Methods

Modifier and Type	Method and Description
protected InputStream	byteArrayToStream(byte[] bytes)
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)
String	getRequesterId()

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

OAuth2LeggedScheme

public OAuth2LeggedScheme(String consumerKey,
                  String consumerSecret)

Creates and returns a new OAuth2LeggedScheme configured with the passed key and secret, leaving the requester ID field null.

Parameters:

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

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

OAuth2LeggedScheme

public OAuth2LeggedScheme(String consumerKey,
                  String consumerSecret,
                  String requesterId)

Creates and returns a new OAuth2LeggedScheme configured with the passed key, secret, and requester ID.

Parameters:

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

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

requesterId - OpenSocial ID of user on whose behalf the OpenSocial calls are being made

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

getRequesterId

public String getRequesterId()

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