de.undercouch.citeproc.remote

Class AbstractRemoteConnector

java.lang.Object

de.undercouch.citeproc.remote.AbstractRemoteConnector

All Implemented Interfaces:

RemoteConnector

Direct Known Subclasses:

MendeleyConnector, ZoteroConnector

public abstract class AbstractRemoteConnector
extends Object
implements RemoteConnector

Abstract base class for remote connectors

Author:

Michel Kraemer

Field Summary

Fields

Modifier and Type	Field and Description
protected Token	accessToken The access token used to sign requests
protected OAuth	auth OAuth client that is used to authenticate the user
protected Token	requestToken The request token used to authorize the app

Constructor Summary

Constructors

Constructor and Description
AbstractRemoteConnector(String consumerKey, String consumerSecret, String redirectUri) Constructs a new connector

Method Summary

Modifier and Type	Method and Description
void	authorize(String verificationCode) Authorizes the app.
protected OAuth	createOAuth(String consumerKey, String consumerSecret, String redirectUri) Creates an OAuth object
String	getAccessTokenSecret()
String	getAccessTokenValue()
String	getAuthorizationURL() Gets a new authorization URL from the remote server.
protected abstract OAuth.Method	getOAuthAccessTokenMethod()
protected abstract String	getOAuthAccessTokenURL()
protected abstract String	getOAuthAuthorizationURL()
protected abstract String	getOAuthRequestTokenURL()
protected List<Object>	parseResponseArray(Response response) Parses the given response.
protected Map<String,Object>	parseResponseObject(Response response) Parses the given response.
protected Response	performRequest(String url, Map<String,String> additionalHeaders) Performs a request
protected List<Object>	performRequestArray(String url, Map<String,String> additionalHeaders) Performs a request
protected Map<String,Object>	performRequestObject(String url, Map<String,String> additionalHeaders) Performs a request
void	setAccessToken(String token, String secret) Authorizes the app.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.undercouch.citeproc.remote.RemoteConnector

getItem, getItemIDs, getItems, getMaxBulkItems

Field Detail

auth

protected final OAuth auth

OAuth client that is used to authenticate the user

requestToken

protected Token requestToken

The request token used to authorize the app

accessToken

protected Token accessToken

The access token used to sign requests

Constructor Detail

AbstractRemoteConnector

public AbstractRemoteConnector(String consumerKey,
                               String consumerSecret,
                               String redirectUri)

Constructs a new connector

Parameters:

consumerKey - the app's consumer key

consumerSecret - the app's consumer secret

redirectUri - the location users are redirected to after they granted the app access

Method Detail

getOAuthRequestTokenURL

protected abstract String getOAuthRequestTokenURL()

Returns:

the remote service's end-point for temporary credentials or null if not supported

getOAuthAuthorizationURL

protected abstract String getOAuthAuthorizationURL()

Returns:

the remote service's authorization end-point

getOAuthAccessTokenURL

protected abstract String getOAuthAccessTokenURL()

Returns:

the remote service's end-point for access tokens

getOAuthAccessTokenMethod

protected abstract OAuth.Method getOAuthAccessTokenMethod()

Returns:

the HTTP method to use while requesting access tokens

createOAuth

protected OAuth createOAuth(String consumerKey,
                            String consumerSecret,
                            String redirectUri)

Creates an OAuth object

Parameters:

consumerKey - the app's consumer key

consumerSecret - the app's consumer secret

redirectUri - the location users are redirected to after they granted the app access

Returns:

the created object

getAuthorizationURL

public String getAuthorizationURL()
                           throws IOException

Description copied from interface: RemoteConnector

Gets a new authorization URL from the remote server. This is the first step in the OAuth authorization process. The user has to visit the authorization URL and grant access to this app. Then they will get an verification code which has to be passed to RemoteConnector.authorize(String)

Specified by:

getAuthorizationURL in interface RemoteConnector

Returns:

the URL the authorization URL

Throws:

IOException - if the authorization URL could not be retrieved

authorize

public void authorize(String verificationCode)
               throws IOException

Description copied from interface: RemoteConnector

Authorizes the app. This is the third step in the OAuth authorization process. After the user has visited the authorization URL that was generated by RemoteConnector.getAuthorizationURL(), this method has to be called to finish authorization

Specified by:

authorize in interface RemoteConnector

Parameters:

verificationCode - the verification code the user received from the authorization URL

Throws:

IOException - if authorization failed

setAccessToken

public void setAccessToken(String token,
                           String secret)

Description copied from interface: RemoteConnector

Authorizes the app. If you already know a valid OAuth access token (for example if you cached it from previous sessions) you may call this method instead of RemoteConnector.getAuthorizationURL() and RemoteConnector.authorize(String).

This method just saves the provided access token. It does not act with the remote service in any way.

Specified by:

setAccessToken in interface RemoteConnector

Parameters:

token - the access token value

secret - the access token's secret

See Also:

RemoteConnector.getAccessTokenValue(), RemoteConnector.getAccessTokenSecret()

getAccessTokenValue

public String getAccessTokenValue()

Specified by:

getAccessTokenValue in interface RemoteConnector

Returns:

the access token's value used for authentication or null if the app is not yet authenticated

See Also:

RemoteConnector.setAccessToken(String, String)

getAccessTokenSecret

public String getAccessTokenSecret()

Specified by:

getAccessTokenSecret in interface RemoteConnector

Returns:

the access token's secret used for authentication or null if the app is not yet authenticated

See Also:

RemoteConnector.setAccessToken(String, String)

performRequestObject

protected Map<String,Object> performRequestObject(String url,
                                                  Map<String,String> additionalHeaders)
                                           throws IOException

Performs a request

Parameters:

url - the URL to query

additionalHeaders - additional HTTP request headers (may be null)

Returns:

the parsed response

Throws:

IOException - if the request was not successful

performRequestArray

protected List<Object> performRequestArray(String url,
                                           Map<String,String> additionalHeaders)
                                    throws IOException

Performs a request

Parameters:

url - the URL to query

additionalHeaders - additional HTTP request headers (may be null)

Returns:

the parsed response

Throws:

IOException - if the request was not successful

performRequest

protected Response performRequest(String url,
                                  Map<String,String> additionalHeaders)
                           throws IOException

Performs a request

Parameters:

url - the URL to query

additionalHeaders - additional HTTP request headers (may be null)

Returns:

the response

Throws:

IOException - if the request was not successful

parseResponseObject

protected Map<String,Object> parseResponseObject(Response response)
                                          throws IOException

Parses the given response. The response's input stream doesn't have to be closed. The caller will already do this.

Parameters:

response - the HTTP response to parse

Returns:

the parsed result

Throws:

IOException - if the response could not be read

parseResponseArray

protected List<Object> parseResponseArray(Response response)
                                   throws IOException

Parses the given response. The response's input stream doesn't have to be closed. The caller will already do this.

Parameters:

response - the HTTP response to parse

Returns:

the parsed result

Throws:

IOException - if the response could not be read