edu.ucsb.adl.middleware
Interface ResultsServiceGatekeeper

All Known Implementing Classes:

BasicPasswordGatekeeper, CombinationGatekeeper, ConstantGatekeeper, IPAddressGatekeeper

public interface ResultsServiceGatekeeper

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

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

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

Revision 1.1 1999/10/11 21:27:25 gjanee
Initial revision

Author:

Greg Janée
Alexandria Digital Library

Method Summary

void	destroy() Frees any resources held by the gatekeeper.
boolean	resultsServiceAllowed(javax.servlet.ServletRequest request, edu.ucsb.adl.middleware.ResultSet set) Returns true if the request is authorized, that is, if the client is allowed to access the specified result set.

Method Detail

resultsServiceAllowed

public boolean resultsServiceAllowed(javax.servlet.ServletRequest request,
                                     edu.ucsb.adl.middleware.ResultSet set)
                              throws MiddlewareException

Returns true if the request is authorized, that is, if the client is allowed to access the specified result set. This method must be multithread-safe.

Parameters:

request - The full request.

set - The result set in question.

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:

ResultsService

destroy

public void destroy()

Frees any resources held by the gatekeeper.