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.Documented;
022import java.lang.annotation.ElementType;
023import java.lang.annotation.Retention;
024import java.lang.annotation.RetentionPolicy;
025import java.lang.annotation.Target;
026
027/**
028 * Requires the current Subject to have been authenticated <em>during their current session</em> for the annotated
029 * class/instance/method to be accessed or invoked.  This is <em>more</em> restrictive than the
030 * {@link RequiresUser RequiresUser} annotation.
031 * <p/>
032 * This annotation basically ensures that
033 * <code>{@link org.apache.shiro.subject.Subject subject}.{@link org.apache.shiro.subject.Subject#isAuthenticated() isAuthenticated()} === true</code>
034 * <p/>
035 * See the {@link RequiresUser RequiresUser} and
036 * {@link org.apache.shiro.authc.RememberMeAuthenticationToken RememberMeAuthenticationToken} JavaDoc for an
037 * explanation of why these two states are considered different.
038 *
039 * @see RequiresUser
040 * @see RequiresGuest
041 *
042 * @since 0.9.0
043 */
044@Target({ElementType.TYPE, ElementType.METHOD})
045@Retention(RetentionPolicy.RUNTIME)
046@Documented
047public @interface RequiresAuthentication {
048}