org.dspace.identifier

Class DOIIdentifierProvider

java.lang.Object

org.dspace.identifier.IdentifierProvider

org.dspace.identifier.DOIIdentifierProvider

public class DOIIdentifierProvider
extends IdentifierProvider

Provide service for DOIs using DataCite.

This class handles reservation, registration and deletion of DOIs using the direct API from DataCite. Please pay attention that some members of DataCite offer special services and want their customers to use special APIs. If you are unsure ask your registration agency.

Any identifier a method of this class returns is a string in the following format: doi:10.123/456.

Author:

Pascal-Nicolas Becker

Field Summary

Fields

Modifier and Type	Field and Description
static Integer	DELETED
static String	DOI_ELEMENT
static String	DOI_QUALIFIER
static Integer	IS_REGISTERED
static Integer	IS_RESERVED
static String	MD_SCHEMA
static Integer	TO_BE_DELETED
static Integer	TO_BE_REGISTERED
static Integer	TO_BE_RESERVED
static Integer	UPDATE_BEFORE_REGISTRATION
static Integer	UPDATE_REGISTERED
static Integer	UPDATE_RESERVED

Fields inherited from class org.dspace.identifier.IdentifierProvider

configurationService, parentService

Constructor Summary

Constructors

Constructor and Description
DOIIdentifierProvider()

Method Summary

Methods

Modifier and Type	Method and Description
void	delete(Context context, DSpaceObject dso) Unbind this type of identifier(s) from an object.
void	delete(Context context, DSpaceObject dso, String identifier) Unbind the given identifier from an object.
void	deleteOnline(Context context, String identifier)
static String	getDOIByObject(Context context, DSpaceObject dso) Search the database for a DOI, using the type and id of an DSpaceObject.
static String	getDOIOutOfObject(DSpaceObject dso) Loads a DOI out of the metadata of an DSpaceObject.
protected String	getNamespaceSeparator()
static DSpaceObject	getObjectByDOI(Context context, String identifier) Returns a DSpaceObject depending on its DOI.
protected String	getPrefix()
protected TableRow	loadOrCreateDOI(Context context, DSpaceObject dso, String doi) Load a DOI from the database or creates it if it does not exist.
String	lookup(Context context, DSpaceObject dso) Return the identifier for a DSpaceObject.
String	mint(Context context, DSpaceObject dso) Create an identifier for a DSpaceObject.
String	register(Context context, DSpaceObject dso) Create and apply an identifier to a DSpaceObject.
void	register(Context context, DSpaceObject dso, String identifier) Create a specific identifier and apply it to an object.
void	registerOnline(Context context, DSpaceObject dso, String identifier)
protected void	removeDOIFromObject(Context context, DSpaceObject dso, String doi) Removes a DOI out of the metadata of a DSpaceObject.
void	reserve(Context context, DSpaceObject dso, String identifier) Set an object's identifier.
void	reserveOnline(Context context, DSpaceObject dso, String identifier)
DSpaceObject	resolve(Context context, String identifier, String... attributes) Find the object named by a given identifier.
protected void	saveDOIToObject(Context context, DSpaceObject dso, String doi) Adds a DOI to the metadata of an item.
void	setDOIConnector(DOIConnector connector)
boolean	supports(Class<? extends Identifier> identifier) This identifier provider supports identifiers of type DOI.
boolean	supports(String identifier) This identifier provider supports identifiers in the following format: doi:10.123/456 10.123/456 http://dx.doi.org/10.123/456
void	updateMetadata(Context context, DSpaceObject dso, String identifier)
void	updateMetadataOnline(Context context, DSpaceObject dso, String identifier)

Methods inherited from class org.dspace.identifier.IdentifierProvider

setConfigurationService, setParentService

Methods inherited from class java.lang.Object

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

Field Detail

MD_SCHEMA

public static final String MD_SCHEMA

See Also:

Constant Field Values

DOI_ELEMENT

public static final String DOI_ELEMENT

See Also:

Constant Field Values

DOI_QUALIFIER

public static final String DOI_QUALIFIER

See Also:

Constant Field Values

TO_BE_REGISTERED

public static final Integer TO_BE_REGISTERED

TO_BE_RESERVED

public static final Integer TO_BE_RESERVED

IS_REGISTERED

