Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.10.0 / shiro-support / shiro-aspectj / apidocs / src-html / org / apache / shiro / aspectj / BeforeAdviceMethodInvocationAdapter.html
blob: ee4334c8dabd608ee6b8b7ed7d7db145b752df77 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<main role="main">
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a id="line.1">/*</a>
<span class="sourceLineNo">002</span><a id="line.2"> * Licensed to the Apache Software Foundation (ASF) under one</a>
<span class="sourceLineNo">003</span><a id="line.3"> * or more contributor license agreements. See the NOTICE file</a>
<span class="sourceLineNo">004</span><a id="line.4"> * distributed with this work for additional information</a>
<span class="sourceLineNo">005</span><a id="line.5"> * regarding copyright ownership. The ASF licenses this file</a>
<span class="sourceLineNo">006</span><a id="line.6"> * to you under the Apache License, Version 2.0 (the</a>
<span class="sourceLineNo">007</span><a id="line.7"> * "License"); you may not use this file except in compliance</a>
<span class="sourceLineNo">008</span><a id="line.8"> * with the License. You may obtain a copy of the License at</a>
<span class="sourceLineNo">009</span><a id="line.9"> *</a>
<span class="sourceLineNo">010</span><a id="line.10"> * http://www.apache.org/licenses/LICENSE-2.0</a>
<span class="sourceLineNo">011</span><a id="line.11"> *</a>
<span class="sourceLineNo">012</span><a id="line.12"> * Unless required by applicable law or agreed to in writing,</a>
<span class="sourceLineNo">013</span><a id="line.13"> * software distributed under the License is distributed on an</a>
<span class="sourceLineNo">014</span><a id="line.14"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a>
<span class="sourceLineNo">015</span><a id="line.15"> * KIND, either express or implied. See the License for the</a>
<span class="sourceLineNo">016</span><a id="line.16"> * specific language governing permissions and limitations</a>
<span class="sourceLineNo">017</span><a id="line.17"> * under the License.</a>
<span class="sourceLineNo">018</span><a id="line.18"> */</a>
<span class="sourceLineNo">019</span><a id="line.19">package org.apache.shiro.aspectj;</a>
<span class="sourceLineNo">020</span><a id="line.20"></a>
<span class="sourceLineNo">021</span><a id="line.21">import org.apache.shiro.aop.MethodInvocation;</a>
<span class="sourceLineNo">022</span><a id="line.22">import org.aspectj.lang.JoinPoint;</a>
<span class="sourceLineNo">023</span><a id="line.23">import org.aspectj.lang.reflect.AdviceSignature;</a>
<span class="sourceLineNo">024</span><a id="line.24">import org.aspectj.lang.reflect.MethodSignature;</a>
<span class="sourceLineNo">025</span><a id="line.25"></a>
<span class="sourceLineNo">026</span><a id="line.26">import java.lang.reflect.Method;</a>
<span class="sourceLineNo">027</span><a id="line.27"></a>
<span class="sourceLineNo">028</span><a id="line.28">/**</a>
<span class="sourceLineNo">029</span><a id="line.29"> * Helper class that adapts an AspectJ {@link JoinPoint JoinPoint}.</a>
<span class="sourceLineNo">030</span><a id="line.30"> *</a>
<span class="sourceLineNo">031</span><a id="line.31"> * @since 1.0</a>
<span class="sourceLineNo">032</span><a id="line.32"> */</a>
<span class="sourceLineNo">033</span><a id="line.33">public class BeforeAdviceMethodInvocationAdapter implements MethodInvocation {</a>
<span class="sourceLineNo">034</span><a id="line.34"></a>
<span class="sourceLineNo">035</span><a id="line.35"> private Object _object;</a>
<span class="sourceLineNo">036</span><a id="line.36"> private Method _method;</a>
<span class="sourceLineNo">037</span><a id="line.37"> private Object[] _arguments;</a>
<span class="sourceLineNo">038</span><a id="line.38"></a>
<span class="sourceLineNo">039</span><a id="line.39"> /**</a>
<span class="sourceLineNo">040</span><a id="line.40"> * Factory method that creates a new {@link BeforeAdviceMethodInvocationAdapter} instance</a>
<span class="sourceLineNo">041</span><a id="line.41"> * using the AspectJ {@link JoinPoint} provided. If the joint point passed in is not</a>
<span class="sourceLineNo">042</span><a id="line.42"> * a method joint point, this method throws an {@link IllegalArgumentException}.</a>
<span class="sourceLineNo">043</span><a id="line.43"> *</a>
<span class="sourceLineNo">044</span><a id="line.44"> * @param aJoinPoint The AspectJ {@link JoinPoint} to use to adapt the advice.</a>
<span class="sourceLineNo">045</span><a id="line.45"> * @return The created instance.</a>
<span class="sourceLineNo">046</span><a id="line.46"> * @throws IllegalArgumentException If the join point passed in does not involve a method call.</a>
<span class="sourceLineNo">047</span><a id="line.47"> */</a>
<span class="sourceLineNo">048</span><a id="line.48"> public static BeforeAdviceMethodInvocationAdapter createFrom(JoinPoint aJoinPoint) {</a>
<span class="sourceLineNo">049</span><a id="line.49"> if (aJoinPoint.getSignature() instanceof MethodSignature) {</a>
<span class="sourceLineNo">050</span><a id="line.50"> return new BeforeAdviceMethodInvocationAdapter(aJoinPoint.getThis(),</a>
<span class="sourceLineNo">051</span><a id="line.51"> ((MethodSignature) aJoinPoint.getSignature()).getMethod(),</a>
<span class="sourceLineNo">052</span><a id="line.52"> aJoinPoint.getArgs());</a>
<span class="sourceLineNo">053</span><a id="line.53"></a>
<span class="sourceLineNo">054</span><a id="line.54"> } else if (aJoinPoint.getSignature() instanceof AdviceSignature) {</a>
<span class="sourceLineNo">055</span><a id="line.55"> return new BeforeAdviceMethodInvocationAdapter(aJoinPoint.getThis(),</a>
<span class="sourceLineNo">056</span><a id="line.56"> ((AdviceSignature) aJoinPoint.getSignature()).getAdvice(),</a>
<span class="sourceLineNo">057</span><a id="line.57"> aJoinPoint.getArgs());</a>
<span class="sourceLineNo">058</span><a id="line.58"></a>
<span class="sourceLineNo">059</span><a id="line.59"> } else {</a>
<span class="sourceLineNo">060</span><a id="line.60"> throw new IllegalArgumentException("The joint point signature is invalid: expected a MethodSignature or an AdviceSignature but was " + aJoinPoint.getSignature());</a>
<span class="sourceLineNo">061</span><a id="line.61"> }</a>
<span class="sourceLineNo">062</span><a id="line.62"> }</a>
<span class="sourceLineNo">063</span><a id="line.63"></a>
<span class="sourceLineNo">064</span><a id="line.64"> /**</a>
<span class="sourceLineNo">065</span><a id="line.65"> * Creates a new {@link BeforeAdviceMethodInvocationAdapter} instance.</a>
<span class="sourceLineNo">066</span><a id="line.66"> *</a>
<span class="sourceLineNo">067</span><a id="line.67"> * @param aMethod The method to invoke.</a>
<span class="sourceLineNo">068</span><a id="line.68"> * @param someArguments The arguments of the method invocation.</a>
<span class="sourceLineNo">069</span><a id="line.69"> */</a>
<span class="sourceLineNo">070</span><a id="line.70"> public BeforeAdviceMethodInvocationAdapter(Object anObject, Method aMethod, Object[] someArguments) {</a>
<span class="sourceLineNo">071</span><a id="line.71"> _object = anObject;</a>
<span class="sourceLineNo">072</span><a id="line.72"> _method = aMethod;</a>
<span class="sourceLineNo">073</span><a id="line.73"> _arguments = someArguments;</a>
<span class="sourceLineNo">074</span><a id="line.74"> }</a>
<span class="sourceLineNo">075</span><a id="line.75"></a>
<span class="sourceLineNo">076</span><a id="line.76"> /* (non-Javadoc)</a>
<span class="sourceLineNo">077</span><a id="line.77"> * @see org.apache.shiro.aop.MethodInvocation#getArguments()</a>
<span class="sourceLineNo">078</span><a id="line.78"> */</a>
<span class="sourceLineNo">079</span><a id="line.79"></a>
<span class="sourceLineNo">080</span><a id="line.80"> public Object[] getArguments() {</a>
<span class="sourceLineNo">081</span><a id="line.81"> return _arguments;</a>
<span class="sourceLineNo">082</span><a id="line.82"> }</a>
<span class="sourceLineNo">083</span><a id="line.83"></a>
<span class="sourceLineNo">084</span><a id="line.84"> /* (non-Javadoc)</a>
<span class="sourceLineNo">085</span><a id="line.85"> * @see org.apache.shiro.aop.MethodInvocation#getMethod()</a>
<span class="sourceLineNo">086</span><a id="line.86"> */</a>
<span class="sourceLineNo">087</span><a id="line.87"></a>
<span class="sourceLineNo">088</span><a id="line.88"> public Method getMethod() {</a>
<span class="sourceLineNo">089</span><a id="line.89"> return _method;</a>
<span class="sourceLineNo">090</span><a id="line.90"> }</a>
<span class="sourceLineNo">091</span><a id="line.91"></a>
<span class="sourceLineNo">092</span><a id="line.92"> /* (non-Javadoc)</a>
<span class="sourceLineNo">093</span><a id="line.93"> * @see org.apache.shiro.aop.MethodInvocation#proceed()</a>
<span class="sourceLineNo">094</span><a id="line.94"> */</a>
<span class="sourceLineNo">095</span><a id="line.95"></a>
<span class="sourceLineNo">096</span><a id="line.96"> public Object proceed() throws Throwable {</a>
<span class="sourceLineNo">097</span><a id="line.97"> // Do nothing since this adapts a before advice</a>
<span class="sourceLineNo">098</span><a id="line.98"> return null;</a>
<span class="sourceLineNo">099</span><a id="line.99"> }</a>
<span class="sourceLineNo">100</span><a id="line.100"></a>
<span class="sourceLineNo">101</span><a id="line.101"> /**</a>
<span class="sourceLineNo">102</span><a id="line.102"> * @since 1.0</a>
<span class="sourceLineNo">103</span><a id="line.103"> */</a>
<span class="sourceLineNo">104</span><a id="line.104"> public Object getThis() {</a>
<span class="sourceLineNo">105</span><a id="line.105"> return _object;</a>
<span class="sourceLineNo">106</span><a id="line.106"> }</a>
<span class="sourceLineNo">107</span><a id="line.107">}</a>
</pre>
</div>
</main>
</body>
</html>