edu.ucsb.adl.middleware
Interface GenericGatekeeper

All Known Implementing Classes:

BasicPasswordGatekeeper, CombinationGatekeeper, ConstantGatekeeper, IPAddressGatekeeper

public interface GenericGatekeeper

An interface that can be implemented by generic gatekeepers, i.e., by gatekeepers whose authorization is computed irrespective of the service being invoked or the collection being operated upon. The gatekeeper is created by dynamically loading the gatekeeper class and calling the following class method:

public static GenericGatekeeper 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/GenericGatekeeper.java,v 1.2 2004/09/21 20:27:00 gjanee Exp $

$Log: GenericGatekeeper.java,v $ Revision 1.2 2004/09/21 20:27:00 gjanee
Minor documentation change.

Revision 1.1 2000/05/19 20:44:01 gjanee
Initial revision

Author:

Greg Janée
Alexandria Digital Library

Method Summary

void	destroy() Frees any resources held by the gatekeeper.
boolean	genericAccessAllowed(javax.servlet.ServletRequest request) Returns true if access is allowed irrespective of the service being invoked or the collection being operated upon.

Method Detail

genericAccessAllowed

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

Returns true if access is allowed irrespective of the service being invoked or the collection being operated upon. This method must be multithread-safe.

Parameters:

request - The full request.

Returns:

true if access is allowed.

Throws:

BadRequestException - If request is not valid.

InternalErrorException - If the authorization cannot otherwise be determined.

MiddlewareException

destroy

public void destroy()

Frees any resources held by the gatekeeper.