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.aop;
20  
21  import org.apache.shiro.SecurityUtils;
22  import org.apache.shiro.subject.Subject;
23  
24  
25  /**
26   * This class is an abstraction of AOP method interceptor behavior specific to Shiro that
27   * leaves AOP implementation specifics to be handled by subclass implementations.  This implementation primarily
28   * enables a <tt>Log</tt> and makes available the currently executing {@link Subject Subject}.
29   *
30   * @since 0.2
31   */
32  public abstract class MethodInterceptorSupport implements MethodInterceptor {
33  
34      /**
35       * Default no-argument constructor for subclasses.
36       */
37      public MethodInterceptorSupport() {
38      }
39  
40      /**
41       * Returns the {@link Subject Subject} associated with the currently-executing code.
42       * <p/>
43       * This default implementation merely calls <code>{@link org.apache.shiro.SecurityUtils#getSubject SecurityUtils.getSubject()}</code>.
44       *
45       * @return the {@link org.apache.shiro.subject.Subject Subject} associated with the currently-executing code.
46       */
47      protected Subject getSubject() {
48          return SecurityUtils.getSubject();
49      }
50  }