Package 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	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, boolean debugMode)	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, boolean debugMode, int threads)	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	Description
PTCRISyncResult<org.um.dsi.gavea.orcid.model.funding.Funding>	addFunding(org.um.dsi.gavea.orcid.model.funding.Funding fund)	Adds a new funding entry to the ORCID profile and returns the assigned put-code.
PTCRISyncResult<org.um.dsi.gavea.orcid.model.work.Work>	addWork(org.um.dsi.gavea.orcid.model.work.Work work)	Adds a new work to the ORCID profile and returns the assigned put-code.
java.util.List<PTCRISyncResult<org.um.dsi.gavea.orcid.model.work.Work>>	addWorks(java.util.List<org.um.dsi.gavea.orcid.model.work.Work> works)	Adds a list of new works to the ORCID profile.
PTCRISyncResult<org.um.dsi.gavea.orcid.model.funding.Funding>	deleteFunding(java.math.BigInteger putcode)	Deletes a funding entry from the ORCID profile.
PTCRISyncResult<org.um.dsi.gavea.orcid.model.work.Work>	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).
PTCRISyncResult<org.um.dsi.gavea.orcid.model.funding.Funding>	getFunding(org.um.dsi.gavea.orcid.model.funding.FundingSummary putcode)	Retrieves a complete funding entry from the ORCID profile (as opposed to only its summary).
org.um.dsi.gavea.orcid.model.activities.Fundings	getFundingsSummary()	Retrieves every funding summary from the ORCID profile.
java.lang.String	getUserId()	Returns the user ORCID to whose profiles the changes will be commited.
PTCRISyncResult<org.um.dsi.gavea.orcid.model.work.Work>	getWork(org.um.dsi.gavea.orcid.model.work.WorkSummary putcode)	Retrieves a complete work from the ORCID profile (as opposed to only its summary).
java.util.Map<java.math.BigInteger,PTCRISyncResult<org.um.dsi.gavea.orcid.model.work.Work>>	getWorks(java.util.List<org.um.dsi.gavea.orcid.model.work.WorkSummary> summaries)	Retrieves a list of complete work from the ORCID profile (as opposed to only their summaries).
org.um.dsi.gavea.orcid.model.activities.Works	getWorksSummary()	Retrieves every work summary from the ORCID profile.
int	threads()	The number of worker threads that will be used to communicate with the ORCID API.
PTCRISyncResult<org.um.dsi.gavea.orcid.model.funding.Funding>	updateFunding(java.math.BigInteger putcode, org.um.dsi.gavea.orcid.model.funding.Funding work)	Updates a funding entry in the ORCID profile.
PTCRISyncResult<org.um.dsi.gavea.orcid.model.work.Work>	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

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,
                       boolean debugMode)

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

debugMode - Enter debug mode

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,
                       boolean debugMode,
                       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

debugMode - Enter debug mode

threads - the number of ORCID worker threads

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

getUserId

public java.lang.String getUserId()

Returns the user ORCID to whose profiles the changes will be commited.

Specified by:

getUserId in interface ORCIDClient

Returns:

the user ORCID

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

getWorksSummary

public org.um.dsi.gavea.orcid.model.activities.Works getWorksSummary()
                                                              throws org.um.dsi.gavea.orcid.client.exception.OrcidClientException

Retrieves every work summary from the ORCID profile.

Specified by:

getWorksSummary in interface ORCIDClient

Returns:

the work summaries of the ORCID profile

Throws:

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

getFundingsSummary

public org.um.dsi.gavea.orcid.model.activities.Fundings getFundingsSummary()
                                                                    throws org.um.dsi.gavea.orcid.client.exception.OrcidClientException

Retrieves every funding summary from the ORCID profile.

Specified by:

getFundingsSummary in interface ORCIDClient

Returns:

the funding summaries of the ORCID profile

Throws:

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

getWork

public PTCRISyncResult<org.um.dsi.gavea.orcid.model.work.Work> getWork(org.um.dsi.gavea.orcid.model.work.WorkSummary putcode)

Retrieves a complete work from the ORCID profile (as opposed to only its summary). Exceptions are embedded in the PTCRISyncResult.

Specified by:

