001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.shiro.authz.annotation;
020
021import java.lang.annotation.ElementType;
022import java.lang.annotation.Retention;
023import java.lang.annotation.RetentionPolicy;
024import java.lang.annotation.Target;
025
026/**
027 * Requires the current Subject to have been authenticated <em>during their current session</em> for the annotated
028 * class/instance/method to be accessed or invoked.  This is <em>more</em> restrictive than the
029 * {@link RequiresUser RequiresUser} annotation.
030 * <p/>
031 * This annotation basically ensures that
032 * <code>{@link org.apache.shiro.subject.Subject subject}.{@link org.apache.shiro.subject.Subject#isAuthenticated() isAuthenticated()} === true</code>
033 * <p/>
034 * See the {@link RequiresUser RequiresUser} and
035 * {@link org.apache.shiro.authc.RememberMeAuthenticationToken RememberMeAuthenticationToken} JavaDoc for an
036 * explaination of why these two states are considered different.
037 *
038 * @see RequiresUser
039 * @see RequiresGuest
040 *
041 * @since 0.9.0
042 */
043@Target({ElementType.TYPE, ElementType.METHOD})
044@Retention(RetentionPolicy.RUNTIME)
045public @interface RequiresAuthentication {
046}