edu.ucsb.adl.middleware
Interface CollectionServiceGatekeeper

All Known Implementing Classes:

BasicPasswordGatekeeper, CombinationGatekeeper, ConstantGatekeeper, IPAddressGatekeeper

public interface CollectionServiceGatekeeper

The interface between the ADL collection service and the gatekeeper that controls access to the service. The ADL collection service creates the gatekeeper by dynamically loading the gatekeeper class and calling the following class method:

public static CollectionServiceGatekeeper createGatekeeper (
    ExtendedProperties propertyList, String argument)

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

Version:

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

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

Revision 1.1 2000/04/04 17:34:50 gjanee
Initial revision

Author:

Greg Janée
Alexandria Digital Library

Method Summary

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

Method Detail

collectionServiceAllowed

public boolean collectionServiceAllowed(javax.servlet.ServletRequest request)
                                 throws MiddlewareException

Returns true if the request is authorized, that is, if the client is allowed to view collection-level metadata. This method must be multithread-safe.

Parameters:

request - The full request.

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.