org.dspace.identifier.doi

Class DataCiteConnector

java.lang.Object

org.dspace.identifier.doi.DataCiteConnector

All Implemented Interfaces:

DOIConnector

public class DataCiteConnector
extends java.lang.Object
implements DOIConnector

Author:

Pascal-Nicolas Becker

Field Summary

Fields

Modifier and Type	Field and Description
protected ConfigurationService	configurationService
protected java.lang.String	CROSSWALK_NAME Name of crosswalk to convert metadata into DataCite Metadata Scheme.
protected java.lang.String	DOI_PATH Path on the DataCite server used to generate DOIs.
protected java.lang.String	METADATA_PATH Path on the DataCite server used to register metadata.
protected java.lang.String	PASSWORD
protected java.lang.String	USERNAME
protected DisseminationCrosswalk	xwalk DisseminationCrosswalk to map local metadata into DataCite metadata.

Constructor Summary

Constructors

Constructor and Description
DataCiteConnector()

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteDOI(Context context, java.lang.String doi) Sends the DELETE-Request to the DOI registry.
boolean	isDOIRegistered(Context context, DSpaceObject dso, java.lang.String doi)
boolean	isDOIRegistered(Context context, java.lang.String doi)
boolean	isDOIReserved(Context context, DSpaceObject dso, java.lang.String doi)
boolean	isDOIReserved(Context context, java.lang.String doi)
void	registerDOI(Context context, DSpaceObject dso, java.lang.String doi) Sends a request to the DOI registry to register a DOI.
void	reserveDOI(Context context, DSpaceObject dso, java.lang.String doi) Sends a request to the DOI registry to reserve a DOI.
void	setConfigurationService(ConfigurationService configurationService)
void	setDATACITE_DOI_PATH(java.lang.String DATACITE_DOI_PATH) Set the path on the DataCite server to register DOIs.
void	setDATACITE_HOST(java.lang.String DATACITE_HOST) Set the hostname of the DataCite server.
void	setDATACITE_METADATA_PATH(java.lang.String DATACITE_METADATA_PATH) Set the path to register metadata on DataCite server.
void	setDATACITE_SCHEME(java.lang.String DATACITE_SCHEME) Used to set the scheme to connect the DataCite server.
void	setDisseminationCrosswalkName(java.lang.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, java.lang.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

DOI_PATH

protected java.lang.String DOI_PATH

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

METADATA_PATH

protected java.lang.String METADATA_PATH

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

CROSSWALK_NAME

protected java.lang.String CROSSWALK_NAME

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

xwalk

protected DisseminationCrosswalk xwalk

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

configurationService

protected ConfigurationService configurationService

USERNAME

protected java.lang.String USERNAME

PASSWORD

protected java.lang.String PASSWORD

Constructor Detail

DataCiteConnector

public DataCiteConnector()

Method Detail

setDATACITE_SCHEME

public void setDATACITE_SCHEME(java.lang.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

public void setDATACITE_HOST(java.lang.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

public void setDATACITE_DOI_PATH(java.lang.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

public void setDATACITE_METADATA_PATH(java.lang.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
public void setConfigurationService(ConfigurationService configurationService)

setDisseminationCrosswalkName

public void setDisseminationCrosswalkName(java.lang.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.

isDOIReserved

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

Specified by:

isDOIReserved in interface DOIConnector

Throws:

DOIIdentifierException

isDOIReserved

public boolean isDOIReserved(Context context,
                    DSpaceObject dso,
                    java.lang.String doi)
                      throws DOIIdentifierException

Specified by:

isDOIReserved in interface DOIConnector

Throws:

DOIIdentifierException

isDOIRegistered

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

Specified by:

isDOIRegistered in interface DOIConnector

Throws:

DOIIdentifierException

isDOIRegistered

public boolean isDOIRegistered(Context context,
                      DSpaceObject dso,
                      java.lang.String doi)
                        throws DOIIdentifierException

Specified by:

isDOIRegistered in interface DOIConnector

Throws:

DOIIdentifierException

deleteDOI

public void deleteDOI(Context context,
             java.lang.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.

A DOIConnector does not have to check whether the DOI is reserved, registered or not. It will only send the request and return the answer in form of a boolean weather the deletion was successful or not. It may even throw an DOIIdentifierException in case you are not allowed to delete a DOI, the DOI does not exist, ... So please be sure that the deletion of a DOI is conform with the rules of the registry and that the DOI is in the appropriate state (f.e. reserved but not registered).

Specified by:

deleteDOI in interface DOIConnector

Throws:

DOIIdentifierException

reserveDOI

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

Description copied from interface: DOIConnector

Sends a request to the DOI registry to reserve a DOI. Please check on your own if the DOI is already reserved or even registered before you try to reserve it. You can use isDOIRegistered and isDOIReserved for it. The DOIConnector won't do any tests and throws an DOIIdentifierException in case of any problems with the DOI you want to reserve.

Specified by:

reserveDOI in interface DOIConnector

Throws:

DOIIdentifierException

registerDOI

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

Description copied from interface: DOIConnector

Sends a request to the DOI registry to register a DOI. Please check on your own if the DOI is already reserved or even registered before you try to register it. You can use the methods DOIConnector.isDOIRegistered(...) and DOIConnector.isDOIReserved(...) for it. The DOIConnector won't do any tests and throws an DOIIdentifierException in case of any problems with the DOI you want to register.

Specified by:

registerDOI in interface DOIConnector

Throws:

DOIIdentifierException

updateMetadata

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

Description copied from interface: DOIConnector

Sends a request to the DOI registry to update Metadata for a DOI. The DOIConnector won't do any tests and throws an IdentifierException in case of any problems with the DOI you want to update the metadata.

Specified by:

updateMetadata in interface DOIConnector

Throws:

DOIIdentifierException