Package org.dspace.identifier

Class VersionedDOIIdentifierProvider

java.lang.Object

org.dspace.identifier.IdentifierProvider

org.dspace.identifier.FilteredIdentifierProvider

org.dspace.identifier.DOIIdentifierProvider

org.dspace.identifier.VersionedDOIIdentifierProvider

All Implemented Interfaces:

InitializingBean

public class VersionedDOIIdentifierProvider
extends DOIIdentifierProvider
implements InitializingBean

Author:

Marsa Haoua, Pascal-Nicolas Becker (dspace at pascal dash becker dot de)

Field Summary

Fields

Modifier and Type	Field	Description
protected DOIConnector	connector
protected static final String	pattern
protected VersionHistoryService	versionHistoryService
protected VersioningService	versioningService

Fields inherited from class org.dspace.identifier.DOIIdentifierProvider

contentServiceFactory, DELETED, DOI_ELEMENT, DOI_QUALIFIER, doiService, IS_REGISTERED, IS_RESERVED, itemService, MD_SCHEMA, MINTED, PENDING, statusText, TO_BE_DELETED, TO_BE_REGISTERED, TO_BE_RESERVED, UPDATE_BEFORE_REGISTRATION, UPDATE_REGISTERED, UPDATE_RESERVED

Fields inherited from class org.dspace.identifier.FilteredIdentifierProvider

filter

Fields inherited from class org.dspace.identifier.IdentifierProvider

configurationService, parentService

Constructor Summary

Constructors

Constructor	Description
VersionedDOIIdentifierProvider()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()	After all the properties are set check that the versioning is enabled
protected String	getBareDOI(String identifier)
protected String	getDOIPostfix(String identifier)
protected String	makeIdentifierBasedOnHistory(Context context, DSpaceObject dso, VersionHistory history)
protected String	makeIdentifierBasedOnHistory(Context context, DSpaceObject dso, VersionHistory history, Filter filter)
String	mint(Context context, DSpaceObject dso)	Mint a new DOI in DSpace - this is usually the first step of registration Always apply filters if they are configured
String	mint(Context context, DSpaceObject dso, Filter filter)	Mint a new DOI in DSpace - this is usually the first step of registration
void	register(Context context, DSpaceObject dso, String identifier)	Register a specified DOI for a given DSpaceObject, never skipping or ignoring any configured filter
void	register(Context context, DSpaceObject dso, String identifier, Filter filter)	Register a specified DOI for a given DSpaceObject
String	register(Context context, DSpaceObject dso, Filter filter)	Register a new DOI for a given DSpaceObject
void	setConfigurationService(ConfigurationService configurationService)
void	setDOIConnector(DOIConnector connector)	Set the DOI connector, which is the component that commuincates with the remote registration service (eg.

Methods inherited from class org.dspace.identifier.DOIIdentifierProvider

checkMintable, checkMintable, delete, delete, deleteOnline, getDOIByObject, getDOIOutOfObject, getNamespaceSeparator, getObjectByDOI, getPrefix, loadOrCreateDOI, loadOrCreateDOI, lookup, register, registerOnline, registerOnline, removeDOIFromObject, reserve, reserve, reserveOnline, reserveOnline, resolve, saveDOIToObject, supports, supports, updateMetadata, updateMetadataOnline

Methods inherited from class org.dspace.identifier.FilteredIdentifierProvider

setFilter

Methods inherited from class org.dspace.identifier.IdentifierProvider

setParentService

Methods inherited from class java.lang.Object

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

Field Details

connector

protected DOIConnector connector

pattern

protected static final String pattern

versioningService

@Autowired(required=true)
protected VersioningService versioningService

versionHistoryService

@Autowired(required=true)
protected VersionHistoryService versionHistoryService

Constructor Details

VersionedDOIIdentifierProvider

public VersionedDOIIdentifierProvider()

Method Details

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

After all the properties are set check that the versioning is enabled

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

Exception - throws an exception if this isn't the case

mint

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

Description copied from class: DOIIdentifierProvider

Mint a new DOI in DSpace - this is usually the first step of registration Always apply filters if they are configured

Overrides:

mint in class DOIIdentifierProvider

Parameters:

context - - DSpace context

dso - - DSpaceObject identified by the new identifier

Returns:

a String containing the new identifier

Throws:

IdentifierException - if identifier error

mint

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

Description copied from class: DOIIdentifierProvider

Mint a new DOI in DSpace - this is usually the first step of registration

Overrides:

mint in class DOIIdentifierProvider

Parameters:

context - - DSpace context

dso - - DSpaceObject identified by the new identifier

filter - - Logical item filter to determine whether this identifier should be registered

Returns:

a String containing the new identifier

Throws:

IdentifierException

register

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

Description copied from class: DOIIdentifierProvider

Register a specified DOI for a given DSpaceObject, never skipping or ignoring any configured filter

Overrides:

register in class DOIIdentifierProvider

Parameters:

context - - DSpace context

dso - - DSpaceObject identified by the new DOI

identifier - - String containing the identifier to register

Throws:

IdentifierException - if identifier error

register

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

Description copied from class: DOIIdentifierProvider

Register a new DOI for a given DSpaceObject

Overrides:

register in class DOIIdentifierProvider

Parameters:

context - - DSpace context

dso - - DSpaceObject identified by the new DOI

filter - - Logical item filter to determine whether this identifier should be registered

Returns:

identifier

Throws:

IdentifierException

register

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

Description copied from class: DOIIdentifierProvider

Register a specified DOI for a given DSpaceObject

Overrides:

register in class DOIIdentifierProvider

Parameters:

context - - DSpace context

dso - - DSpaceObject identified by the new DOI

identifier - - String containing the DOI to register

filter - - Logical item filter to determine whether this identifier should be registered

Throws:

IdentifierException

getBareDOI

protected String getBareDOI(String identifier)
                     throws DOIIdentifierException

Throws:

DOIIdentifierException

getDOIPostfix

protected String getDOIPostfix(String identifier)
                        throws DOIIdentifierException

Throws:

DOIIdentifierException

makeIdentifierBasedOnHistory

protected String makeIdentifierBasedOnHistory(Context context,
 DSpaceObject dso,
 VersionHistory history)
                                       throws AuthorizeException,
SQLException,
DOIIdentifierException,
IdentifierNotApplicableException

Throws:

AuthorizeException

SQLException

DOIIdentifierException

IdentifierNotApplicableException

makeIdentifierBasedOnHistory

protected String makeIdentifierBasedOnHistory(Context context,
 DSpaceObject dso,
 VersionHistory history,
 Filter filter)
                                       throws AuthorizeException,
SQLException,
DOIIdentifierException,
IdentifierNotApplicableException

Throws:

AuthorizeException

SQLException

DOIIdentifierException

IdentifierNotApplicableException

setDOIConnector

@Autowired(required=true)
public void setDOIConnector(DOIConnector connector)

Description copied from class: DOIIdentifierProvider

Set the DOI connector, which is the component that commuincates with the remote registration service (eg. DataCite, EZID, Crossref) Spring will use this setter to set the DOI connector from the configured property in identifier-services.xml

Overrides:

setDOIConnector in class DOIIdentifierProvider

Parameters:

connector - a DOIConnector

setConfigurationService

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

Overrides:

setConfigurationService in class IdentifierProvider