ConstantGatekeeper

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

edu.ucsb.adl.middleware
Class ConstantGatekeeper

java.lang.Object
  |
  +--edu.ucsb.adl.middleware.ConstantGatekeeper

All Implemented Interfaces:: CancelServiceGatekeeper, CollectionDriverGatekeeper, CollectionServiceGatekeeper, ConfigurationServiceGatekeeper, GenericGatekeeper, IdentifiersDriverGatekeeper, IdentifiersServiceGatekeeper, MetadataDriverGatekeeper, MetadataServiceGatekeeper, QueryDriverGatekeeper, QueryServiceGatekeeper, ReferenceServiceGatekeeper, ResultsServiceGatekeeper, StatusServiceGatekeeper, UnloadServiceGatekeeper, UnreferenceServiceGatekeeper

public final class ConstantGatekeeper
extends java.lang.Object
implements MetadataServiceGatekeeper, MetadataDriverGatekeeper, QueryServiceGatekeeper, QueryDriverGatekeeper, ResultsServiceGatekeeper, StatusServiceGatekeeper, CancelServiceGatekeeper, ConfigurationServiceGatekeeper, CollectionServiceGatekeeper, CollectionDriverGatekeeper, GenericGatekeeper, UnloadServiceGatekeeper, ReferenceServiceGatekeeper, UnreferenceServiceGatekeeper, IdentifiersServiceGatekeeper, IdentifiersDriverGatekeeper

A simple gatekeeper that implements all gatekeeper interfaces and returns the same, constant value (true or false) on all requests.

Version:

$Header: /export/home/gjanee/middleware/edu/ucsb/adl/middleware/RCS/ConstantGatekeeper.java,v 1.7 2006/06/22 18:49:45 gjanee Exp $

$Log: ConstantGatekeeper.java,v $ Revision 1.7 2006/06/22 18:49:45 gjanee
Added support for the identifiers service.

Revision 1.6 2004/09/21 22:37:14 gjanee
Rewrite to use class ExtendedProperties.

Revision 1.5 2003/05/09 22:35:18 gjanee
Added support for arbitrary, per-collection and per-holding metadata views. Specifically, changed the view argument data type from an enumeration to a string. Added methods viewsServiceAllowed and viewsDriverAllowed.

Revision 1.4 2001/09/05 04:00:23 gjanee
Changed the type of the baseUrl argument of method referenceServiceAllowed from URL to String to support the rmi pseudo-protocol.

Revision 1.3 2001/09/04 18:30:28 gjanee
Added support for UnloadServiceGatekeeper, ReferenceServiceGatekeeper, and UnreferenceServiceGatekeeper.

Revision 1.2 2000/05/19 20:59:09 gjanee
Added support for GenericGatekeeper.

Revision 1.1 2000/04/04 17:56:02 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 the constant return value.

boolean collectionDriverAllowed(javax.servlet.ServletRequest request, java.lang.String collection)
          Returns the constant return value.

boolean collectionServiceAllowed(javax.servlet.ServletRequest request)
          Returns the constant return value.

boolean configurationServiceAllowed(javax.servlet.ServletRequest request)
          Returns the constant return value.

static edu.ucsb.adl.middleware.ConstantGatekeeper createGatekeeper(edu.ucsb.adl.middleware.ExtendedProperties propertyList, java.lang.String returnValue)
          Creates a ConstantGatekeeper.

void destroy()
          Does nothing.

boolean genericAccessAllowed(javax.servlet.ServletRequest request)
          Returns the constant return value.

boolean identifiersDriverAllowed(javax.servlet.ServletRequest request, java.lang.String collection)
          Returns the constant return value.

boolean identifiersServiceAllowed(javax.servlet.ServletRequest request)
          Returns the constant return value.

boolean metadataDriverAllowed(javax.servlet.ServletRequest request, java.lang.String view, java.lang.String collection, java.lang.String holding)
          Returns the constant return value.

boolean metadataServiceAllowed(javax.servlet.ServletRequest request, java.lang.String view)
          Returns the constant return value.

boolean queryDriverAllowed(javax.servlet.ServletRequest request, java.lang.String collection, edu.ucsb.adl.middleware.Query query)
          Returns the constant return value.

boolean queryServiceAllowed(javax.servlet.ServletRequest request, edu.ucsb.adl.middleware.Query query)
          Returns the constant return value.

boolean referenceServiceAllowed(javax.servlet.ServletRequest request, java.lang.String baseUrl, java.lang.String collection)
          Returns the constant return value.

boolean resultsServiceAllowed(javax.servlet.ServletRequest request, edu.ucsb.adl.middleware.ResultSet set)
          Returns the constant return value.

boolean statusServiceAllowed(javax.servlet.ServletRequest request)
          Returns the constant return value.

boolean unloadServiceAllowed(javax.servlet.ServletRequest request, java.lang.String collection)
          Returns the constant return value.

boolean unreferenceServiceAllowed(javax.servlet.ServletRequest request, java.lang.String collection)
          Returns the constant return value.

boolean viewsDriverAllowed(javax.servlet.ServletRequest request, java.lang.String collection, java.lang.String holding)
          Returns the constant return value.

boolean viewsServiceAllowed(javax.servlet.ServletRequest request)
          Returns the constant return value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createGatekeeper

public static edu.ucsb.adl.middleware.ConstantGatekeeper createGatekeeper(edu.ucsb.adl.middleware.ExtendedProperties propertyList,
                                                                          java.lang.String returnValue)
                                                                   throws InternalErrorException

Creates a ConstantGatekeeper.

Parameters:: propertyList - Unused.; returnValue - The constant return value. "yes" ("no") indicates that true (false) should always be returned.
Returns:: A ConstantGatekeeper.
Throws:: InternalErrorException - If returnValue is invalid.