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 java.lang.reflect.Method;
22  
23  /**
24   * 3rd-party API independent representation of a method invocation.  This is needed so Shiro can support other
25   * MethodInvocation instances from other AOP frameworks/APIs.
26   *
27   * @since 0.1
28   */
29  public interface MethodInvocation {
30  
31      /**
32       * Continues the method invocation chain, or if the last in the chain, the method itself.
33       *
34       * @return the result of the Method invocation.
35       * @throws Throwable if the method or chain throws a Throwable
36       */
37      Object proceed() throws Throwable;
38  
39      /**
40       * Returns the actual {@link Method Method} to be invoked.
41       *
42       * @return the actual {@link Method Method} to be invoked.
43       */
44      Method getMethod();
45  
46      /**
47       * Returns the (possibly null) arguments to be supplied to the method invocation.
48       *
49       * @return the (possibly null) arguments to be supplied to the method invocation.
50       */
51      Object[] getArguments();
52  
53      /**
54       * Returns the object that holds the current joinpoint's static part.
55       * For instance, the target object for an invocation.
56       *
57       * @return the object that holds the current joinpoint's static part.
58       * @since 1.0
59       */
60      Object getThis();
61  
62  
63  }
64