oauth1

Class OAuth1WithCallback

java.lang.Object

oauth1.OAuth1Generic

oauth1.OAuth1WithCallback

public class OAuth1WithCallback
extends OAuth1Generic

An OAuth1.0 consumer class, using the HMAC signing strategy.

This is a consumer supporting a callback.

Usage:
1. Call begin() to obtain a temporary token and a redirect URL if OAuth1Generic.authoriseUrl was provided (not null).
2. On the front-end, redirect the user to the redirect URL obtained in (1), or compute the redirect URL from the temporary token obtained in (1).
3. Once the user has granted access on the redirect URL (usually detected via the callback), call authorised(String, String) with the temporary token obtained in (1), and the verifier (provided as a parameter to the callback, as parsed on the front-end).
4. If (3) succeeded, you now have an access token and an OAuthParameters object that can be used to make requests on the user's behalf. Using the OAuthParameters make a request to a given URL with a given HTTP request method and body via OAuth1Generic.makeOAuthBackedRequest(String, OAuthParameters, RequestMethod, HttpContent).

Author:

Omar Tanner

Field Summary

Fields inherited from class oauth1.OAuth1Generic

accessTokenUrl, authoriseUrl, callbackUrl, consumerKey, consumerSecret, requestTokenUrl, tokenMapStrategy

Constructor Summary

Constructors

Constructor and Description
OAuth1WithCallback(String consumerKey, String consumerSecret, String requestTokenUrl, String callbackUrl, String authoriseUrl, String accessTokenUrl, TokenMapStrategy tokenMapStrategy)

Method Summary

Modifier and Type	Method and Description
AuthorisedResult	authorised(String temporaryToken, String verifier) Fetches the token secret corresponding to the temporary token, then uses the obtained token secret along with the original temporary token and verifier to obtain an access token from the server.
BeginResult	begin() Requests a temporary token and corresponding token secret from the server, then maps the temporary token to the token secret and returns the obtained temporary token along with the authenticate URL (redirect URL) if OAuth1Generic.authoriseUrl is non-null.

Methods inherited from class oauth1.OAuth1Generic

makeOAuthBackedRequest

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuth1WithCallback

public OAuth1WithCallback(@Nonnull
                          String consumerKey,
                          @Nonnull
                          String consumerSecret,
                          @Nonnull
                          String requestTokenUrl,
                          @Nonnull
                          String callbackUrl,
                          @Nullable
                          String authoriseUrl,
                          @Nonnull
                          String accessTokenUrl,
                          @Nonnull
                          TokenMapStrategy tokenMapStrategy)

Parameters:

consumerKey - Required identifier portion of the client credentials (equivalent to a username). More information: client_id entry of the OAuthParameters table at https://www.iana.org/assignments/oauth-parameters/oauth-parameters.xhtml

consumerSecret - Client-shared secret. More information: client_id entry of the OAuthParameters table at https://www.iana.org/assignments/oauth-parameters/oauth-parameters.xhtml

requestTokenUrl - Encoded authorization server URL. More information: request_uri entry of the OAuthParameters table at https://www.iana.org/assignments/oauth-parameters/oauth-parameters.xhtml

callbackUrl - Optional absolute URI back to which the server will redirect the resource owner when the Resource Owner Authorization step is completed or null for none. More information: redirect_uri entry of the OAuthParameters table at https://www.iana.org/assignments/oauth-parameters/oauth-parameters.xhtml

authoriseUrl - Encoded user authorization URL, or null if only wish to receive the temporary token and build it themselves.

accessTokenUrl - Encoded authorization server URL.

tokenMapStrategy - Strategy to map temporary tokens to token secrets, and fetch the token secret for a temporary token.

Method Detail

begin

@Nonnull
public BeginResult begin()
                            throws GetTemporaryTokenException,
                                   TokenMapException

Requests a temporary token and corresponding token secret from the server, then maps the temporary token to the token secret and returns the obtained temporary token along with the authenticate URL (redirect URL) if OAuth1Generic.authoriseUrl is non-null.

Overrides:

begin in class OAuth1Generic

Returns:

Temporary token from the server and the authenticate URL (redirect URL) if if OAuth1Generic.authoriseUrl is non-null, otherwise null.

Throws:

GetTemporaryTokenException - If the request to the server for the temporary token failed.

TokenMapException - If mapping the obtained temporary token to the obtained token secret failed.

authorised

@Nonnull
public AuthorisedResult authorised(@Nonnull
                                             String temporaryToken,
                                             @Nonnull
                                             String verifier)
                                      throws GetAccessTokenException,
                                             TokenMapException

Fetches the token secret corresponding to the temporary token, then uses the obtained token secret along with the original temporary token and verifier to obtain an access token from the server.

Overrides:

authorised in class OAuth1Generic

Parameters:

temporaryToken - The temporary token obtained from begin()

verifier - The verifier.

Returns:

Access token from the server, and an OAuthParameters object used to make OAuth-backed requests on behalf of the access token via OAuth1Generic.makeOAuthBackedRequest(String, OAuthParameters, RequestMethod, HttpContent)

Throws:

GetAccessTokenException - If the request to the server for the access token failed.

TokenMapException - If fetching the token secret corresponding to the given temporary token failed.