org.dspace.identifier

Class HandleIdentifierProvider

java.lang.Object

org.dspace.identifier.IdentifierProvider

org.dspace.identifier.HandleIdentifierProvider

@Component
public class HandleIdentifierProvider
extends IdentifierProvider

The old DSpace handle identifier service, used to create handles or retrieve objects based on their handle

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

Modifier and Type	Field and Description
protected static java.lang.String	EXAMPLE_PREFIX Prefix registered to no one
protected java.lang.String[]	supportedPrefixes

Fields inherited from class org.dspace.identifier.IdentifierProvider

configurationService, parentService

Constructor Summary

Constructors

Constructor and Description
HandleIdentifierProvider()

Method Summary

Methods

Modifier and Type	Method and Description
protected static java.lang.String	createId(int id) Create a new handle id.
protected java.lang.String	createNewIdentifier(Context context, DSpaceObject dso, java.lang.String handleId)
void	delete(Context context, DSpaceObject dso) Unbind this type of identifier(s) from an object.
void	delete(Context context, DSpaceObject dso, java.lang.String identifier) Unbind the given identifier from an object.
protected static TableRow	findHandleInternal(Context context, java.lang.String handle) Find the database row corresponding to handle.
protected static java.lang.String	getCanonicalForm(java.lang.String handle)
protected static TableRow	getHandleInternal(Context context, int type, int id) Return the handle for an Object, or null if the Object has no handle.
static java.lang.String	getPrefix() Get the configured Handle prefix string, or a default
java.lang.String	lookup(Context context, DSpaceObject dso) Return the identifier for a DSpaceObject.
java.lang.String	mint(Context context, DSpaceObject dso) Creates a new handle in the database.
protected java.lang.String	modifyHandleRecord(Context context, DSpaceObject dso, TableRow handle, java.lang.String handleId)
protected void	populateHandleMetadata(Item item, java.lang.String handle)
java.lang.String	register(Context context, DSpaceObject dso) Create and apply an identifier to a DSpaceObject.
void	register(Context context, DSpaceObject dso, java.lang.String identifier) Create a specific identifier and apply it to an object.
void	reserve(Context context, DSpaceObject dso, java.lang.String identifier) Set an object's identifier.
DSpaceObject	resolve(Context context, java.lang.String identifier, java.lang.String... attributes) Find the object named by a given identifier.
static java.lang.String	retrieveHandleOutOfUrl(java.lang.String url)
boolean	supports(java.lang.Class<? extends Identifier> identifier) Can this provider provide identifiers of a given type?
boolean	supports(java.lang.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

Field Detail

EXAMPLE_PREFIX

protected static final java.lang.String EXAMPLE_PREFIX

Prefix registered to no one

See Also:

Constant Field Values

supportedPrefixes

protected java.lang.String[] supportedPrefixes

Constructor Detail

HandleIdentifierProvider

public HandleIdentifierProvider()

Method Detail

supports

public boolean supports(java.lang.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(java.lang.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 java.lang.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

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,
            java.lang.String identifier)

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.

reserve

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

Description copied from class: IdentifierProvider

Set an object's identifier.

Specified by:

reserve in class IdentifierProvider

dso - object to be identified.

identifier - to be set on the object.

mint

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

Throws:

java.sql.SQLException - If a database error occurs

resolve

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

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.

lookup

public java.lang.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,
          java.lang.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

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

retrieveHandleOutOfUrl

public static java.lang.String retrieveHandleOutOfUrl(java.lang.String url)
                                               throws java.sql.SQLException

Throws:

java.sql.SQLException

getPrefix

public static java.lang.String getPrefix()

Get the configured Handle prefix string, or a default

Returns:

configured prefix or "123456789"

getCanonicalForm

protected static java.lang.String getCanonicalForm(java.lang.String handle)

createNewIdentifier

protected java.lang.String createNewIdentifier(Context context,
                                   DSpaceObject dso,
                                   java.lang.String handleId)
                                        throws java.sql.SQLException

Throws:

java.sql.SQLException

modifyHandleRecord

protected java.lang.String modifyHandleRecord(Context context,
                                  DSpaceObject dso,
                                  TableRow handle,
                                  java.lang.String handleId)
                                       throws java.sql.SQLException

Throws:

java.sql.SQLException

getHandleInternal

protected static TableRow getHandleInternal(Context context,
                         int type,
                         int id)
                                     throws java.sql.SQLException

Return the handle for an Object, or null if the Object has no handle.

Parameters:

context - DSpace context

type - The type of object

id - The id of object

Returns:

The handle for object, or null if the object has no handle.

Throws:

java.sql.SQLException - If a database error occurs

findHandleInternal

protected static TableRow findHandleInternal(Context context,
                          java.lang.String handle)
                                      throws java.sql.SQLException

Find the database row corresponding to handle.

Parameters:

context - DSpace context

handle - The handle to resolve

Returns:

The database row corresponding to the handle

Throws:

java.sql.SQLException - If a database error occurs

createId

protected static java.lang.String createId(int id)
                                    throws java.sql.SQLException

Create a new handle id. The implementation uses the PK of the RDBMS Handle table.

Returns:

A new handle id

Throws:

java.sql.SQLException - If a database error occurs

populateHandleMetadata

protected void populateHandleMetadata(Item item,
                          java.lang.String handle)
                               throws java.sql.SQLException,
                                      java.io.IOException,
                                      AuthorizeException

Throws:

java.sql.SQLException

java.io.IOException

AuthorizeException