Package org.dspace.identifier.doi

Class DataCiteConnector

java.lang.Object

org.dspace.identifier.doi.DataCiteConnector

All Implemented Interfaces:

DOIConnector

public class DataCiteConnector
extends Object
implements DOIConnector

Author:

Pascal-Nicolas Becker

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	DataCiteConnector.DataCiteResponse

Field Summary

Fields

Modifier and Type	Field	Description
protected ConfigurationService	configurationService
protected String	CROSSWALK_NAME	Name of crosswalk to convert metadata into DataCite Metadata Scheme.
protected String	DOI_PATH	Path on the DataCite server used to generate DOIs.
protected HandleService	handleService
protected String	HOST	Stores the hostname of the DataCite server.
protected String	METADATA_PATH	Path on the DataCite server used to register metadata.
protected String	PASSWORD
protected String	SCHEME	Stores the scheme used to connect to the DataCite server.
protected String	USERNAME
protected ParameterizedDisseminationCrosswalk	xwalk	DisseminationCrosswalk to map local metadata into DataCite metadata.

Constructor Summary

Constructors

Constructor	Description
DataCiteConnector()

Method Summary

Modifier and Type	Method	Description
protected org.jdom2.Element	addDOI(String doi, org.jdom2.Element root)
void	deleteDOI(Context context, String doi)	Sends the DELETE-Request to the DOI registry.
protected String	extractAlternateIdentifier(Context context, String content)
protected String	extractDOI(org.jdom2.Element root)
protected String	getPassword()
protected String	getUsername()
boolean	isDOIRegistered(Context context, String doi)
boolean	isDOIReserved(Context context, String doi)
protected void	prepareXwalk()
void	registerDOI(Context context, DSpaceObject dso, String doi)	Sends a request to the DOI registry to register a DOI.
void	reserveDOI(Context context, DSpaceObject dso, String doi)	Sends a request to the DOI registry to reserve a DOI.
protected DataCiteConnector.DataCiteResponse	sendDOIGetRequest(String doi)
protected DataCiteConnector.DataCiteResponse	sendDOIPostRequest(String doi, String url)
protected DataCiteConnector.DataCiteResponse	sendGetRequest(String doi, String path)
protected DataCiteConnector.DataCiteResponse	sendHttpRequest(org.apache.http.client.methods.HttpUriRequest req, String doi)	Internal method to send requests prepared by the caller to DataCite.
protected DataCiteConnector.DataCiteResponse	sendMetadataDeleteRequest(String doi)
protected DataCiteConnector.DataCiteResponse	sendMetadataGetRequest(String doi)
protected DataCiteConnector.DataCiteResponse	sendMetadataPostRequest(String doi, String metadata)	Send a DataCite metadata document to the registrar.
protected DataCiteConnector.DataCiteResponse	sendMetadataPostRequest(String doi, org.jdom2.Element metadataRoot)	Send a DataCite metadata document to the registrar.
void	setConfigurationService(ConfigurationService configurationService)
void	setDATACITE_DOI_PATH(String DATACITE_DOI_PATH)	Set the path on the DataCite server to register DOIs.
void	setDATACITE_HOST(String DATACITE_HOST)	Set the hostname of the DataCite server.
void	setDATACITE_METADATA_PATH(String DATACITE_METADATA_PATH)	Set the path to register metadata on DataCite server.
void	setDATACITE_SCHEME(String DATACITE_SCHEME)	Used to set the scheme to connect the DataCite server.
void	setDisseminationCrosswalkName(String CROSSWALK_NAME)	Set the name of the dissemination crosswalk used to convert the metadata into DataCite Metadata Schema.
void	updateMetadata(Context context, DSpaceObject dso, String doi)	Sends a request to the DOI registry to update metadata for a DOI.

Methods inherited from class java.lang.Object

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

Field Detail

SCHEME

protected String SCHEME

Stores the scheme used to connect to the DataCite server. It will be set by spring dependency injection.

HOST

protected String HOST

Stores the hostname of the DataCite server. Set by spring dependency injection.

DOI_PATH

protected String DOI_PATH

Path on the DataCite server used to generate DOIs. Set by spring dependency injection.