getWork in interface ORCIDClient

Parameters:

putcode - the summary of the work to be retrieved

Returns:

the complete work

getFunding

public PTCRISyncResult<org.um.dsi.gavea.orcid.model.funding.Funding> getFunding(org.um.dsi.gavea.orcid.model.funding.FundingSummary putcode)

Retrieves a complete funding entry from the ORCID profile (as opposed to only its summary). Exceptions are embedded in the PTCRISyncResult.

Specified by:

getFunding in interface ORCIDClient

Parameters:

putcode - the summary of the funding entry to be retrieved

Returns:

the complete funding entry

getWorks

public java.util.Map<java.math.BigInteger,PTCRISyncResult<org.um.dsi.gavea.orcid.model.work.Work>> getWorks(java.util.List<org.um.dsi.gavea.orcid.model.work.WorkSummary> summaries)

Retrieves a list of complete work from the ORCID profile (as opposed to only their summaries). Exceptions are embedded in the PTCRISyncResult. This should generate a single API call internally.

Specified by:

getWorks in interface ORCIDClient

Parameters:

summaries - the summaries of the works to be retrieved

Returns:

the complete works

addWork

public PTCRISyncResult<org.um.dsi.gavea.orcid.model.work.Work> addWork(org.um.dsi.gavea.orcid.model.work.Work work)

Adds a new work to the ORCID profile and returns the assigned put-code. Exceptions are embedded in the PTCRISyncResult.

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

addFunding

public PTCRISyncResult<org.um.dsi.gavea.orcid.model.funding.Funding> addFunding(org.um.dsi.gavea.orcid.model.funding.Funding fund)

Adds a new funding entry to the ORCID profile and returns the assigned put-code. Exceptions are embedded in the PTCRISyncResult.

Specified by:

addFunding in interface ORCIDClient

Parameters:

fund - the funding entry to be added to the ORCID profile

Returns:

the put-code assigned by ORCID to the newly created funding entry

addWorks

public java.util.List<PTCRISyncResult<org.um.dsi.gavea.orcid.model.work.Work>> addWorks(java.util.List<org.um.dsi.gavea.orcid.model.work.Work> works)

Adds a list of new works to the ORCID profile. Exceptions are embedded in the PTCRISyncResult. This should generate a single API call internally.

Specified by:

addWorks in interface ORCIDClient

Parameters:

works - the works to be added to the ORCID profile

Returns:

the put-codes assigned by ORCID to each of the newly created works

deleteWork

public PTCRISyncResult<org.um.dsi.gavea.orcid.model.work.Work> deleteWork(java.math.BigInteger putcode)

Deletes a work from the ORCID profile. Exceptions are embedded in the PTCRISyncResult.

Specified by:

deleteWork in interface ORCIDClient

Parameters:

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

Returns:

the outcome of the delete request

deleteFunding

public PTCRISyncResult<org.um.dsi.gavea.orcid.model.funding.Funding> deleteFunding(java.math.BigInteger putcode)

Deletes a funding entry from the ORCID profile. Exceptions are embedded in the PTCRISyncResult.

Specified by:

deleteFunding in interface ORCIDClient

Parameters:

putcode - the put-code of the funding entry to be deleted

Returns:

the outcome of the delete request

updateWork

public PTCRISyncResult<org.um.dsi.gavea.orcid.model.work.Work> updateWork(java.math.BigInteger putcode,
                                                                          org.um.dsi.gavea.orcid.model.work.Work work)

Updates a work in the ORCID profile. Exceptions are embedded in the PTCRISyncResult.

Specified by:

updateWork in interface ORCIDClient

Parameters:

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

work - the new state of the work

Returns:

the outcome of the update request

updateFunding

public PTCRISyncResult<org.um.dsi.gavea.orcid.model.funding.Funding> updateFunding(java.math.BigInteger putcode,
                                                                                   org.um.dsi.gavea.orcid.model.funding.Funding work)

Updates a funding entry in the ORCID profile. Exceptions are embedded in the PTCRISyncResult.

Specified by:

updateFunding in interface ORCIDClient

Parameters:

putcode - the put-code of the funding entry to be updated

work - the new state of the funding entry

Returns:

the outcome of the update request

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