| <!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.aop;</a> |
| <span class="sourceLineNo">020</span><a id="line.20"></a> |
| <span class="sourceLineNo">021</span><a id="line.21">import java.lang.annotation.Annotation;</a> |
| <span class="sourceLineNo">022</span><a id="line.22"></a> |
| <span class="sourceLineNo">023</span><a id="line.23">/**</a> |
| <span class="sourceLineNo">024</span><a id="line.24"> * MethodInterceptor that inspects a specific annotation on the method invocation before continuing</a> |
| <span class="sourceLineNo">025</span><a id="line.25"> * its execution.</a> |
| <span class="sourceLineNo">026</span><a id="line.26"> * </p></a> |
| <span class="sourceLineNo">027</span><a id="line.27"> * The annotation is acquired from the {@link MethodInvocation MethodInvocation} via a</a> |
| <span class="sourceLineNo">028</span><a id="line.28"> * {@link AnnotationResolver AnnotationResolver} instance that may be configured. Unless</a> |
| <span class="sourceLineNo">029</span><a id="line.29"> * overridden, the default {@code AnnotationResolver} is a</a> |
| <span class="sourceLineNo">030</span><a id="line.30"> *</a> |
| <span class="sourceLineNo">031</span><a id="line.31"> * @since 0.9</a> |
| <span class="sourceLineNo">032</span><a id="line.32"> */</a> |
| <span class="sourceLineNo">033</span><a id="line.33">public abstract class AnnotationMethodInterceptor extends MethodInterceptorSupport {</a> |
| <span class="sourceLineNo">034</span><a id="line.34"></a> |
| <span class="sourceLineNo">035</span><a id="line.35"> private AnnotationHandler handler;</a> |
| <span class="sourceLineNo">036</span><a id="line.36"></a> |
| <span class="sourceLineNo">037</span><a id="line.37"> /**</a> |
| <span class="sourceLineNo">038</span><a id="line.38"> * The resolver to use to find annotations on intercepted methods.</a> |
| <span class="sourceLineNo">039</span><a id="line.39"> *</a> |
| <span class="sourceLineNo">040</span><a id="line.40"> * @since 1.1</a> |
| <span class="sourceLineNo">041</span><a id="line.41"> */</a> |
| <span class="sourceLineNo">042</span><a id="line.42"> private AnnotationResolver resolver;</a> |
| <span class="sourceLineNo">043</span><a id="line.43"></a> |
| <span class="sourceLineNo">044</span><a id="line.44"> /**</a> |
| <span class="sourceLineNo">045</span><a id="line.45"> * Constructs an <code>AnnotationMethodInterceptor</code> with the</a> |
| <span class="sourceLineNo">046</span><a id="line.46"> * {@link AnnotationHandler AnnotationHandler} that will be used to process annotations of a</a> |
| <span class="sourceLineNo">047</span><a id="line.47"> * corresponding type.</a> |
| <span class="sourceLineNo">048</span><a id="line.48"> *</a> |
| <span class="sourceLineNo">049</span><a id="line.49"> * @param handler the handler to delegate to for processing the annotation.</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> */</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> public AnnotationMethodInterceptor(AnnotationHandler handler) {</a> |
| <span class="sourceLineNo">052</span><a id="line.52"> this(handler, new DefaultAnnotationResolver());</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> }</a> |
| <span class="sourceLineNo">054</span><a id="line.54"></a> |
| <span class="sourceLineNo">055</span><a id="line.55"> /**</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> * Constructs an <code>AnnotationMethodInterceptor</code> with the</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> * {@link AnnotationHandler AnnotationHandler} that will be used to process annotations of a</a> |
| <span class="sourceLineNo">058</span><a id="line.58"> * corresponding type, using the specified {@code AnnotationResolver} to acquire annotations</a> |
| <span class="sourceLineNo">059</span><a id="line.59"> * at runtime.</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> *</a> |
| <span class="sourceLineNo">061</span><a id="line.61"> * @param handler the handler to use to process any discovered annotation</a> |
| <span class="sourceLineNo">062</span><a id="line.62"> * @param resolver the resolver to use to locate/acquire the annotation</a> |
| <span class="sourceLineNo">063</span><a id="line.63"> * @since 1.1</a> |
| <span class="sourceLineNo">064</span><a id="line.64"> */</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> public AnnotationMethodInterceptor(AnnotationHandler handler, AnnotationResolver resolver) {</a> |
| <span class="sourceLineNo">066</span><a id="line.66"> if (handler == null) {</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> throw new IllegalArgumentException("AnnotationHandler argument cannot be null.");</a> |
| <span class="sourceLineNo">068</span><a id="line.68"> }</a> |
| <span class="sourceLineNo">069</span><a id="line.69"> setHandler(handler);</a> |
| <span class="sourceLineNo">070</span><a id="line.70"> setResolver(resolver != null ? resolver : new DefaultAnnotationResolver());</a> |
| <span class="sourceLineNo">071</span><a id="line.71"> }</a> |
| <span class="sourceLineNo">072</span><a id="line.72"></a> |
| <span class="sourceLineNo">073</span><a id="line.73"> /**</a> |
| <span class="sourceLineNo">074</span><a id="line.74"> * Returns the {@code AnnotationHandler} used to perform authorization behavior based on</a> |
| <span class="sourceLineNo">075</span><a id="line.75"> * an annotation discovered at runtime.</a> |
| <span class="sourceLineNo">076</span><a id="line.76"> *</a> |
| <span class="sourceLineNo">077</span><a id="line.77"> * @return the {@code AnnotationHandler} used to perform authorization behavior based on</a> |
| <span class="sourceLineNo">078</span><a id="line.78"> * an annotation discovered at runtime.</a> |
| <span class="sourceLineNo">079</span><a id="line.79"> */</a> |
| <span class="sourceLineNo">080</span><a id="line.80"> public AnnotationHandler getHandler() {</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> return handler;</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"> /**</a> |
| <span class="sourceLineNo">085</span><a id="line.85"> * Sets the {@code AnnotationHandler} used to perform authorization behavior based on</a> |
| <span class="sourceLineNo">086</span><a id="line.86"> * an annotation discovered at runtime.</a> |
| <span class="sourceLineNo">087</span><a id="line.87"> *</a> |
| <span class="sourceLineNo">088</span><a id="line.88"> * @param handler the {@code AnnotationHandler} used to perform authorization behavior based on</a> |
| <span class="sourceLineNo">089</span><a id="line.89"> * an annotation discovered at runtime.</a> |
| <span class="sourceLineNo">090</span><a id="line.90"> */</a> |
| <span class="sourceLineNo">091</span><a id="line.91"> public void setHandler(AnnotationHandler handler) {</a> |
| <span class="sourceLineNo">092</span><a id="line.92"> this.handler = handler;</a> |
| <span class="sourceLineNo">093</span><a id="line.93"> }</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"> * Returns the {@code AnnotationResolver} to use to acquire annotations from intercepted</a> |
| <span class="sourceLineNo">097</span><a id="line.97"> * methods at runtime. The annotation is then used by the {@link #getHandler handler} to</a> |
| <span class="sourceLineNo">098</span><a id="line.98"> * perform authorization logic.</a> |
| <span class="sourceLineNo">099</span><a id="line.99"> *</a> |
| <span class="sourceLineNo">100</span><a id="line.100"> * @return the {@code AnnotationResolver} to use to acquire annotations from intercepted</a> |
| <span class="sourceLineNo">101</span><a id="line.101"> * methods at runtime.</a> |
| <span class="sourceLineNo">102</span><a id="line.102"> * @since 1.1</a> |
| <span class="sourceLineNo">103</span><a id="line.103"> */</a> |
| <span class="sourceLineNo">104</span><a id="line.104"> public AnnotationResolver getResolver() {</a> |
| <span class="sourceLineNo">105</span><a id="line.105"> return resolver;</a> |
| <span class="sourceLineNo">106</span><a id="line.106"> }</a> |
| <span class="sourceLineNo">107</span><a id="line.107"></a> |
| <span class="sourceLineNo">108</span><a id="line.108"> /**</a> |
| <span class="sourceLineNo">109</span><a id="line.109"> * Returns the {@code AnnotationResolver} to use to acquire annotations from intercepted</a> |
| <span class="sourceLineNo">110</span><a id="line.110"> * methods at runtime. The annotation is then used by the {@link #getHandler handler} to</a> |
| <span class="sourceLineNo">111</span><a id="line.111"> * perform authorization logic.</a> |
| <span class="sourceLineNo">112</span><a id="line.112"> *</a> |
| <span class="sourceLineNo">113</span><a id="line.113"> * @param resolver the {@code AnnotationResolver} to use to acquire annotations from intercepted</a> |
| <span class="sourceLineNo">114</span><a id="line.114"> * methods at runtime.</a> |
| <span class="sourceLineNo">115</span><a id="line.115"> * @since 1.1</a> |
| <span class="sourceLineNo">116</span><a id="line.116"> */</a> |
| <span class="sourceLineNo">117</span><a id="line.117"> public void setResolver(AnnotationResolver resolver) {</a> |
| <span class="sourceLineNo">118</span><a id="line.118"> this.resolver = resolver;</a> |
| <span class="sourceLineNo">119</span><a id="line.119"> }</a> |
| <span class="sourceLineNo">120</span><a id="line.120"></a> |
| <span class="sourceLineNo">121</span><a id="line.121"> /**</a> |
| <span class="sourceLineNo">122</span><a id="line.122"> * Returns <code>true</code> if this interceptor supports, that is, should inspect, the specified</a> |
| <span class="sourceLineNo">123</span><a id="line.123"> * <code>MethodInvocation</code>, <code>false</code> otherwise.</a> |
| <span class="sourceLineNo">124</span><a id="line.124"> * <p/></a> |
| <span class="sourceLineNo">125</span><a id="line.125"> * The default implementation simply does the following:</a> |
| <span class="sourceLineNo">126</span><a id="line.126"> * <p/></a> |
| <span class="sourceLineNo">127</span><a id="line.127"> * <code>return {@link #getAnnotation(MethodInvocation) getAnnotation(mi)} != null</code></a> |
| <span class="sourceLineNo">128</span><a id="line.128"> *</a> |
| <span class="sourceLineNo">129</span><a id="line.129"> * @param mi the <code>MethodInvocation</code> for the method being invoked.</a> |
| <span class="sourceLineNo">130</span><a id="line.130"> * @return <code>true</code> if this interceptor supports, that is, should inspect, the specified</a> |
| <span class="sourceLineNo">131</span><a id="line.131"> * <code>MethodInvocation</code>, <code>false</code> otherwise.</a> |
| <span class="sourceLineNo">132</span><a id="line.132"> */</a> |
| <span class="sourceLineNo">133</span><a id="line.133"> public boolean supports(MethodInvocation mi) {</a> |
| <span class="sourceLineNo">134</span><a id="line.134"> return getAnnotation(mi) != null;</a> |
| <span class="sourceLineNo">135</span><a id="line.135"> }</a> |
| <span class="sourceLineNo">136</span><a id="line.136"></a> |
| <span class="sourceLineNo">137</span><a id="line.137"> /**</a> |
| <span class="sourceLineNo">138</span><a id="line.138"> * Returns the Annotation that this interceptor will process for the specified method invocation.</a> |
| <span class="sourceLineNo">139</span><a id="line.139"> * <p/></a> |
| <span class="sourceLineNo">140</span><a id="line.140"> * The default implementation acquires the annotation using an annotation</a> |
| <span class="sourceLineNo">141</span><a id="line.141"> * {@link #getResolver resolver} using the internal annotation {@link #getHandler handler}'s</a> |
| <span class="sourceLineNo">142</span><a id="line.142"> * {@link org.apache.shiro.aop.AnnotationHandler#getAnnotationClass() annotationClass}.</a> |
| <span class="sourceLineNo">143</span><a id="line.143"> *</a> |
| <span class="sourceLineNo">144</span><a id="line.144"> * @param mi the MethodInvocation wrapping the Method from which the Annotation will be acquired.</a> |
| <span class="sourceLineNo">145</span><a id="line.145"> * @return the Annotation that this interceptor will process for the specified method invocation.</a> |
| <span class="sourceLineNo">146</span><a id="line.146"> */</a> |
| <span class="sourceLineNo">147</span><a id="line.147"> protected Annotation getAnnotation(MethodInvocation mi) {</a> |
| <span class="sourceLineNo">148</span><a id="line.148"> return getResolver().getAnnotation(mi, getHandler().getAnnotationClass());</a> |
| <span class="sourceLineNo">149</span><a id="line.149"> }</a> |
| <span class="sourceLineNo">150</span><a id="line.150">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
