de.undercouch.citeproc.helper.oauth

Interface OAuth

All Known Implementing Classes:

OAuth1, OAuth2, ZoteroOAuth

public interface OAuth

Performs OAuth authentication (either version 1 or 2)

Author:

Michel Kraemer

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	OAuth.Method HTTP request methods

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.

Method Detail

requestTemporaryCredentials

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

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

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

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

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 requestTemporaryCredentials(URL, Method)

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

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

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.

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

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

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.

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