edu.ucsb.adl.middleware
Interface CancelServiceGatekeeper

All Known Implementing Classes:

BasicPasswordGatekeeper, CombinationGatekeeper, ConstantGatekeeper, IPAddressGatekeeper

public interface CancelServiceGatekeeper

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

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

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

Revision 1.1 2000/01/30 19:57:06 gjanee
Initial revision

Author:

Greg Janée
Alexandria Digital Library

Method Summary

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

Method Detail

cancelServiceAllowed

public boolean cancelServiceAllowed(javax.servlet.ServletRequest request,
                                    edu.ucsb.adl.middleware.ResultAccumulator accumulator)
                             throws MiddlewareException

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

Parameters:

request - The full request.

accumulator - The result accumulator 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:

CancelService

destroy

public void destroy()

Frees any resources held by the gatekeeper.