org.dspace.identifier

Class VersionedHandleIdentifierProvider

java.lang.Object

org.dspace.identifier.IdentifierProvider

org.dspace.identifier.VersionedHandleIdentifierProvider

@Component
public class VersionedHandleIdentifierProvider
extends org.dspace.identifier.IdentifierProvider

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 and Description
VersionedHandleIdentifierProvider()

Method Summary

Methods

Modifier and Type	Method and Description
protected static String	createId(int id) Create a new handle id.
protected String	createNewIdentifier(org.dspace.core.Context context, org.dspace.content.DSpaceObject dso, String handleId)
protected AutoVersionImpl	createVersion(org.dspace.core.Context c, AutoVersionHistory vh, org.dspace.content.Item item, String summary, Date date, int versionNumber)
void	delete(org.dspace.core.Context context, org.dspace.content.DSpaceObject dso)
void	delete(org.dspace.core.Context context, org.dspace.content.DSpaceObject dso, String identifier)
protected static org.dspace.storage.rdbms.TableRow	findHandleInternal(org.dspace.core.Context context, String handle) Find the database row corresponding to handle.
protected String	getCanonical(org.dspace.content.Item item)
protected String	getCanonical(String identifier)
protected static String	getCanonicalForm(String handle)
protected static org.dspace.storage.rdbms.TableRow	getHandleInternal(org.dspace.core.Context context, int type, int id) Return the handle for an Object, or null if the Object has no handle.
protected int	getNextVersionNumer(AutoVersion latest)
static String	getPrefix() Get the configured Handle prefix string, or a default
String	lookup(org.dspace.core.Context context, org.dspace.content.DSpaceObject dso)
protected String	makeIdentifierBasedOnHistory(org.dspace.core.Context context, org.dspace.content.DSpaceObject dso, String handleId, AutoVersionHistory history)
String	mint(org.dspace.core.Context context, org.dspace.content.DSpaceObject dso) Creates a new handle in the database.
protected void	modifyHandleMetadata(org.dspace.content.Item item, String handle)
protected String	modifyHandleRecord(org.dspace.core.Context context, org.dspace.content.DSpaceObject dso, org.dspace.storage.rdbms.TableRow handle, String handleId)
protected void	populateHandleMetadata(org.dspace.content.Item item)
String	register(org.dspace.core.Context context, org.dspace.content.DSpaceObject dso)
void	register(org.dspace.core.Context context, org.dspace.content.DSpaceObject dso, String identifier)
void	reserve(org.dspace.core.Context context, org.dspace.content.DSpaceObject dso, String identifier)
org.dspace.content.DSpaceObject	resolve(org.dspace.core.Context context, String identifier, String... attributes)
static String	retrieveHandleOutOfUrl(String url)
protected AutoVersionHistory	retrieveVersionHistory(org.dspace.core.Context c, org.dspace.content.Item item)
void	setVersionDAO(AutoVersionDAO versionDAO)
void	setVersionHistoryDAO(AutoVersionHistoryDAO versionHistoryDAO)
boolean	supports(Class<? extends org.dspace.identifier.Identifier> identifier)
boolean	supports(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

Constructor Detail

VersionedHandleIdentifierProvider

public VersionedHandleIdentifierProvider()

Method Detail

supports

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

Specified by:

supports in class org.dspace.identifier.IdentifierProvider

supports

public boolean supports(String identifier)

Specified by:

supports in class org.dspace.identifier.IdentifierProvider

register

public String register(org.dspace.core.Context context,
              org.dspace.content.DSpaceObject dso)

Specified by:

register in class org.dspace.identifier.IdentifierProvider

register

public void register(org.dspace.core.Context context,
            org.dspace.content.DSpaceObject dso,
            String identifier)

Specified by:

register in class org.dspace.identifier.IdentifierProvider

reserve

public void reserve(org.dspace.core.Context context,
           org.dspace.content.DSpaceObject dso,
           String identifier)

Specified by:

reserve in class org.dspace.identifier.IdentifierProvider

mint

public String mint(org.dspace.core.Context context,
          org.dspace.content.DSpaceObject dso)

Creates a new handle in the database.

Specified by:

mint in class org.dspace.identifier.IdentifierProvider

Parameters:

context - DSpace context

dso - The DSpaceObject to create a handle for

Returns:

The newly created handle

resolve

public org.dspace.content.DSpaceObject resolve(org.dspace.core.Context context,
                                      String identifier,
                                      String... attributes)

Specified by:

resolve in class org.dspace.identifier.IdentifierProvider

lookup

public String lookup(org.dspace.core.Context context,
            org.dspace.content.DSpaceObject dso)
              throws org.dspace.identifier.IdentifierNotFoundException,
                     org.dspace.identifier.IdentifierNotResolvableException

Specified by:

lookup in class org.dspace.identifier.IdentifierProvider

Throws:

org.dspace.identifier.IdentifierNotFoundException

org.dspace.identifier.IdentifierNotResolvableException

delete

public void delete(org.dspace.core.Context context,
          org.dspace.content.DSpaceObject dso,
          String identifier)
            throws org.dspace.identifier.IdentifierException

Specified by:

delete in class org.dspace.identifier.IdentifierProvider

Throws:

org.dspace.identifier.IdentifierException

delete

public void delete(org.dspace.core.Context context,
          org.dspace.content.DSpaceObject dso)
            throws org.dspace.identifier.IdentifierException

Specified by:

delete in class org.dspace.identifier.IdentifierProvider

Throws:

org.dspace.identifier.IdentifierException

retrieveHandleOutOfUrl

public static String retrieveHandleOutOfUrl(String url)
                                     throws SQLException

Throws:

SQLException

getPrefix

public static String getPrefix()

Get the configured Handle prefix string, or a default

Returns:

configured prefix or "123456789"

getCanonicalForm

protected static String getCanonicalForm(String handle)

createNewIdentifier

protected String createNewIdentifier(org.dspace.core.Context context,
                         org.dspace.content.DSpaceObject dso,
                         String handleId)
                              throws SQLException

Throws:

SQLException

makeIdentifierBasedOnHistory

protected String makeIdentifierBasedOnHistory(org.dspace.core.Context context,
                                  org.dspace.content.DSpaceObject dso,
                                  String handleId,
                                  AutoVersionHistory history)
                                       throws org.dspace.authorize.AuthorizeException,
                                              SQLException

Throws:

org.dspace.authorize.AuthorizeException

SQLException

modifyHandleRecord

protected String modifyHandleRecord(org.dspace.core.Context context,
                        org.dspace.content.DSpaceObject dso,
                        org.dspace.storage.rdbms.TableRow handle,
                        String handleId)
                             throws SQLException

Throws:

SQLException

getCanonical

protected String getCanonical(org.dspace.content.Item item)

getCanonical

protected String getCanonical(String identifier)

findHandleInternal

protected static org.dspace.storage.rdbms.TableRow findHandleInternal(org.dspace.core.Context context,
                                                   String handle)
                                                               throws 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:

SQLException - If a database error occurs

getHandleInternal

protected static org.dspace.storage.rdbms.TableRow getHandleInternal(org.dspace.core.Context context,
                                                  int type,
                                                  int id)
                                                              throws 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:

SQLException - If a database error occurs

createId

protected static String createId(int id)
                          throws SQLException

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

Returns:

A new handle id

Throws:

SQLException - If a database error occurs

retrieveVersionHistory

protected AutoVersionHistory retrieveVersionHistory(org.dspace.core.Context c,
                                        org.dspace.content.Item item)

populateHandleMetadata

protected void populateHandleMetadata(org.dspace.content.Item item)
                               throws SQLException,
                                      IOException,
                                      org.dspace.authorize.AuthorizeException

Throws:

SQLException

IOException

org.dspace.authorize.AuthorizeException

modifyHandleMetadata

protected void modifyHandleMetadata(org.dspace.content.Item item,
                        String handle)
                             throws SQLException,
                                    IOException,
                                    org.dspace.authorize.AuthorizeException

Throws:

SQLException

IOException

org.dspace.authorize.AuthorizeException

createVersion

protected AutoVersionImpl createVersion(org.dspace.core.Context c,
                            AutoVersionHistory vh,
                            org.dspace.content.Item item,
                            String summary,
                            Date date,
                            int versionNumber)

getNextVersionNumer

protected int getNextVersionNumer(AutoVersion latest)

setVersionDAO

public void setVersionDAO(AutoVersionDAO versionDAO)

setVersionHistoryDAO

public void setVersionHistoryDAO(AutoVersionHistoryDAO versionHistoryDAO)