public static final Integer IS_REGISTERED

IS_RESERVED

public static final Integer IS_RESERVED

UPDATE_RESERVED

public static final Integer UPDATE_RESERVED

UPDATE_REGISTERED

public static final Integer UPDATE_REGISTERED

UPDATE_BEFORE_REGISTRATION

public static final Integer UPDATE_BEFORE_REGISTRATION

TO_BE_DELETED

public static final Integer TO_BE_DELETED

DELETED

public static final Integer DELETED

Constructor Detail

DOIIdentifierProvider

public DOIIdentifierProvider()

Method Detail

getPrefix

protected String getPrefix()

getNamespaceSeparator

protected String getNamespaceSeparator()

setDOIConnector

public void setDOIConnector(DOIConnector connector)

supports

public boolean supports(Class<? extends Identifier> identifier)

This identifier provider supports identifiers of type DOI.

Specified by:

supports in class IdentifierProvider

Parameters:

identifier - to check if it will be supported by this provider.

Returns:

supports

public boolean supports(String identifier)

This identifier provider supports identifiers in the following format:

• doi:10.123/456
• 10.123/456
• http://dx.doi.org/10.123/456

Specified by:

supports in class IdentifierProvider

Parameters:

identifier - to check if it is in a supported format.

Returns:

register

public String register(Context context,
              DSpaceObject dso)
                throws IdentifierException

Description copied from class: IdentifierProvider

Create and apply an identifier to a DSpaceObject.

Specified by:

register in class IdentifierProvider

dso - object to be named.

Returns:

existing identifier of item if it has one, else a new identifier.

Throws:

IdentifierException

register

public void register(Context context,
            DSpaceObject dso,
            String identifier)
              throws IdentifierException

Description copied from class: IdentifierProvider

Create a specific identifier and apply it to an object.

Specified by:

register in class IdentifierProvider

dso - to be identified.

identifier - to be created.

Throws:

IdentifierException

reserve

public void reserve(Context context,
           DSpaceObject dso,
           String identifier)
             throws IdentifierException,
                    IllegalArgumentException

Description copied from class: IdentifierProvider

Set an object's identifier.

Specified by:

reserve in class IdentifierProvider

Parameters:

context -

dso - DSpaceObject the DOI should be reserved for. Some metadata of this object will be send to the registration agency.

identifier - DOI to register in a format that FormatIdentifier(String) accepts.

Throws:

IdentifierException - If the format of identifier was unrecognized or if it was impossible to reserve the DOI (registration agency denied for some reason, see logs).

IllegalArgumentException - If identifier is a DOI already registered for another DSpaceObject then dso.

See Also:

IdentifierProvider.reserve(Context, DSpaceObject, String)

reserveOnline

public void reserveOnline(Context context,
                 DSpaceObject dso,
                 String identifier)
                   throws IdentifierException,
                          IllegalArgumentException,
                          SQLException

Throws:

IdentifierException

IllegalArgumentException

SQLException

registerOnline

public void registerOnline(Context context,
                  DSpaceObject dso,
                  String identifier)
                    throws IdentifierException,
                           IllegalArgumentException,
                           SQLException

Throws:

IdentifierException

IllegalArgumentException

SQLException

updateMetadata

public void updateMetadata(Context context,
                  DSpaceObject dso,
                  String identifier)
                    throws IdentifierException,
                           IllegalArgumentException,
                           SQLException

Throws:

IdentifierException

IllegalArgumentException

SQLException

updateMetadataOnline

public void updateMetadataOnline(Context context,
                        DSpaceObject dso,
                        String identifier)
                          throws IdentifierException,
                                 SQLException

Throws:

IdentifierException

SQLException

mint

public String mint(Context context,
          DSpaceObject dso)
            throws IdentifierException

Description copied from class: IdentifierProvider

Create an identifier for a DSpaceObject.

Specified by:

mint in class IdentifierProvider

dso - object to be named.

Returns:

existing identifier of dso if it has one, else a new identifier.

Throws:

IdentifierException

resolve

public DSpaceObject resolve(Context context,
                   String identifier,
                   String... attributes)
                     throws IdentifierNotFoundException,
                            IdentifierNotResolvableException

Description copied from class: IdentifierProvider

Find the object named by a given identifier.

Specified by:

