pt.ptcris

Class ORCIDClientImpl

java.lang.Object

pt.ptcris.ORCIDClientImpl

All Implemented Interfaces:

ORCIDClient

public class ORCIDClientImpl
extends java.lang.Object
implements ORCIDClient

An implementation of the ORCID client interface built over the Degois client. Besides the tokens to use the ORCID Member API, it also store the tokens to access a particular ORCID user profile.

See Also:

ORCIDClient

Constructor Summary

Constructors

Constructor and Description
ORCIDClientImpl(java.lang.String loginUri, java.lang.String apiUri, java.lang.String clientId, java.lang.String clientSecret, java.lang.String redirectUri, org.um.dsi.gavea.orcid.client.OrcidAccessToken orcidToken) Instantiates an ORCID client to communicate with the ORCID API.
ORCIDClientImpl(java.lang.String loginUri, java.lang.String apiUri, java.lang.String clientId, java.lang.String clientSecret, java.lang.String redirectUri, org.um.dsi.gavea.orcid.client.OrcidAccessToken orcidToken, int threads) Instantiates an ORCID client to communicate with the ORCID API.

Method Summary

Modifier and Type	Method and Description
java.math.BigInteger	addWork(org.um.dsi.gavea.orcid.model.work.Work work) Adds a new work to the ORCID profile.
void	deleteWork(java.math.BigInteger putcode) Deletes a work from the ORCID profile.
org.um.dsi.gavea.orcid.model.activities.ActivitiesSummary	getActivitiesSummary() Retrieves every activity summary from the ORCID profile.
java.lang.String	getClientId() Returns the Member API client id that will commit the changes (i.e., the works' source).
org.um.dsi.gavea.orcid.model.work.Work	getWork(java.math.BigInteger putcode) Retrieves a complete work from the ORCID profile (as opposed to only its summary).
int	threads() The number of worker threads that will be used to communicate with the ORCID API.
void	updateWork(java.math.BigInteger putcode, org.um.dsi.gavea.orcid.model.work.Work work) Updates a work in the ORCID profile.

Methods inherited from class java.lang.Object

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

Constructor Detail

ORCIDClientImpl

public ORCIDClientImpl(java.lang.String loginUri,
                       java.lang.String apiUri,
                       java.lang.String clientId,
                       java.lang.String clientSecret,
                       java.lang.String redirectUri,
                       org.um.dsi.gavea.orcid.client.OrcidAccessToken orcidToken,
                       int threads)

Instantiates an ORCID client to communicate with the ORCID API.

Parameters:

loginUri - the login URI of the ORCID service

apiUri - the URI of the ORCID API

clientId - the id of the ORCID Member API client

clientSecret - the secret of the ORCID Member API client

redirectUri - the redirect URI for requesting the access token

orcidToken - the access token to the user ORCID profile

threads - the number of ORCID worker threads

ORCIDClientImpl

public ORCIDClientImpl(java.lang.String loginUri,
                       java.lang.String apiUri,
                       java.lang.String clientId,
                       java.lang.String clientSecret,
                       java.lang.String redirectUri,
                       org.um.dsi.gavea.orcid.client.OrcidAccessToken orcidToken)

Instantiates an ORCID client to communicate with the ORCID API.

Parameters:

loginUri - the login URI of the ORCID service

apiUri - the URI of the ORCID API

clientId - the id of the ORCID Member API client

clientSecret - the secret of the ORCID Member API client

redirectUri - the redirect URI for requesting the access token

orcidToken - the access token to the user ORCID profile

Method Detail

getClientId

public java.lang.String getClientId()

Returns the Member API client id that will commit the changes (i.e., the works' source).

Specified by:

getClientId in interface ORCIDClient

Returns:

the client id

getWork

public org.um.dsi.gavea.orcid.model.work.Work getWork(java.math.BigInteger putcode)
                                               throws org.um.dsi.gavea.orcid.client.exception.OrcidClientException

Retrieves a complete work from the ORCID profile (as opposed to only its summary).

Specified by:

getWork in interface ORCIDClient

Parameters:

putcode - the put-code of the work

Returns:

the complete work

Throws:

org.um.dsi.gavea.orcid.client.exception.OrcidClientException - if the communication with ORCID fails

addWork

public java.math.BigInteger addWork(org.um.dsi.gavea.orcid.model.work.Work work)
                             throws org.um.dsi.gavea.orcid.client.exception.OrcidClientException

Adds a new work to the ORCID profile.

Specified by:

addWork in interface ORCIDClient

Parameters:

work - the work to be added to the ORCID profile

Returns:

the put-code assigned by ORCID to the newly created work

Throws:

org.um.dsi.gavea.orcid.client.exception.OrcidClientException - if the communication with ORCID fails

deleteWork

public void deleteWork(java.math.BigInteger putcode)
                throws org.um.dsi.gavea.orcid.client.exception.OrcidClientException

Deletes a work from the ORCID profile.

Specified by:

deleteWork in interface ORCIDClient

Parameters:

putcode - the put-code of the work to be deleted

Throws:

org.um.dsi.gavea.orcid.client.exception.OrcidClientException - if the communication with ORCID fails

updateWork

public void updateWork(java.math.BigInteger putcode,
                       org.um.dsi.gavea.orcid.model.work.Work work)
                throws org.um.dsi.gavea.orcid.client.exception.OrcidClientException

Updates a work in the ORCID profile.

Specified by:

updateWork in interface ORCIDClient

Parameters:

putcode - the put-code of the work to be updated

work - the new state of the work

Throws:

org.um.dsi.gavea.orcid.client.exception.OrcidClientException - if the communication with ORCID fails

getActivitiesSummary

public org.um.dsi.gavea.orcid.model.activities.ActivitiesSummary getActivitiesSummary()
                                                                               throws org.um.dsi.gavea.orcid.client.exception.OrcidClientException

Retrieves every activity summary from the ORCID profile.

Specified by:

getActivitiesSummary in interface ORCIDClient

Returns:

the activities summary of the ORCID profile

Throws:

org.um.dsi.gavea.orcid.client.exception.OrcidClientException - if the communication with ORCID fails

threads

public int threads()

The number of worker threads that will be used to communicate with the ORCID API.

Specified by:

threads in interface ORCIDClient

Returns:

the number of ORCID worker threads