de.undercouch.citeproc.helper.oauth

Class OAuth1

java.lang.Object

de.undercouch.citeproc.helper.oauth.OAuth1

All Implemented Interfaces:

OAuth

Direct Known Subclasses:

ZoteroOAuth

public class OAuth1
extends Object
implements OAuth

Performs OAuth authentication. Very minimal implementation, only used for Zotero authentication currently.

Author:

Michel Kraemer

Nested Class Summary

Nested classes/interfaces inherited from interface de.undercouch.citeproc.helper.oauth.OAuth

OAuth.Method

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	OAUTH_TOKEN Service response item specifying a token's value
protected static String	OAUTH_TOKEN_SECRET Service response item specifying a token's secret

Constructor Summary

Constructors

Constructor and Description
OAuth1(String consumerKey, String consumerSecret) Creates a new OAuth client

Method Summary

Modifier and Type	Method and Description
Response	request(URL url, OAuth.Method method, Token token) Sends a request to the server and returns an input stream from which the response can be read.
Response	request(URL url, OAuth.Method method, Token token, Map<String,String> additionalHeaders) Sends a request to the server and returns an input stream from which the response can be read.
Token	requestTemporaryCredentials(URL url, OAuth.Method method) Requests temporary credentials.
Token	requestTokenCredentials(URL url, OAuth.Method method, Token temporaryCredentials, String verifier) Requests token credentials.
protected Token	responseToToken(Map<String,String> response) Parses a service response and creates a token

Methods inherited from class java.lang.Object

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

Field Detail

OAUTH_TOKEN

protected static final String OAUTH_TOKEN

Service response item specifying a token's value

See Also:

Constant Field Values

OAUTH_TOKEN_SECRET

protected static final String OAUTH_TOKEN_SECRET

Service response item specifying a token's secret

See Also:

Constant Field Values

Constructor Detail

OAuth1

public OAuth1(String consumerKey,
              String consumerSecret)

Creates a new OAuth client

Parameters:

consumerKey - the consumer key

consumerSecret - the consumer secret

Method Detail

requestTemporaryCredentials

public Token requestTemporaryCredentials(URL url,
                                         OAuth.Method method)
                                  throws IOException

Description copied from interface: OAuth

Requests temporary credentials. This is the first step in the OAuth authentication process. The temporary credentials are used to generate an authorization URL.

Specified by:

requestTemporaryCredentials in interface OAuth

Parameters:

url - the URL from which the temporary credentials should be requested

method - the HTTP request method

Returns:

the temporary credentials

Throws:

IOException - if the request was not successful

RequestException - if the server returned an error

UnauthorizedException - if the request is not authorized

requestTokenCredentials

public Token requestTokenCredentials(URL url,
                                     OAuth.Method method,
                                     Token temporaryCredentials,
                                     String verifier)
                              throws IOException

Description copied from interface: OAuth

Requests token credentials. This is the third step in the OAuth authentication process after the user has authenticated the app using the authorization URL and the temporary credentials created with OAuth.requestTemporaryCredentials(URL, Method)

Specified by:

requestTokenCredentials in interface OAuth

Parameters:

url - the URL from which the token credentials should be requested

method - the HTTP request method

temporaryCredentials - the temporary credentials

verifier - the verification code returned by the OAuth server

Returns:

the token credentials

Throws:

IOException - if the request was not successful

RequestException - if the server returned an error

UnauthorizedException - if the request is not authorized

request

public Response request(URL url,
                        OAuth.Method method,
                        Token token)
                 throws IOException

Description copied from interface: OAuth

Sends a request to the server and returns an input stream from which the response can be read. The caller is responsible for consuming the input stream's content and for closing the stream.

Specified by:

request in interface OAuth

Parameters:

url - the URL to send the request to

method - the HTTP request method

token - a token used for authorization (may be null if the authorization is not required for this request)

Returns:

a response

Throws:

IOException - if the request was not successful

RequestException - if the server returned an error

UnauthorizedException - if the request is not authorized

request

public Response request(URL url,
                        OAuth.Method method,
                        Token token,
                        Map<String,String> additionalHeaders)
                 throws IOException

Description copied from interface: OAuth

Sends a request to the server and returns an input stream from which the response can be read. The caller is responsible for consuming the input stream's content and for closing the stream.

Specified by:

request in interface OAuth

Parameters:

url - the URL to send the request to

method - the HTTP request method

token - a token used for authorization (may be null if the authorization is not required for this request)

additionalHeaders - additional HTTP headers (may be null)

Returns:

a response

Throws:

IOException - if the request was not successful

RequestException - if the server returned an error

UnauthorizedException - if the request is not authorized

responseToToken

protected Token responseToToken(Map<String,String> response)

Parses a service response and creates a token

Parameters:

response - the response

Returns:

the token