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