View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.shiro.authz.annotation;
20  
21  import java.lang.annotation.ElementType;
22  import java.lang.annotation.Retention;
23  import java.lang.annotation.RetentionPolicy;
24  import java.lang.annotation.Target;
25  
26  /**
27   * Requires the current Subject to be a &quot;guest&quot;, that is, they are not authenticated <em>or</em> remembered
28   * from a previous session for the annotated class/instance/method to be accessed or invoked.
29   * <p/>
30   * This annotation is the logical inverse of the {@link RequiresUser RequiresUser} annotation. That is,
31   * <code>RequiresUser == !RequiresGuest</code>, or more accurately,
32   * <p/>
33   * <code>RequiresGuest === subject.{@link org.apache.shiro.subject.Subject#getPrincipal() getPrincipal()} == null</code>.
34   *
35   * @see RequiresAuthentication
36   * @see RequiresUser
37   *
38   * @since 0.9.0
39   */
40  @Target({ElementType.TYPE, ElementType.METHOD})
41  @Retention(RetentionPolicy.RUNTIME)
42  public @interface RequiresGuest {
43  }