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.aop;
20  
21  import java.lang.annotation.Annotation;
22  
23  import org.apache.shiro.authz.UnauthenticatedException;
24  import org.apache.shiro.authz.annotation.RequiresAuthentication;
25  
26  
27  /**
28   * Handles {@link RequiresAuthentication RequiresAuthentication} annotations and ensures the calling subject is
29   * authenticated before allowing access.
30   *
31   * @since 0.9.0
32   */
33  public class AuthenticatedAnnotationHandler extends AuthorizingAnnotationHandler {
34  
35      /**
36       * Default no-argument constructor that ensures this handler to process
37       * {@link org.apache.shiro.authz.annotation.RequiresAuthentication RequiresAuthentication} annotations.
38       */
39      public AuthenticatedAnnotationHandler() {
40          super(RequiresAuthentication.class);
41      }
42  
43      /**
44       * Ensures that the calling <code>Subject</code> is authenticated, and if not, throws an
45       * {@link org.apache.shiro.authz.UnauthenticatedException UnauthenticatedException} indicating the method is not allowed to be executed.
46       *
47       * @param a the annotation to inspect
48       * @throws org.apache.shiro.authz.UnauthenticatedException if the calling <code>Subject</code> has not yet
49       * authenticated.
50       */
51      public void assertAuthorized(Annotation a) throws UnauthenticatedException {
52          if (a instanceof RequiresAuthentication && !getSubject().isAuthenticated() ) {
53              throw new UnauthenticatedException( "The current Subject is not authenticated.  Access denied." );
54          }
55      }
56  }