org.dspace.identifier

Class UniversallyUniqueIdentifierProvider

java.lang.Object

org.dspace.identifier.IdentifierProvider

org.dspace.identifier.UniversallyUniqueIdentifierProvider

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

The old DSpace uuid identifier service, used to create uuids or retrieve objects based on their uuid

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 String	EXAMPLE_PREFIX Prefix registered to no one
protected String[]	supportedPrefixes

Fields inherited from class org.dspace.identifier.IdentifierProvider

configurationService, parentService

Constructor Summary

Constructors

Constructor and Description
UniversallyUniqueIdentifierProvider()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	createNewIdentifier(org.dspace.core.Context context, org.dspace.content.DSpaceObject dso, String uuidId)
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	findUuidInternal(org.dspace.core.Context context, String uuid) Find the database row corresponding to uuid.
protected static org.dspace.storage.rdbms.TableRow	getUuidInternal(org.dspace.core.Context context, int type, int id) Return the uuid for an Object, or null if the Object has no uuid.
String	lookup(org.dspace.core.Context context, org.dspace.content.DSpaceObject dso)
String	mint(org.dspace.core.Context context, org.dspace.content.DSpaceObject dso) Mint a Identifier for this object if it does not already exist in the Database.
protected String	modifyUuidRecord(org.dspace.core.Context context, org.dspace.content.DSpaceObject dso, org.dspace.storage.rdbms.TableRow uuid, String uuidId)
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	retrieveUuidOutOfUrl(String url)
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

Field Detail

EXAMPLE_PREFIX

protected static final String EXAMPLE_PREFIX

Prefix registered to no one

See Also:

Constant Field Values

supportedPrefixes

protected String[] supportedPrefixes

Constructor Detail

UniversallyUniqueIdentifierProvider

public UniversallyUniqueIdentifierProvider()

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)

Mint a Identifier for this object if it does not already exist in the Database. Creates a new uuid in the database, but only if it did not previously exi.

Specified by:

mint in class org.dspace.identifier.IdentifierProvider

Parameters:

context - DSpace context

dso - The DSpaceObject to create a uuid for

Returns:

The newly created uuid

Throws:

SQLException - If a database error occurs

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

retrieveUuidOutOfUrl

public static String retrieveUuidOutOfUrl(String url)
                                   throws SQLException

Throws:

SQLException

createNewIdentifier

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

Throws:

SQLException

modifyUuidRecord

protected String modifyUuidRecord(org.dspace.core.Context context,
                      org.dspace.content.DSpaceObject dso,
                      org.dspace.storage.rdbms.TableRow uuid,
                      String uuidId)
                           throws SQLException

Throws:

SQLException

getUuidInternal

protected static org.dspace.storage.rdbms.TableRow getUuidInternal(org.dspace.core.Context context,
                                                int type,
                                                int id)
                                                            throws SQLException

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

Parameters:

context - DSpace context

type - The type of object

id - The id of object

Returns:

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

Throws:

SQLException - If a database error occurs

findUuidInternal

protected static org.dspace.storage.rdbms.TableRow findUuidInternal(org.dspace.core.Context context,
                                                 String uuid)
                                                             throws SQLException

Find the database row corresponding to uuid.

Parameters:

context - DSpace context

uuid - The uuid to resolve

Returns:

The database row corresponding to the uuid

Throws:

SQLException - If a database error occurs