Package org.dspace.orcid.service.impl

Class OrcidSynchronizationServiceImpl

java.lang.Object

org.dspace.orcid.service.impl.OrcidSynchronizationServiceImpl

All Implemented Interfaces:

OrcidSynchronizationService

public class OrcidSynchronizationServiceImpl
extends Object
implements OrcidSynchronizationService

Implementation of OrcidSynchronizationService.

Author:

Luca Giamminonni (luca.giamminonni at 4science.it)

Constructor Summary

Constructors

Constructor	Description
OrcidSynchronizationServiceImpl()

Method Summary

Modifier and Type	Method	Description
List<Item>	findProfilesByOrcid(Context context, String orcid)	Returns all the profiles with the given orcid id.
OrcidProfileDisconnectionMode	getDisconnectionMode()	Returns the configuration ORCID profile's disconnection mode.
Optional<OrcidEntitySyncPreference>	getEntityPreference(Item item, OrcidEntityType entityType)	Returns the ORCID synchronization preference related to the given entity type configured for the given profile item.
Optional<String>	getOrcid(Item item)
List<OrcidProfileSyncPreference>	getProfilePreferences(Item item)	Returns the ORCID synchronization preferences related to the profile itself configured for the given profile item.
Optional<OrcidSynchronizationMode>	getSynchronizationMode(Item item)	Returns the ORCID synchronization mode configured for the given profile item.
boolean	isLinkedToOrcid(Context context, Item item)	Check if the given item is linked to an ORCID profile.
boolean	isSynchronizationAllowed(Item profile, Item item)	Check if the given researcher profile item is configured to synchronize the given item with ORCID.
void	linkProfile(Context context, Item profile, OrcidTokenResponseDTO token)	Configure the given profile with the data present in the given ORCID token.
boolean	setEntityPreference(Context context, Item profile, OrcidEntityType type, OrcidEntitySyncPreference value)	Set the synchronization preference for the given profile related to the given ORCID entity type.
boolean	setProfilePreference(Context context, Item profile, List<OrcidProfileSyncPreference> values)	Update the profile's synchronization preference for the given profile.
boolean	setSynchronizationMode(Context context, Item profile, OrcidSynchronizationMode value)	Set the ORCID synchronization mode for the given profile.
void	unlinkProfile(Context context, Item profile)	Disconnect the given profile from ORCID.

Methods inherited from class java.lang.Object

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

Constructor Details

OrcidSynchronizationServiceImpl

public OrcidSynchronizationServiceImpl()

Method Details

linkProfile

public void linkProfile(Context context,
 Item profile,
 OrcidTokenResponseDTO token)
                 throws SQLException

Description copied from interface: OrcidSynchronizationService

Configure the given profile with the data present in the given ORCID token. This action is required to synchronize profile and related entities with ORCID. No security check is done, it is therefore the caller's responsibility to verify for example that the current user has permission to connect the profile to ORCID (if necessary).

Specified by:

linkProfile in interface OrcidSynchronizationService

Parameters:

context - the relevant DSpace Context.

profile - the profile to configure

token - the ORCID token

Throws:

SQLException - if a SQL error occurs during the profile update

unlinkProfile

public void unlinkProfile(Context context,
 Item profile)
                   throws SQLException

Description copied from interface: OrcidSynchronizationService

Disconnect the given profile from ORCID.

Specified by:

unlinkProfile in interface OrcidSynchronizationService

Parameters:

context - the relevant DSpace Context.

profile - the profile to disconnect

Throws:

SQLException - if a SQL error occurs during the profile update

setEntityPreference

public boolean setEntityPreference(Context context,
 Item profile,
 OrcidEntityType type,
 OrcidEntitySyncPreference value)
                            throws SQLException

Description copied from interface: OrcidSynchronizationService

Set the synchronization preference for the given profile related to the given ORCID entity type.

Specified by:

setEntityPreference in interface OrcidSynchronizationService

Parameters:

context - the relevant DSpace Context.

profile - the researcher profile to update

type - the orcid entity type

value - the new synchronization preference value

Returns:

