edu.ucsb.adl.middleware
Interface ConfigurationServiceGatekeeper

All Known Implementing Classes:

BasicPasswordGatekeeper, CombinationGatekeeper, ConstantGatekeeper, IPAddressGatekeeper

public interface ConfigurationServiceGatekeeper

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

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

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

Revision 1.1 2000/04/04 17:24:30 gjanee
Initial revision

Author:

Greg Janée
Alexandria Digital Library

Method Summary

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

Method Detail

configurationServiceAllowed

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

Returns true if the request is authorized, that is, if the client is allowed to view the configuration 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:

ConfigurationService

destroy

public void destroy()

Frees any resources held by the gatekeeper.