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 be an application <em>user</em> for the annotated class/instance/method to be
029 * accessed or invoked.  This is <em>less</em> restrictive than the {@link RequiresAuthentication RequiresAuthentication}
030 * annotation.
031 * <p/>
032 * Shiro defines a &quot;user&quot; as a Subject that is either
033 * &quot;remembered&quot; <b><em>or</em></b> authenticated:
034 * <ul>
035 * <li>An <b>authenticated</b> user is a Subject that has successfully logged in (proven their identity)
036 * <em>during their current session</em>.</li>
037 * <li>A <b>remembered</b> user is any Subject that has proven their identity at least once, although not necessarily
038 * during their current session, and asked the system to remember them.</li>
039 * </ul>
040 * <p/>
041 * See the {@link org.apache.shiro.authc.RememberMeAuthenticationToken RememberMeAuthenticationToken} JavaDoc for an
042 * explanation of why these two states are considered different.
043 *
044 * @see RequiresAuthentication
045 * @see RequiresGuest
046 *
047 * @since 0.9.0
048 */
049@Target({ElementType.TYPE, ElementType.METHOD})
050@Retention(RetentionPolicy.RUNTIME)
051@Documented
052public @interface RequiresUser {
053}