edu.ucsb.adl.middleware
Class UnloadService

java.lang.Object
  |
  +--edu.ucsb.adl.middleware.UnloadService

public final class UnloadService

extends java.lang.Object

The ADL unload service. This service unloads a collection (i.e., the collection's driver and gatekeeper) from the middleware.

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

unload.gatekeeper.class

The fully-qualified name of the service-level gatekeeper class, e.g., "edu.ucsb.adl.middleware.IPAddressGatekeeper".

unload.gatekeeper.argument

The service-level gatekeeper's startup parameter.

Version:

$Header: /export/home/gjanee/middleware/edu/ucsb/adl/middleware/RCS/UnloadService.java,v 1.4 2006/06/24 06:23:37 gjanee Exp $

$Log: UnloadService.java,v $ Revision 1.4 2006/06/24 06:23:37 gjanee
Added the identifiers service.

Revision 1.3 2004/09/21 23:53:43 gjanee
Minor documentation change.

Revision 1.2 2004/03/05 18:52:05 gjanee
Added support for multiple middleware instances. A middleware instance is represented by a Global object that is tied to a main middleware configuration file. All service objects now maintain a reference to the appropriate Global object. Instance-wide variables formerly coded as class variables are now held by the Global object; various methods that return instance-wide variables now accept a Global object as an argument. The Global object is now passed to all service drivers.

Revision 1.1 2001/09/01 22:23:59 gjanee
Initial revision

Author:

Greg Janée
Alexandria Digital Library

Method Summary

static edu.ucsb.adl.middleware.UnloadService	createService(java.lang.String configurationFile) Creates an UnloadService.
void	destroy() Decrements the reference count.
void	performUnloadService(javax.servlet.ServletRequest request, java.lang.String collection) Performs the ADL unload service.

Methods inherited from class java.lang.Object

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

Method Detail

createService

public static edu.ucsb.adl.middleware.UnloadService createService(java.lang.String configurationFile)
                                                           throws InternalErrorException

Creates an UnloadService. If a service already exists for the configuration file, the extant service's reference count is incremented and it is returned instead.

Parameters:

configurationFile - The filename of a main middleware configuration file.

Throws:

InternalErrorException - If the initialization of the service fails.

performUnloadService

public void performUnloadService(javax.servlet.ServletRequest request,
                                 java.lang.String collection)
                          throws MiddlewareException

Performs the ADL unload service. If the collection is not currently loaded, this method does nothing. This method is multithread-safe.

Parameters:

request - The full request.

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

Throws:

BadRequestException - If request is invalid.

NoAuthorizationException - If the request is valid but not allowed.

InternalErrorException - If the request cannot otherwise be completed.

MiddlewareException

destroy

public void destroy()

Decrements the reference count. When the reference count drops to zero, all resources held by the service are freed.