de.undercouch.citeproc.remote

Class AuthenticatedRemoteConnector

java.lang.Object

de.undercouch.citeproc.remote.RemoteConnectorAdapter

de.undercouch.citeproc.remote.AuthenticatedRemoteConnector

All Implemented Interfaces:

RemoteConnector

public class AuthenticatedRemoteConnector
extends RemoteConnectorAdapter

A remote connector that saves its access token in an authentication store, so you don't have to authenticate again until the access token becomes invalid.

Author:

Michel Kraemer

Constructor Summary

Constructors

Constructor and Description
AuthenticatedRemoteConnector(RemoteConnector delegate, AuthenticationStore store) Creates a connector that delegates to an underlying connector and saves its access token in an authentication store

Method Summary

Modifier and Type	Method and Description
void	authorize(String verificationCode) Authorizes the app.
void	setAccessToken(String token, String secret) Authorizes the app.

Methods inherited from class de.undercouch.citeproc.remote.RemoteConnectorAdapter

getAccessTokenSecret, getAccessTokenValue, getAuthorizationURL, getItem, getItemIDs, getItems, getMaxBulkItems

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticatedRemoteConnector

public AuthenticatedRemoteConnector(RemoteConnector delegate,
                                    AuthenticationStore store)

Creates a connector that delegates to an underlying connector and saves its access token in an authentication store

Parameters:

delegate - the underlying connector

store - the authentication store

Method Detail

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

Overrides:

authorize in class RemoteConnectorAdapter

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

Overrides:

setAccessToken in class RemoteConnectorAdapter

Parameters:

token - the access token value

secret - the access token's secret

See Also:

RemoteConnector.getAccessTokenValue(), RemoteConnector.getAccessTokenSecret()