Package org.dspace.identifier

Class VersionedHandleIdentifierProviderWithCanonicalHandles

java.lang.Object

org.dspace.identifier.IdentifierProvider

org.dspace.identifier.VersionedHandleIdentifierProviderWithCanonicalHandles

All Implemented Interfaces:

InitializingBean

public class VersionedHandleIdentifierProviderWithCanonicalHandles
extends IdentifierProvider
implements InitializingBean

Author:

Fabio Bolognesi (fabio at atmire dot com), Mark Diggory (markd at atmire dot com), Ben Bosman (ben at atmire dot com)

Field Summary

Fields inherited from class org.dspace.identifier.IdentifierProvider

configurationService, parentService

Constructor Summary

Constructors

Constructor	Description
VersionedHandleIdentifierProviderWithCanonicalHandles()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()	After all the properties are set check that the versioning is enabled
protected String	createNewIdentifier(Context context, DSpaceObject dso, String handleId)
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.
protected String	getCanonical(String identifier)
protected String	getCanonical(Context context, Item item)
protected VersionHistory	getHistory(Context context, String identifier)
static String	getPrefix()	Get the configured Handle prefix string, or a default
String	lookup(Context context, DSpaceObject dso)	Return the identifier for a DSpaceObject.
protected String	makeIdentifierBasedOnHistory(Context context, DSpaceObject dso, VersionHistory history)
String	mint(Context context, DSpaceObject dso)	Creates a new handle in the database.
protected void	modifyHandleMetadata(Context context, DSpaceObject dso, String handle)	Remove all handles from an item's metadata and add the supplied handle instead.
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	reserve(Context context, DSpaceObject dso, String identifier)	Set an object's identifier.
DSpaceObject	resolve(Context context, String identifier, String... attributes)	Find the object named by a given identifier.
protected void	restoreItAsCanonical(Context context, DSpaceObject dso, String identifier, Item item, String canonical)
protected void	restoreItAsVersion(Context context, DSpaceObject dso, String identifier, Item item, String canonical, VersionHistory history)
static String	retrieveHandleOutOfUrl(String url)
boolean	supports(Class<? extends Identifier> identifier)	Can this provider provide identifiers of a given type?
boolean	supports(String identifier)	Can this provider provide identifiers of a given type?

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

Constructor Details

VersionedHandleIdentifierProviderWithCanonicalHandles

public VersionedHandleIdentifierProviderWithCanonicalHandles()

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

supports

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

Description copied from class: IdentifierProvider

Can this provider provide identifiers of a given type?

Specified by:

supports in class IdentifierProvider

Parameters:

identifier - requested type.

Returns:

true if the given type is assignable from this provider's type.

supports

public boolean supports(String identifier)

Description copied from class: IdentifierProvider

Can this provider provide identifiers of a given type?

Specified by:

supports in class IdentifierProvider

Parameters:

identifier - requested type.

Returns:

true if this provider can provide the named type of identifier.

register

public String register(Context context,
 DSpaceObject dso)

Description copied from class: IdentifierProvider

Create and apply an identifier to a DSpaceObject.

Specified by:

register in class IdentifierProvider

Parameters:

context - The relevant DSpace Context.

dso - object to be named.

Returns:

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

register

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

Description copied from class: IdentifierProvider

Create a specific identifier and apply it to an object.

Specified by:

register in class IdentifierProvider

Parameters:

context - The relevant DSpace Context.

dso - to be identified.

identifier - to be created.

getHistory

protected VersionHistory getHistory(Context context,
 String identifier)
                             throws SQLException

Throws:

SQLException

restoreItAsVersion

protected void restoreItAsVersion(Context context,
 DSpaceObject dso,
 String identifier,
 Item item,
 String canonical,
 VersionHistory history)
                           throws SQLException,
IOException,
AuthorizeException

Throws:

SQLException

IOException

AuthorizeException

restoreItAsCanonical

protected void restoreItAsCanonical(Context context,
 DSpaceObject dso,
 String identifier,
 Item item,
 String canonical)
                             throws SQLException,
IOException,
AuthorizeException

Throws:

SQLException

IOException

AuthorizeException

reserve

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

Description copied from class: IdentifierProvider

Set an object's identifier.

Specified by:

reserve in class IdentifierProvider

Parameters:

context - The relevant DSpace Context.

dso - object to be identified.

identifier - to be set on the object.

mint

public String mint(Context context,
 DSpaceObject dso)

Creates a new handle in the database.

Specified by:

mint in class IdentifierProvider

Parameters:

context - DSpace context

dso - The DSpaceObject to create a handle for

Returns:

The newly created handle

resolve

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

Description copied from class: IdentifierProvider

Find the object named by a given identifier.

Specified by:

resolve in class IdentifierProvider

Parameters:

context - The relevant DSpace Context.

identifier - to be resolved.

attributes - additional information for resolving identifier.

Returns:

the named object.

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

Parameters:

context - The relevant DSpace Context.

dso - The object to be looked up.

Returns:

identifier for object.

Throws:

IdentifierNotFoundException - if identifier not found

IdentifierNotResolvableException - if identifier not resolvable

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

Parameters:

context - The relevant DSpace Context.

dso - object to be de-identified.

identifier - to be removed.

Throws:

IdentifierException - if identifier error

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

Parameters:

context - The relevant DSpace Context.

dso - object to lose its identity.

Throws:

IdentifierException - if identifier error

retrieveHandleOutOfUrl

public static String retrieveHandleOutOfUrl(String url)

getPrefix

public static String getPrefix()

Get the configured Handle prefix string, or a default

Returns:

configured prefix or "123456789"

createNewIdentifier

protected String createNewIdentifier(Context context,
 DSpaceObject dso,
 String handleId)
                              throws SQLException

Throws:

SQLException

makeIdentifierBasedOnHistory

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

Throws:

AuthorizeException

SQLException

getCanonical

protected String getCanonical(Context context,
 Item item)

getCanonical

protected String getCanonical(String identifier)

modifyHandleMetadata

protected void modifyHandleMetadata(Context context,
 DSpaceObject dso,
 String handle)
                             throws SQLException,
AuthorizeException

Remove all handles from an item's metadata and add the supplied handle instead.

Parameters:

context - The relevant DSpace Context.

dso - which dso to modify

handle - which handle to add

Throws:

SQLException - if database error

AuthorizeException - if authorization error