edu.ucsb.adl.middleware
Interface StatusServiceGatekeeper

All Known Implementing Classes:

BasicPasswordGatekeeper, CombinationGatekeeper, ConstantGatekeeper, IPAddressGatekeeper

public interface StatusServiceGatekeeper

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

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

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

Revision 1.1 2000/01/26 00:07:28 gjanee
Initial revision

Author:

Greg Janée
Alexandria Digital Library

Method Summary

void	destroy() Frees any resources held by the gatekeeper.
boolean	statusServiceAllowed(javax.servlet.ServletRequest request) Returns true if the request is authorized, that is, if the client is allowed to view the status of the ADL middleware server.

Method Detail

statusServiceAllowed

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

Returns true if the request is authorized, that is, if the client is allowed to view the status of the ADL middleware server. 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:

StatusService

destroy

public void destroy()

Frees any resources held by the gatekeeper.