edu.ucsb.adl.middleware
Interface QueryServiceGatekeeper

All Known Implementing Classes:

BasicPasswordGatekeeper, CombinationGatekeeper, ConstantGatekeeper, IPAddressGatekeeper

public interface QueryServiceGatekeeper

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

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

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

Revision 1.1 1999/10/25 20:20:54 gjanee
Initial revision

Author:

Greg Janée
Alexandria Digital Library

Method Summary

void	destroy() Frees any resources held by the gatekeeper.
boolean	queryServiceAllowed(javax.servlet.ServletRequest request, edu.ucsb.adl.middleware.Query query) Returns true if the request is authorized, that is, if the client is allowed to submit the given query.

Method Detail

queryServiceAllowed

public boolean queryServiceAllowed(javax.servlet.ServletRequest request,
                                   edu.ucsb.adl.middleware.Query query)
                            throws MiddlewareException

Returns true if the request is authorized, that is, if the client is allowed to submit the given query. This method must be multithread-safe.

Parameters:

request - The full request.

query - The query.

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:

QueryService

destroy

public void destroy()

Frees any resources held by the gatekeeper.