METADATA_PATH

protected String METADATA_PATH

Path on the DataCite server used to register metadata. Set by spring dependency injection.

CROSSWALK_NAME

protected String CROSSWALK_NAME

Name of crosswalk to convert metadata into DataCite Metadata Scheme. Set by spring dependency injection.

xwalk

protected ParameterizedDisseminationCrosswalk xwalk

DisseminationCrosswalk to map local metadata into DataCite metadata. The name of the crosswalk is set by spring dependency injection using setDisseminationCrosswalkName which instantiates the crosswalk.

configurationService

protected ConfigurationService configurationService

USERNAME

protected String USERNAME

PASSWORD

protected String PASSWORD

handleService

@Autowired
protected HandleService handleService

Constructor Detail

DataCiteConnector

public DataCiteConnector()

Method Detail

setDATACITE_SCHEME

@Autowired(required=true)
public void setDATACITE_SCHEME(String DATACITE_SCHEME)

Used to set the scheme to connect the DataCite server. Used by spring dependency injection.

Parameters:

DATACITE_SCHEME - Probably https or http.

setDATACITE_HOST

@Autowired(required=true)
public void setDATACITE_HOST(String DATACITE_HOST)

Set the hostname of the DataCite server. Used by spring dependency injection.

Parameters:

DATACITE_HOST - Hostname to connect to register DOIs (f.e. test.datacite.org).

setDATACITE_DOI_PATH

@Autowired(required=true)
public void setDATACITE_DOI_PATH(String DATACITE_DOI_PATH)

Set the path on the DataCite server to register DOIs. Used by spring dependency injection.

Parameters:

DATACITE_DOI_PATH - Path to register DOIs, f.e. /doi.

setDATACITE_METADATA_PATH

@Autowired(required=true)
public void setDATACITE_METADATA_PATH(String DATACITE_METADATA_PATH)

Set the path to register metadata on DataCite server. Used by spring dependency injection.

Parameters:

DATACITE_METADATA_PATH - Path to register metadata, f.e. /mds.

setConfigurationService

@Autowired(required=true)
public void setConfigurationService(ConfigurationService configurationService)

setDisseminationCrosswalkName

@Autowired(required=true)
public void setDisseminationCrosswalkName(String CROSSWALK_NAME)

Set the name of the dissemination crosswalk used to convert the metadata into DataCite Metadata Schema. Used by spring dependency injection.

Parameters:

CROSSWALK_NAME - The name of the dissemination crosswalk to use. This crosswalk must be configured in dspace.cfg.

prepareXwalk

protected void prepareXwalk()

getUsername

protected String getUsername()

getPassword

protected String getPassword()

isDOIReserved

public boolean isDOIReserved(Context context,
                             String doi)
                      throws DOIIdentifierException

Specified by:

isDOIReserved in interface DOIConnector

Throws:

DOIIdentifierException

isDOIRegistered

public boolean isDOIRegistered(Context context,
                               String doi)
                        throws DOIIdentifierException

Specified by:

isDOIRegistered in interface DOIConnector

Throws:

DOIIdentifierException

deleteDOI

public void deleteDOI(Context context,
                      String doi)
               throws DOIIdentifierException

Description copied from interface: DOIConnector

Sends the DELETE-Request to the DOI registry.

This method sends a request to "delete" a DOI. As DOIs are persistent identifiers they should never be deleted. For example, if you send a HTTP DELETE request to the DataCite Metadata API directly, it will set the DOI to inactive.

Specified by:

deleteDOI in interface DOIConnector

Parameters:

context - The relevant DSpace Context.

doi - DOI string to "delete"

Throws:

DOIIdentifierException - if DOI error

reserveDOI

public void reserveDOI(Context context,
                       DSpaceObject dso,
                       String doi)
                throws DOIIdentifierException

Description copied from interface: DOIConnector

Sends a request to the DOI registry to reserve a DOI. The DOIConnector should check weather this DOI is reserved for another object already. In this case it should throw an DOIIdentifierException. DOIIdentifierException} and set the error code to DOIIdentifierException.DOI_ALREADY_EXISTS.

Specified by:

reserveDOI in interface DOIConnector

Parameters:

