net.cnri.apps.hdlstorage

Class HDLCalculatedStorage

java.lang.Object

net.cnri.apps.hdlstorage.HDLCalculatedStorage

All Implemented Interfaces:

net.handle.hdllib.HandleStorage

public class HDLCalculatedStorage
extends java.lang.Object
implements net.handle.hdllib.HandleStorage

HDLCalculatedStorage is a HandleStorage module that can return handle values for handles that don't exist in the handle database based on a template for handles with a certain prefix. For example, a query for the handle 123/12-555 will return the handle values for 123/12-555 if it exists, but if it doesn't exist the values for 123/12 will be returned (if it exists). This allows us to eliminate the need to formally create handles for every digital object that has the same handle values (ie handles that point to the same repository).

Constructor Summary

Constructors

Constructor and Description
HDLCalculatedStorage()

Method Summary

Methods

Modifier and Type	Method and Description
void	checkpointDatabase() Copy the current database to a backup file, and restart the transaction log.
void	createHandle(byte[] inHandle, net.handle.hdllib.HandleValue[] values) Creates the specified handle in the "database" with the specified initial values
void	deleteAllRecords() Remove all of the records from the database.
boolean	deleteHandle(byte[] inHandle) Delete the specified handle in the database.
void	finalize()
java.util.Enumeration	getHandlesForNA(byte[] naHdl) Scan the database for handles with the given naming authority and return an Enumeration of byte arrays with each byte array being a handle.
byte[][]	getRawHandleValues(byte[] inHandle, int[] indexList, byte[][] typeList) Return the pre-packaged values of the given handle that are either in the indexList or the typeList.
boolean	haveNA(byte[] authHandle) Returns true if this server is responsible for the given naming authority.
void	init(net.cnri.util.StreamTable config) Initialize the JDB handle database with the given configuration.
void	scanHandles(net.handle.hdllib.ScanCallback callback) Scan the database, calling a method in the specified callback for every handle in the database.
void	scanNAs(net.handle.hdllib.ScanCallback callback) Scan the NA database, calling a method in the specified callback for every naming authority handle in the database.
void	setHaveNA(byte[] authHandle, boolean flag) Sets a flag indicating whether or not this server is responsible for the given naming authority.
void	shutdown() Close the database and clean up
void	updateValue(byte[] inHandle, net.handle.hdllib.HandleValue[] values) Replace the current values for the given handle with new values.

Methods inherited from class java.lang.Object

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

Constructor Detail

HDLCalculatedStorage

public HDLCalculatedStorage()
                     throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

init

public void init(net.cnri.util.StreamTable config)

Initialize the JDB handle database with the given configuration. This currently doesn't do anything for the JDB database.

Specified by:

init in interface net.handle.hdllib.HandleStorage

haveNA

public final boolean haveNA(byte[] authHandle)
                     throws net.handle.hdllib.HandleException

Returns true if this server is responsible for the given naming authority.

Specified by:

haveNA in interface net.handle.hdllib.HandleStorage

Throws:

net.handle.hdllib.HandleException

setHaveNA

public final void setHaveNA(byte[] authHandle,
             boolean flag)
                     throws net.handle.hdllib.HandleException

Sets a flag indicating whether or not this server is responsible for the given naming authority.

Specified by:

setHaveNA in interface net.handle.hdllib.HandleStorage

Throws:

net.handle.hdllib.HandleException

getRawHandleValues

public final byte[][] getRawHandleValues(byte[] inHandle,
                          int[] indexList,
                          byte[][] typeList)
                                  throws net.handle.hdllib.HandleException

Return the pre-packaged values of the given handle that are either in the indexList or the typeList. This method should return any values of type ALIAS or REDIRECT, even if they were not requested.

Specified by:

getRawHandleValues in interface net.handle.hdllib.HandleStorage

Throws:

net.handle.hdllib.HandleException

createHandle

public final void createHandle(byte[] inHandle,
                net.handle.hdllib.HandleValue[] values)
                        throws net.handle.hdllib.HandleException

Creates the specified handle in the "database" with the specified initial values

Specified by:

createHandle in interface net.handle.hdllib.HandleStorage

Throws:

net.handle.hdllib.HandleException

deleteHandle

public final boolean deleteHandle(byte[] inHandle)
                           throws net.handle.hdllib.HandleException

Delete the specified handle in the database.

Specified by:

deleteHandle in interface net.handle.hdllib.HandleStorage

Throws:

net.handle.hdllib.HandleException

updateValue

public final void updateValue(byte[] inHandle,
               net.handle.hdllib.HandleValue[] values)
                       throws net.handle.hdllib.HandleException

Replace the current values for the given handle with new values.

Specified by:

updateValue in interface net.handle.hdllib.HandleStorage

Throws:

net.handle.hdllib.HandleException

scanHandles

public final void scanHandles(net.handle.hdllib.ScanCallback callback)
                       throws net.handle.hdllib.HandleException

Scan the database, calling a method in the specified callback for every handle in the database.

Specified by:

scanHandles in interface net.handle.hdllib.HandleStorage

Throws:

net.handle.hdllib.HandleException

scanNAs

public void scanNAs(net.handle.hdllib.ScanCallback callback)
             throws net.handle.hdllib.HandleException

Scan the NA database, calling a method in the specified callback for every naming authority handle in the database.

Specified by:

scanNAs in interface net.handle.hdllib.HandleStorage

Throws:

net.handle.hdllib.HandleException

getHandlesForNA

public final java.util.Enumeration getHandlesForNA(byte[] naHdl)
                                            throws net.handle.hdllib.HandleException

Scan the database for handles with the given naming authority and return an Enumeration of byte arrays with each byte array being a handle. naHdl is the naming authority handle for the naming authority that you want to list the handles for.

Specified by:

getHandlesForNA in interface net.handle.hdllib.HandleStorage

Throws:

net.handle.hdllib.HandleException

deleteAllRecords

public final void deleteAllRecords()
                            throws net.handle.hdllib.HandleException

Remove all of the records from the database.

Specified by:

deleteAllRecords in interface net.handle.hdllib.HandleStorage

Throws:

net.handle.hdllib.HandleException

checkpointDatabase

public final void checkpointDatabase()
                              throws net.handle.hdllib.HandleException

Copy the current database to a backup file, and restart the transaction log. Returns true if the checkpoint process was *started* (this doesn't mean it was successful).

Specified by:

checkpointDatabase in interface net.handle.hdllib.HandleStorage

Throws:

net.handle.hdllib.HandleException

shutdown

public final void shutdown()

Close the database and clean up

Specified by:

shutdown in interface net.handle.hdllib.HandleStorage

finalize

public void finalize()

Overrides:

finalize in class java.lang.Object