edu.ucsb.adl.middleware
Interface IdentifiersDriver

All Known Implementing Classes:

IdentifiersDriver, IdentifiersDriver

public interface IdentifiersDriver

The interface between the ADL identifiers service and drivers that implement the service on behalf of collections. The ADL identifiers service creates the driver for a collection by dynamically loading the driver class and calling the following class method:

public static IdentifiersDriver createDriver (Global global,
                                              File directory,
                                              String collection)

Driver configuration files can be obtained from directory. collection is the name of the collection, e.g., "adl_catalog". global is the global object representing this instance of the middleware; it can be used to store global quantities.

Version:

$Header: /export/home/gjanee/middleware/edu/ucsb/adl/middleware/RCS/IdentifiersDriver.java,v 1.1 2006/06/22 18:35:46 gjanee Exp $

$Log: IdentifiersDriver.java,v $ Revision 1.1 2006/06/22 18:35:46 gjanee Initial revision

Author:

Greg Janée
Alexandria Digital Library

Method Summary

void	destroy() Frees any resources held by the driver.
java.util.Vector	performIdentifiersService(java.lang.String collection) Returns the identifiers of all items in the collection.

Method Detail

performIdentifiersService

public java.util.Vector performIdentifiersService(java.lang.String collection)
                                           throws InternalErrorException

Returns the identifiers of all items in the collection. The driver can assume that the request has been authorized and that collection names the collection for which the driver was created. This method must be multithread-safe.

Parameters:

collection - The collection name, e.g., "adl_catalog".

Returns:

A vector of strings.

Throws:

InternalErrorException - If any error occurs.

See Also:

IdentifiersService

destroy

public void destroy()

Frees any resources held by the driver.