true if the value has actually been updated, false if the value to be set is the same as the one already configured

Throws:

SQLException - if a SQL error occurs during the profile update

setProfilePreference

public boolean setProfilePreference(Context context,
 Item profile,
 List<OrcidProfileSyncPreference> values)
                             throws SQLException

Description copied from interface: OrcidSynchronizationService

Update the profile's synchronization preference for the given profile.

Specified by:

setProfilePreference in interface OrcidSynchronizationService

Parameters:

context - the relevant DSpace Context.

profile - the researcher profile to update

values - the new synchronization preference values

Returns:

true if the value has actually been updated, false if the value to be set is the same as the one already configured

Throws:

SQLException - if a SQL error occurs during the profile update

setSynchronizationMode

public boolean setSynchronizationMode(Context context,
 Item profile,
 OrcidSynchronizationMode value)
                               throws SQLException

Description copied from interface: OrcidSynchronizationService

Set the ORCID synchronization mode for the given profile.

Specified by:

setSynchronizationMode in interface OrcidSynchronizationService

Parameters:

context - the relevant DSpace Context.

profile - the researcher profile to update

value - the new synchronization mode value

Returns:

true if the value has actually been updated, false if the value to be set is the same as the one already configured

Throws:

SQLException - if a SQL error occurs during the profile update

isSynchronizationAllowed

public boolean isSynchronizationAllowed(Item profile,
 Item item)

Description copied from interface: OrcidSynchronizationService

Check if the given researcher profile item is configured to synchronize the given item with ORCID.

Specified by:

isSynchronizationAllowed in interface OrcidSynchronizationService

Parameters:

profile - the researcher profile item

item - the entity type to check

Returns:

true if the given entity type can be synchronize with ORCID, false otherwise

getSynchronizationMode

public Optional<OrcidSynchronizationMode> getSynchronizationMode(Item item)

Description copied from interface: OrcidSynchronizationService

Returns the ORCID synchronization mode configured for the given profile item.

Specified by:

getSynchronizationMode in interface OrcidSynchronizationService

Parameters:

item - the researcher profile item

Returns:

the synchronization mode

getEntityPreference

public Optional<OrcidEntitySyncPreference> getEntityPreference(Item item,
 OrcidEntityType entityType)

Description copied from interface: OrcidSynchronizationService

Returns the ORCID synchronization preference related to the given entity type configured for the given profile item.

Specified by:

getEntityPreference in interface OrcidSynchronizationService

Parameters:

item - the researcher profile item

entityType - the orcid entity type

Returns:

the configured preference

getProfilePreferences

public List<OrcidProfileSyncPreference> getProfilePreferences(Item item)

Description copied from interface: OrcidSynchronizationService

Returns the ORCID synchronization preferences related to the profile itself configured for the given profile item.

Specified by:

getProfilePreferences in interface OrcidSynchronizationService

Parameters:

item - the researcher profile item

Returns:

the synchronization mode

isLinkedToOrcid

public boolean isLinkedToOrcid(Context context,
 Item item)

Description copied from interface: OrcidSynchronizationService

Check if the given item is linked to an ORCID profile.

Specified by:

isLinkedToOrcid in interface OrcidSynchronizationService

Parameters:

context - the relevant DSpace Context.

item - the item to check

Returns:

true if the given item is linked to ORCID

getDisconnectionMode

public OrcidProfileDisconnectionMode getDisconnectionMode()

Description copied from interface: OrcidSynchronizationService

Returns the configuration ORCID profile's disconnection mode. If that mode is not configured or the configuration is wrong, the value DISABLED is returned.

Specified by:

getDisconnectionMode in interface OrcidSynchronizationService

Returns:

the disconnection mode

getOrcid

public Optional<String> getOrcid(Item item)

findProfilesByOrcid

public List<Item> findProfilesByOrcid(Context context,
 String orcid)

Description copied from interface: OrcidSynchronizationService

Returns all the profiles with the given orcid id.

Specified by:

findProfilesByOrcid in interface OrcidSynchronizationService

Parameters:

context - the relevant DSpace Context.

orcid - the orcid id to search for

Returns:

the found profile items