edu.ucsb.adl.middleware
Interface IdentifiersServiceGatekeeper

All Known Implementing Classes:

BasicPasswordGatekeeper, CombinationGatekeeper, ConstantGatekeeper, IPAddressGatekeeper

public interface IdentifiersServiceGatekeeper

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

public static IdentifiersServiceGatekeeper 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/IdentifiersServiceGatekeeper.java,v 1.1 2006/06/22 18:36:02 gjanee Exp $

$Log: IdentifiersServiceGatekeeper.java,v $ Revision 1.1 2006/06/22 18:36:02 gjanee Initial revision

Author:

Greg Janée
Alexandria Digital Library

Method Summary

void	destroy() Frees any resources held by the gatekeeper.
boolean	identifiersServiceAllowed(javax.servlet.ServletRequest request) Returns true if the request is authorized, that is, if the client is allowed to obtain the identifiers of all items in collections.

Method Detail

identifiersServiceAllowed

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

Returns true if the request is authorized, that is, if the client is allowed to obtain the identifiers of all items in collections. 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:

IdentifiersService

destroy

public void destroy()

Frees any resources held by the gatekeeper.