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