001// Copyright 2011 The Apache Software Foundation
002//
003// Licensed under the Apache License, Version 2.0 (the "License");
004// you may not use this file except in compliance with the License.
005// You may obtain a copy of the License at
006//
007//     http://www.apache.org/licenses/LICENSE-2.0
008//
009// Unless required by applicable law or agreed to in writing, software
010// distributed under the License is distributed on an "AS IS" BASIS,
011// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012// See the License for the specific language governing permissions and
013// limitations under the License.
014
015package org.apache.tapestry5.services.security;
016
017import org.apache.tapestry5.ioc.annotations.UsesOrderedConfiguration;
018
019/**
020 * Analyzes the current request to see if it is on the whitelist (of clients with access to certain key pages).
021 * This is implemented as a chain-of-command of {@link WhitelistAnalyzer}s.
022 *
023 * @see org.apache.tapestry5.annotations.WhitelistAccessOnly
024 * @since 5.3
025 */
026@UsesOrderedConfiguration(WhitelistAnalyzer.class)
027public interface ClientWhitelist
028{
029    /**
030     * Analyzes the current request, returning true if it is on the whitelist.
031     *
032     */
033    boolean isClientRequestOnWhitelist();
034}