edu.ucsb.adl.middleware
Interface CollectionDriverGatekeeper

All Known Implementing Classes:

BasicPasswordGatekeeper, CombinationGatekeeper, ConstantGatekeeper, IPAddressGatekeeper

public interface CollectionDriverGatekeeper

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

public static CollectionDriverGatekeeper createGatekeeper (
    ExtendedProperties propertyList, String argument)

Gatekeeper startup parameters can be obtained from propertyList. argument is an additional, gatekeeper- and/or collection-specific startup parameter.

Version:

$Header: /export/home/gjanee/middleware/edu/ucsb/adl/middleware/RCS/CollectionDriverGatekeeper.java,v 1.2 2004/09/21 18:22:27 gjanee Exp $

$Log: CollectionDriverGatekeeper.java,v $ Revision 1.2 2004/09/21 18:22:27 gjanee
Minor documentation change.

Revision 1.1 2000/04/04 17:46:41 gjanee
Initial revision

Author:

Greg Janée
Alexandria Digital Library

Method Summary

boolean	collectionDriverAllowed(javax.servlet.ServletRequest request, java.lang.String collection) Returns true if the request is authorized, that is, if the client is allowed to view the collection-level metadata for a collection.
void	destroy() Frees any resources held by the gatekeeper.

Method Detail

collectionDriverAllowed

public boolean collectionDriverAllowed(javax.servlet.ServletRequest request,
                                       java.lang.String collection)
                                throws MiddlewareException

Returns true if the request is authorized, that is, if the client is allowed to view the collection-level metadata for a collection. The gatekeeper can assume that collection names the collection for which the gatekeeper was created. This method must be multithread-safe.

Parameters:

request - The full request.

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

Returns:

true if the request is authorized.

Throws:

BadRequestException - If request is not valid.

InternalErrorException - If the authorization cannot otherwise be determined.

MiddlewareException

See Also:

CollectionService

destroy

public void destroy()

Frees any resources held by the gatekeeper.