Crossref as a DOI provider (experimental) #10806
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| Added CrossRef DOI Pid Provider | ||
|
|
||
| See Installation Configuration document for JVM Settings to enable CrossRef as a Pid Provider |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,125 @@ | ||
| package edu.harvard.iq.dataverse.pidproviders.doi.crossref; | ||
|
|
||
| import edu.harvard.iq.dataverse.DvObject; | ||
| import edu.harvard.iq.dataverse.GlobalId; | ||
| import edu.harvard.iq.dataverse.pidproviders.doi.AbstractDOIProvider; | ||
|
|
||
| import java.util.HashMap; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.logging.Level; | ||
| import java.util.logging.Logger; | ||
|
|
||
| public class CrossRefDOIPidProvider extends AbstractDOIProvider { | ||
|
There was a problem hiding this comment. The other DOI providers drop the Pid part of the name (or use DOI instead of Pid since it is the type of Pid they support), so this would be more consistent as CrossRefDOIProvider. |
||
| private static final Logger logger = Logger.getLogger(CrossRefDOIPidProvider.class.getCanonicalName()); | ||
|
|
||
| public static final String TYPE = "crossref"; | ||
|
|
||
| CrossRefDOIRegisterService crossRefDOIRegisterService; | ||
|
|
||
| public CrossRefDOIPidProvider(String id, String label, String providerAuthority, String providerShoulder, String identifierGenerationStyle, String datafilePidFormat, String managedList, String excludedList, | ||
| String url, String apiUrl, String username, String password, String depositor, String depositorEmail) { | ||
| super(id, label, providerAuthority, providerShoulder, identifierGenerationStyle, datafilePidFormat, | ||
| managedList, excludedList); | ||
|
|
||
| crossRefDOIRegisterService = new CrossRefDOIRegisterService(url, apiUrl, username, password, depositor, depositorEmail); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean alreadyRegistered(GlobalId pid, boolean noProviderDefault) throws Exception { | ||
| logger.info("CrossRef alreadyRegistered"); | ||
| if (pid == null || pid.asString().isEmpty()) { | ||
| logger.fine("No identifier sent."); | ||
| return false; | ||
| } | ||
| boolean alreadyExists; | ||
| String identifier = pid.asString(); | ||
| try { | ||
| alreadyExists = crossRefDOIRegisterService.testDOIExists(identifier); | ||
| } catch (Exception e) { | ||
| logger.log(Level.WARNING, "alreadyExists failed"); | ||
| return false; | ||
| } | ||
| return alreadyExists; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean registerWhenPublished() { | ||
| return true; | ||
| } | ||
|
|
||
| @Override | ||
| public List<String> getProviderInformation() { | ||
| return List.of("CrossRef", "https://status.crossref.org/"); | ||
| } | ||
|
|
||
| @Override | ||
| public String createIdentifier(DvObject dvObject) throws Throwable { | ||
| logger.info("CrossRef createIdentifier"); | ||
| if (dvObject.getIdentifier() == null || dvObject.getIdentifier().isEmpty()) { | ||
| dvObject = generatePid(dvObject); | ||
| } | ||
| String identifier = getIdentifier(dvObject); | ||
| try { | ||
| String retString = crossRefDOIRegisterService.reserveIdentifier(identifier, dvObject); | ||
| logger.log(Level.FINE, "CrossRef create DOI identifier retString : " + retString); | ||
| return retString; | ||
| } catch (Exception e) { | ||
| logger.log(Level.WARNING, "CrossRef Identifier not created: create failed", e); | ||
| throw e; | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public Map<String, String> getIdentifierMetadata(DvObject dvObject) { | ||
| logger.info("CrossRef getIdentifierMetadata"); | ||
| String identifier = getIdentifier(dvObject); | ||
| Map<String, String> metadata = new HashMap<>(); | ||
| try { | ||
| metadata = crossRefDOIRegisterService.getMetadata(identifier); | ||
| } catch (Exception e) { | ||
| logger.log(Level.WARNING, "getIdentifierMetadata failed", e); | ||
| } | ||
| return metadata; | ||
| } | ||
|
|
||
| @Override | ||
| public String modifyIdentifierTargetURL(DvObject dvObject) throws Exception { | ||
| logger.info("CrossRef modifyIdentifier"); | ||
| String identifier = getIdentifier(dvObject); | ||
| try { | ||
| crossRefDOIRegisterService.modifyIdentifier(identifier, dvObject); | ||
| } catch (Exception e) { | ||
| logger.log(Level.WARNING, "modifyMetadata failed", e); | ||
| throw e; | ||
| } | ||
| return identifier; | ||
| } | ||
|
|
||
| @Override | ||
| public void deleteIdentifier(DvObject dvo) throws Exception { | ||
| logger.info("CrossRef deleteIdentifier"); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean publicizeIdentifier(DvObject dvObject) { | ||
| logger.info("CrossRef updateIdentifierStatus"); | ||
| if (dvObject.getIdentifier() == null || dvObject.getIdentifier().isEmpty()) { | ||
| dvObject = generatePid(dvObject); | ||
| } | ||
| String identifier = getIdentifier(dvObject); | ||
|
|
||
| try { | ||
| crossRefDOIRegisterService.reserveIdentifier(identifier, dvObject); | ||
| return true; | ||
| } catch (Exception e) { | ||
| logger.log(Level.WARNING, "modifyMetadata failed: " + e.getMessage(), e); | ||
| return false; | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public String getProviderType() { | ||
| return TYPE; | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| package edu.harvard.iq.dataverse.pidproviders.doi.crossref; | ||
|
|
||
| import com.google.auto.service.AutoService; | ||
| import edu.harvard.iq.dataverse.pidproviders.PidProvider; | ||
| import edu.harvard.iq.dataverse.pidproviders.PidProviderFactory; | ||
| import edu.harvard.iq.dataverse.settings.JvmSettings; | ||
| import edu.harvard.iq.dataverse.util.SystemConfig; | ||
|
|
||
| @AutoService(PidProviderFactory.class) | ||
| public class CrossRefDOIProviderFactory implements PidProviderFactory { | ||
|
|
||
| @Override | ||
| public PidProvider createPidProvider(String providerId) { | ||
| String providerType = JvmSettings.PID_PROVIDER_TYPE.lookup(providerId); | ||
| if (!providerType.equals(CrossRefDOIPidProvider.TYPE)) { | ||
| // Being asked to create a non-CrossRef provider | ||
| return null; | ||
| } | ||
| String providerLabel = JvmSettings.PID_PROVIDER_LABEL.lookup(providerId); | ||
| String providerAuthority = JvmSettings.PID_PROVIDER_AUTHORITY.lookup(providerId); | ||
| String providerShoulder = JvmSettings.PID_PROVIDER_SHOULDER.lookupOptional(providerId).orElse(""); | ||
| String identifierGenerationStyle = JvmSettings.PID_PROVIDER_IDENTIFIER_GENERATION_STYLE | ||
| .lookupOptional(providerId).orElse("randomString"); | ||
| String datafilePidFormat = JvmSettings.PID_PROVIDER_DATAFILE_PID_FORMAT.lookupOptional(providerId) | ||
| .orElse(SystemConfig.DataFilePIDFormat.DEPENDENT.toString()); | ||
| String managedList = JvmSettings.PID_PROVIDER_MANAGED_LIST.lookupOptional(providerId).orElse(""); | ||
| String excludedList = JvmSettings.PID_PROVIDER_EXCLUDED_LIST.lookupOptional(providerId).orElse(""); | ||
|
|
||
| String baseUrl = JvmSettings.CROSSREF_URL.lookup(providerId); | ||
| String apiUrl = JvmSettings.CROSSREF_REST_API_URL.lookup(providerId); | ||
| String username = JvmSettings.CROSSREF_USERNAME.lookup(providerId); | ||
| String password = JvmSettings.CROSSREF_PASSWORD.lookup(providerId); | ||
| String depositor = JvmSettings.CROSSREF_DEPOSITOR.lookup(providerId); | ||
| String depositorEmail = JvmSettings.CROSSREF_DEPOSITOR_EMAIL.lookup(providerId); | ||
|
|
||
| return new CrossRefDOIPidProvider(providerId, providerLabel, providerAuthority, providerShoulder, identifierGenerationStyle, | ||
| datafilePidFormat, managedList, excludedList, baseUrl, apiUrl, username, password, depositor, depositorEmail); | ||
| } | ||
|
|
||
| public String getType() { | ||
| return CrossRefDOIPidProvider.TYPE; | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The documentation, and some of the code, is for 'legacy' single pid configuration but I think we could/should only support handling the new multipid way of doing config. Although I think you've added it, I think it's reasonable to not support the legacy style at all for cross ref (since the idea of legacy was to support people who had already deployed with the old single provider jvm options and no one could have used CrossRef before now (except the developer's group).
To change the docs - see the DataCite section in the guide and add the info there (probably right after DataCite/before Handle.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
will modify the doc