resolve in class IdentifierProvider

identifier - to be resolved.

attributes - additional information for resolving identifier.

Returns:

the named object.

Throws:

IdentifierNotFoundException

IdentifierNotResolvableException

lookup

public String lookup(Context context,
            DSpaceObject dso)
              throws IdentifierNotFoundException,
                     IdentifierNotResolvableException

Description copied from class: IdentifierProvider

Return the identifier for a DSpaceObject.

Specified by:

lookup in class IdentifierProvider

dso - The object to be looked up.

Returns:

identifier for object.

Throws:

IdentifierNotFoundException

IdentifierNotResolvableException

delete

public void delete(Context context,
          DSpaceObject dso)
            throws IdentifierException

Description copied from class: IdentifierProvider

Unbind this type of identifier(s) from an object.

Specified by:

delete in class IdentifierProvider

dso - object to lose its identity.

Throws:

IdentifierException

delete

public void delete(Context context,
          DSpaceObject dso,
          String identifier)
            throws IdentifierException

Description copied from class: IdentifierProvider

Unbind the given identifier from an object.

Specified by:

delete in class IdentifierProvider

dso - object to be de-identified.

identifier - to be removed.

Throws:

IdentifierException

deleteOnline

public void deleteOnline(Context context,
                String identifier)
                  throws DOIIdentifierException

Throws:

DOIIdentifierException

getObjectByDOI

public static DSpaceObject getObjectByDOI(Context context,
                          String identifier)
                                   throws SQLException,
                                          DOIIdentifierException,
                                          IllegalArgumentException

Returns a DSpaceObject depending on its DOI.

Parameters:

context - the context

identifier - The DOI in a format that is accepted by formatIdentifier(String).

Returns:

Null if the DOI couldn't be found or the associated DSpaceObject.

Throws:

SQLException

IdentifierException - If identifier is null or an empty string.

IllegalArgumentException - If the identifier couldn't be recognized as DOI.

DOIIdentifierException

getDOIByObject

public static String getDOIByObject(Context context,
                    DSpaceObject dso)
                             throws SQLException

Search the database for a DOI, using the type and id of an DSpaceObject.

Parameters:

context -

dso - DSpaceObject to find doi for. DOIs with status TO_BE_DELETED will be ignored.

Returns:

The DOI as String or null if DOI was not found.

Throws:

SQLException

loadOrCreateDOI

protected TableRow loadOrCreateDOI(Context context,
                       DSpaceObject dso,
                       String doi)
                            throws SQLException,
                                   DOIIdentifierException

Load a DOI from the database or creates it if it does not exist. This method can be used to ensure that a DOI exists in the database and to load the appropriate TableRow. As protected method we don't check if the DOI is in a decent format, use DOI.formatIdentifier(String) if necessary.

Parameters:

context -

dso - The DSpaceObject the DOI should be loaded or created for.

doi - A DOI or null if a DOI should be generated. The generated DOI can be found in the appropriate column for the TableRow.

Returns:

The database row of the object.

Throws:

SQLException - In case of an error using the database.

DOIIdentifierException - If doi is not part of our prefix or DOI is registered for another object already.

getDOIOutOfObject

public static String getDOIOutOfObject(DSpaceObject dso)
                                throws DOIIdentifierException

Loads a DOI out of the metadata of an DSpaceObject.

Parameters:

dso -

Returns:

The DOI or null if no DOI was found.

Throws:

DOIIdentifierException

saveDOIToObject

protected void saveDOIToObject(Context context,
                   DSpaceObject dso,
                   String doi)
                        throws SQLException,
                               AuthorizeException,
                               IdentifierException

Adds a DOI to the metadata of an item.

Parameters:

context -

dso - DSpaceObject the DOI should be added to.

doi - The DOI that should be added as metadata.

Throws:

SQLException

AuthorizeException

IdentifierException

removeDOIFromObject

protected void removeDOIFromObject(Context context,
                       DSpaceObject dso,
                       String doi)
                            throws AuthorizeException,
                                   SQLException,
                                   IdentifierException

Removes a DOI out of the metadata of a DSpaceObject.

Parameters:

context -

dso - The DSpaceObject the DOI should be removed from.

doi - The DOI to remove out of the metadata.

Throws:

AuthorizeException

SQLException

IdentifierException