edu.ucsb.adl.middleware.rmi
Class IdentifiersDriver

java.lang.Object
  |
  +--edu.ucsb.adl.middleware.rmi.IdentifiersDriver

All Implemented Interfaces:

IdentifiersDriver

public final class IdentifiersDriver

extends java.lang.Object

implements IdentifiersDriver

Proxy driver for the ADL identifiers service. This driver establishes an RMI connection to a remote middleware server and thereby provides access to a (single) remote collection.

This class reads the following properties from the RMI proxy driver configuration file rmi-proxy-driver.conf. Property values may be indirectly specified using the notation @P where P is the name of another property (see ExtendedProperties for more information).

remote_collection_name

The name of the remote collection, e.g., "adl_catalog".

registry

The URL of the RMI registry to use, e.g., "rmi://piru.alexandria.ucsb.edu".

identifiers.name

The RMI name of the remote identifiers service, e.g., "/edu/ucsb/adl/middleware/rmi/IdentifiersService".

Version:

$Header: /export/home/gjanee/middleware/edu/ucsb/adl/middleware/rmi/RCS/IdentifiersDriver.java,v 1.1 2006/06/24 22:00:17 gjanee Exp $

$Log: IdentifiersDriver.java,v $ Revision 1.1 2006/06/24 22:00:17 gjanee Initial revision

Author:

Greg Janée
Alexandria Digital Library

Method Summary

static edu.ucsb.adl.middleware.rmi.IdentifiersDriver	createDriver(edu.ucsb.adl.middleware.Global global, java.io.File directory, java.lang.String collection) Creates an IdentifiersDriver for a collection.
void	destroy() Frees all resources held by the driver.
java.util.Vector	performIdentifiersService(java.lang.String collection) Performs the ADL identifiers service, i.e., returns the identifiers of all items in the collection.

Methods inherited from class java.lang.Object

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

Method Detail

createDriver

public static edu.ucsb.adl.middleware.rmi.IdentifiersDriver createDriver(edu.ucsb.adl.middleware.Global global,
                                                                         java.io.File directory,
                                                                         java.lang.String collection)
                                                                  throws InternalErrorException

Creates an IdentifiersDriver for a collection.

Parameters:

global - Unused.

directory - The pathname of the directory containing the RMI proxy driver configuration file.

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

Returns:

An IdentifiersDriver.

Throws:

InternalErrorException - If any error is encountered.

performIdentifiersService

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

Performs the ADL identifiers service, i.e., returns the identifiers of all items in the collection. This method is threadsafe.

Specified by:

performIdentifiersService in interface IdentifiersDriver

Parameters:

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

Returns:

A vector of string identifiers.

Throws:

InternalErrorException - If any error occurs.

See Also:

IdentifiersService

destroy

public void destroy()

Frees all resources held by the driver.

Specified by:

destroy in interface IdentifiersDriver