org.dspace.handle

Class HandleManager

java.lang.Object

org.dspace.handle.HandleManager

public class HandleManager
extends java.lang.Object

Interface to the CNRI Handle System .

Currently, this class simply maps handles to local facilities; handles which are owned by other sites (including other DSpaces) are treated as non-existent.

Version:

$Revision$

Author:

Peter Breton

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	createHandle(Context context, DSpaceObject dso) Creates a new handle in the database.
static java.lang.String	createHandle(Context context, DSpaceObject dso, java.lang.String suppliedHandle) Creates a handle entry, but with a handle supplied by the caller (new Handle not generated)
static java.lang.String	findHandle(Context context, DSpaceObject dso) Return the handle for an Object, or null if the Object has no handle.
static java.lang.String	getCanonicalForm(java.lang.String handle) Transforms handle into the canonical form hdl:handle.
static java.util.List<java.lang.String>	getHandlesForPrefix(Context context, java.lang.String prefix) Return all the handles which start with prefix.
static java.lang.String	getPrefix() Get the configured Handle prefix string, or a default
static DSpaceObject	resolveToObject(Context context, java.lang.String handle) Return the object which handle maps to, or null.
static java.lang.String	resolveToURL(Context context, java.lang.String handle) Return the local URL for handle, or null if handle cannot be found.
static java.lang.String	resolveUrlToHandle(Context context, java.lang.String url) Try to detect a handle in a URL.
static void	unbindHandle(Context context, DSpaceObject dso) Removes binding of Handle to a DSpace object, while leaving the Handle in the table so it doesn't get reallocated.

Methods inherited from class java.lang.Object

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

Method Detail

resolveToURL

public static java.lang.String resolveToURL(Context context,
                            java.lang.String handle)
                                     throws java.sql.SQLException

Return the local URL for handle, or null if handle cannot be found. The returned URL is a (non-handle-based) location where a dissemination of the object referred to by handle can be obtained.

Parameters:

context - DSpace context

handle - The handle

Returns:

The local URL

Throws:

java.sql.SQLException - If a database error occurs

resolveUrlToHandle

public static java.lang.String resolveUrlToHandle(Context context,
                                  java.lang.String url)
                                           throws java.sql.SQLException

Try to detect a handle in a URL.

Parameters:

context - DSpace context

url - The URL

Returns:

The handle or null if the handle couldn't be extracted of a URL or if the extracted handle couldn't be found.

Throws:

java.sql.SQLException - If a database error occurs

getCanonicalForm

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

Transforms handle into the canonical form hdl:handle. No attempt is made to verify that handle is in fact valid.

Parameters:

handle - The handle

Returns:

The canonical form

createHandle

public static java.lang.String createHandle(Context context,
                            DSpaceObject dso)
                                     throws java.sql.SQLException

Creates a new handle in the database.

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

createHandle

public static java.lang.String createHandle(Context context,
                            DSpaceObject dso,
                            java.lang.String suppliedHandle)
                                     throws java.sql.SQLException,
                                            java.lang.IllegalStateException

Creates a handle entry, but with a handle supplied by the caller (new Handle not generated)

Parameters:

context - DSpace context

dso - DSpaceObject

suppliedHandle - existing handle value

Returns:

the Handle

Throws:

java.lang.IllegalStateException - if specified handle is already in use by another object

java.sql.SQLException

unbindHandle

public static void unbindHandle(Context context,
                DSpaceObject dso)
                         throws java.sql.SQLException

Removes binding of Handle to a DSpace object, while leaving the Handle in the table so it doesn't get reallocated. The AIP implementation also needs it there for foreign key references.

Parameters:

context - DSpace context

dso - DSpaceObject whose Handle to unbind.

Throws:

java.sql.SQLException

resolveToObject

public static DSpaceObject resolveToObject(Context context,
                           java.lang.String handle)
                                    throws java.lang.IllegalStateException,
                                           java.sql.SQLException

Return the object which handle maps to, or null. This is the object itself, not a URL which points to it.

Parameters:

context - DSpace context

handle - The handle to resolve

Returns:

The object which handle maps to, or null if handle is not mapped to any object.

Throws:

java.lang.IllegalStateException - If handle was found but is not bound to an object

java.sql.SQLException - If a database error occurs

findHandle

public static java.lang.String findHandle(Context context,
                          DSpaceObject dso)
                                   throws java.sql.SQLException

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

Parameters:

context - DSpace context

dso - The object to obtain a handle for

Returns:

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

Throws:

java.sql.SQLException - If a database error occurs

getHandlesForPrefix

public static java.util.List<java.lang.String> getHandlesForPrefix(Context context,
                                                   java.lang.String prefix)
                                                            throws java.sql.SQLException

Return all the handles which start with prefix.

Parameters:

context - DSpace context

prefix - The handle prefix

Returns:

A list of the handles starting with prefix. The list is guaranteed to be non-null. Each element of the list is a String.

Throws:

java.sql.SQLException - If a database error occurs

getPrefix

public static java.lang.String getPrefix()

Get the configured Handle prefix string, or a default

Returns:

configured prefix or "123456789"