context - The relevant DSpace Context.

dso - DSpace object to associate to the DOI

doi - DOI string to reserve

Throws:

DOIIdentifierException - if DOI error

registerDOI

public void registerDOI(Context context,
                        DSpaceObject dso,
                        String doi)
                 throws DOIIdentifierException

Description copied from interface: DOIConnector

Sends a request to the DOI registry to register a DOI. The DOIConnector ensures compliance with the workflow of the registration agency. For example, if a DOI has to be reserved before it can be registered the DOIConnector has to check if it is reserved. In this case you can throw an DOIIdentifierException. and set the error code to DOIIdentifierException.RESERVE_FIRST.

Specified by:

registerDOI in interface DOIConnector

Parameters:

context - The relevant DSpace Context.

dso - DSpace object to associate to the DOI

doi - DOI string to register

Throws:

DOIIdentifierException - if DOI error

updateMetadata

public void updateMetadata(Context context,
                           DSpaceObject dso,
                           String doi)
                    throws DOIIdentifierException

Description copied from interface: DOIConnector

Sends a request to the DOI registry to update metadata for a DOI. The DOIConnector should check weather the DOI is reserved or registered for the specified DSpace Object before it sends the metadata update.

Specified by:

updateMetadata in interface DOIConnector

Parameters:

context - The relevant DSpace Context.

dso - DSpace object associated to the DOI

doi - DOI string to update (metadata)

Throws:

DOIIdentifierException - if DOI error

sendDOIPostRequest

protected DataCiteConnector.DataCiteResponse sendDOIPostRequest(String doi,
                                                                String url)
                                                         throws DOIIdentifierException

Throws:

DOIIdentifierException

sendMetadataDeleteRequest

protected DataCiteConnector.DataCiteResponse sendMetadataDeleteRequest(String doi)
                                                                throws DOIIdentifierException

Throws:

DOIIdentifierException

sendDOIGetRequest

protected DataCiteConnector.DataCiteResponse sendDOIGetRequest(String doi)
                                                        throws DOIIdentifierException

Throws:

DOIIdentifierException

sendMetadataGetRequest

protected DataCiteConnector.DataCiteResponse sendMetadataGetRequest(String doi)
                                                             throws DOIIdentifierException

Throws:

DOIIdentifierException

sendGetRequest

protected DataCiteConnector.DataCiteResponse sendGetRequest(String doi,
                                                            String path)
                                                     throws DOIIdentifierException

Throws:

DOIIdentifierException

sendMetadataPostRequest

protected DataCiteConnector.DataCiteResponse sendMetadataPostRequest(String doi,
                                                                     org.jdom2.Element metadataRoot)
                                                              throws DOIIdentifierException

Send a DataCite metadata document to the registrar.

Parameters:

doi - identify the object.

metadataRoot - describe the object. The root element of the document.

Returns:

the registrar's response.

Throws:

DOIIdentifierException - passed through.

sendMetadataPostRequest

protected DataCiteConnector.DataCiteResponse sendMetadataPostRequest(String doi,
                                                                     String metadata)
                                                              throws DOIIdentifierException

Send a DataCite metadata document to the registrar.

Parameters:

doi - identify the object.

metadata - describe the object.

Returns:

the registrar's response.

Throws:

DOIIdentifierException - passed through.

sendHttpRequest

protected DataCiteConnector.DataCiteResponse sendHttpRequest(org.apache.http.client.methods.HttpUriRequest req,
                                                             String doi)
                                                      throws DOIIdentifierException

Internal method to send requests prepared by the caller to DataCite.

Parameters:

req - Extended version of the HttpRequest interface that provides convenience methods to access request properties such as request URI and method type.

doi - DOI string to operate on

Returns:

response from DataCite

Throws:

DOIIdentifierException - if registrar returns an error.

extractAlternateIdentifier

protected String extractAlternateIdentifier(Context context,
                                            String content)
                                     throws SQLException,
                                            DOIIdentifierException

Throws:

SQLException

DOIIdentifierException

extractDOI

protected String extractDOI(org.jdom2.Element root)

addDOI

protected org.jdom2.Element addDOI(String doi,
                                   org.jdom2.Element root)