de.undercouch.citeproc.remote

Class RemoteConnectorAdapter

java.lang.Object

de.undercouch.citeproc.remote.RemoteConnectorAdapter

All Implemented Interfaces:

RemoteConnector

Direct Known Subclasses:

AuthenticatedRemoteConnector

public class RemoteConnectorAdapter
extends Object
implements RemoteConnector

Can be used by RemoteConnector implementations to delegate to an underlying connector

Author:

Michel Kraemer

Constructor Summary

Constructors

Constructor and Description
RemoteConnectorAdapter(RemoteConnector delegate) Creates a new adapter for the given underlying connector

Method Summary

Modifier and Type	Method and Description
void	authorize(String verificationCode) Authorizes the app.
String	getAccessTokenSecret()
String	getAccessTokenValue()
String	getAuthorizationURL() Gets a new authorization URL from the remote server.
CSLItemData	getItem(String itemId) Requests an item from the service.
List<String>	getItemIDs() Requests a list of item IDs from the server.
Map<String,CSLItemData>	getItems(List<String> itemIds) Requests several items from the service.
int	getMaxBulkItems()
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

Constructor Detail

RemoteConnectorAdapter

public RemoteConnectorAdapter(RemoteConnector delegate)

Creates a new adapter for the given underlying connector

Parameters:

delegate - the underlying connector

Method Detail

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)

getItemIDs

public List<String> getItemIDs()
                        throws IOException

Description copied from interface: RemoteConnector

Requests a list of item IDs from the server. The user has to be authenticated before this method can be called.

Specified by:

getItemIDs in interface RemoteConnector

Returns:

the item IDs

Throws:

UnauthorizedException - if the user is not authenticated

RequestException - if the server returns an error code

IOException - if the items could not be read from the server

getItem

public CSLItemData getItem(String itemId)
                    throws IOException

Description copied from interface: RemoteConnector

Requests an item from the service. The user has to be authenticated before this method can be called.

Specified by:

getItem in interface RemoteConnector

Parameters:

itemId - the item's ID

Returns:

the item

Throws:

UnauthorizedException - if the user is not authenticated

RequestException - if the server returns an error code

IOException - if the item could not be read from the server

getItems

public Map<String,CSLItemData> getItems(List<String> itemIds)
                                 throws IOException

Description copied from interface: RemoteConnector

Requests several items from the service. The user has to be authenticated before this method can be called.

Some services support bulk loading. In this case, this method makes as few requests as possible. The RemoteConnector.getMaxBulkItems() method returns the maximum number of items that can be queried within one request.

Specified by:

getItems in interface RemoteConnector

Parameters:

itemIds - the IDs of the items to request

Returns:

a map mapping item IDs to retrieved items

Throws:

UnauthorizedException - if the user is not authenticated

RequestException - if the server returns an error code

IOException - if one of the items could not be read from the server

See Also:

RemoteConnector.getMaxBulkItems()

getMaxBulkItems

public int getMaxBulkItems()

Specified by:

getMaxBulkItems in interface RemoteConnector

Returns:

the maximum number of items that can be queried within one request

See Also:

RemoteConnector.getItems(List)