de.undercouch.citeproc.zotero

Class ZoteroConnector

java.lang.Object

de.undercouch.citeproc.remote.AbstractRemoteConnector

de.undercouch.citeproc.zotero.ZoteroConnector

All Implemented Interfaces:

RemoteConnector

public class ZoteroConnector
extends AbstractRemoteConnector

Connects to the Zotero API v2. Needs an OAuth API key and secret in order to authenticate. Users of this class should register their app to receive such a key and secret.

Author:

Michel Kraemer

Field Summary

Fields inherited from class de.undercouch.citeproc.remote.AbstractRemoteConnector

accessToken, auth, requestToken

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected OAuth	createOAuth(String consumerKey, String consumerSecret, String redirectUri) Creates an OAuth object
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()
protected OAuth.Method	getOAuthAccessTokenMethod()
protected String	getOAuthAccessTokenURL()
protected String	getOAuthAuthorizationURL()
protected String	getOAuthRequestTokenURL()
protected Map<String,Object>	parseResponseObject(Response response) Parses the given response.

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

authorize, getAccessTokenSecret, getAccessTokenValue, getAuthorizationURL, parseResponseArray, performRequest, performRequestArray, performRequestObject, setAccessToken

Methods inherited from class java.lang.Object

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

Constructor Detail

ZoteroConnector

public ZoteroConnector(String consumerKey,
                       String consumerSecret)

Constructs a new connector

Parameters:

consumerKey - the app's consumer key

consumerSecret - the app's consumer secret

Method Detail

getOAuthRequestTokenURL

protected String getOAuthRequestTokenURL()

Specified by:

getOAuthRequestTokenURL in class AbstractRemoteConnector

Returns:

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

getOAuthAuthorizationURL

protected String getOAuthAuthorizationURL()

Specified by:

getOAuthAuthorizationURL in class AbstractRemoteConnector

Returns:

the remote service's authorization end-point

getOAuthAccessTokenURL

protected String getOAuthAccessTokenURL()

Specified by:

getOAuthAccessTokenURL in class AbstractRemoteConnector

Returns:

the remote service's end-point for access tokens

getOAuthAccessTokenMethod

protected OAuth.Method getOAuthAccessTokenMethod()

Specified by:

getOAuthAccessTokenMethod in class AbstractRemoteConnector

Returns:

the HTTP method to use while requesting access tokens

createOAuth

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

Description copied from class: AbstractRemoteConnector

Creates an OAuth object

Overrides:

createOAuth in class AbstractRemoteConnector

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

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.

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.

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

parseResponseObject

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

Description copied from class: AbstractRemoteConnector

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

Overrides:

parseResponseObject in class AbstractRemoteConnector

Parameters:

response - the HTTP response to parse

Returns:

the parsed result

Throws:

IOException - if the response could not be read

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.

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()

Returns:

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

See Also:

RemoteConnector.getItems(List)