    001// Copyright 2011, 2013 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.annotations;
    016
    017import org.apache.tapestry5.ioc.annotations.AnnotationUseContext;
    018import org.apache.tapestry5.ioc.annotations.UseWith;
    019
    020import java.lang.annotation.Documented;
    021import java.lang.annotation.Retention;
    022import java.lang.annotation.Target;
    023
    024import static java.lang.annotation.ElementType.TYPE;
    025import static java.lang.annotation.RetentionPolicy.RUNTIME;
    026
    027/**
    028 * Identifies a page that should only be accessed from clients on the whitelist. This is used for
    029 * the  built-in {@link org.apache.tapestry5.corelib.pages.T5Dashboard} page, but can also be used in application pages.
    030 * <p/>
    031 * Tapestry does its best to make a request to a whitelist-only page that is accessed from a client not on the whitelist
    032 * appear to behave as if the page does not exist at all.
    033 *
    034 * @see org.apache.tapestry5.MetaDataConstants#WHITELIST_ONLY_PAGE
    035 * @see org.apache.tapestry5.services.security.ClientWhitelist
    036 * @since 5.3
    037 */
    038@Target(TYPE)
    039@Retention(RUNTIME)
    040@Documented
    041@UseWith(AnnotationUseContext.PAGE)
    042public @interface WhitelistAccessOnly
    043{
    044}