org.dspace.identifier.doi

Interface DOIConnector

All Known Implementing Classes:

DataCiteConnector

public interface DOIConnector

A DOIConnector handles all calls to the API of your DOI registry. Please pay attention to the method #purgeCachedInformation()!

Author:

Pascal-Nicolas Becker

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	updateMetadata(Context context, DSpaceObject dso, java.lang.String doi) Sends a request to the DOI registry to update Metadata for a DOI.

Method Detail

isDOIReserved

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

Throws:

DOIIdentifierException

isDOIReserved

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

Throws:

DOIIdentifierException

isDOIRegistered

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

Throws:

DOIIdentifierException

isDOIRegistered

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

Throws:

DOIIdentifierException

deleteDOI

void deleteDOI(Context context,
             java.lang.String doi)
               throws DOIIdentifierException

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).

Parameters:

context -

doi -

Throws:

DOIIdentifierException

reserveDOI

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

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.

Parameters:

context -

dso -

doi -

Throws:

DOIIdentifierException

registerDOI

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

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.

Parameters:

context -

dso -

doi -

Throws:

DOIIdentifierException

updateMetadata

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

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.

Parameters:

context -

dso -

doi -

Throws:

IdentifierException

DOIIdentifierException