Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.2.1 / apidocs / src-html / org / apache / shiro / aop / AnnotationMethodInterceptor.html
blob: cc37b2d15231e2d7aafc3c2d2095f045647fd673 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a>
<span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
<span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a>
<span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a>
<span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a>
<span class="sourceLineNo">018</span> */<a name="line.18"></a>
<span class="sourceLineNo">019</span>package org.apache.shiro.aop;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.lang.annotation.Annotation;<a name="line.21"></a>
<span class="sourceLineNo">022</span><a name="line.22"></a>
<span class="sourceLineNo">023</span>/**<a name="line.23"></a>
<span class="sourceLineNo">024</span> * MethodInterceptor that inspects a specific annotation on the method invocation before continuing<a name="line.24"></a>
<span class="sourceLineNo">025</span> * its execution.<a name="line.25"></a>
<span class="sourceLineNo">026</span> * &lt;/p&gt;<a name="line.26"></a>
<span class="sourceLineNo">027</span> * The annotation is acquired from the {@link MethodInvocation MethodInvocation} via a<a name="line.27"></a>
<span class="sourceLineNo">028</span> * {@link AnnotationResolver AnnotationResolver} instance that may be configured. Unless<a name="line.28"></a>
<span class="sourceLineNo">029</span> * overridden, the default {@code AnnotationResolver} is a<a name="line.29"></a>
<span class="sourceLineNo">030</span> *<a name="line.30"></a>
<span class="sourceLineNo">031</span> * @since 0.9<a name="line.31"></a>
<span class="sourceLineNo">032</span> */<a name="line.32"></a>
<span class="sourceLineNo">033</span>public abstract class AnnotationMethodInterceptor extends MethodInterceptorSupport {<a name="line.33"></a>
<span class="sourceLineNo">034</span><a name="line.34"></a>
<span class="sourceLineNo">035</span> private AnnotationHandler handler;<a name="line.35"></a>
<span class="sourceLineNo">036</span><a name="line.36"></a>
<span class="sourceLineNo">037</span> /**<a name="line.37"></a>
<span class="sourceLineNo">038</span> * The resolver to use to find annotations on intercepted methods.<a name="line.38"></a>
<span class="sourceLineNo">039</span> *<a name="line.39"></a>
<span class="sourceLineNo">040</span> * @since 1.1<a name="line.40"></a>
<span class="sourceLineNo">041</span> */<a name="line.41"></a>
<span class="sourceLineNo">042</span> private AnnotationResolver resolver;<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span> /**<a name="line.44"></a>
<span class="sourceLineNo">045</span> * Constructs an &lt;code&gt;AnnotationMethodInterceptor&lt;/code&gt; with the<a name="line.45"></a>
<span class="sourceLineNo">046</span> * {@link AnnotationHandler AnnotationHandler} that will be used to process annotations of a<a name="line.46"></a>
<span class="sourceLineNo">047</span> * corresponding type.<a name="line.47"></a>
<span class="sourceLineNo">048</span> *<a name="line.48"></a>
<span class="sourceLineNo">049</span> * @param handler the handler to delegate to for processing the annotation.<a name="line.49"></a>
<span class="sourceLineNo">050</span> */<a name="line.50"></a>
<span class="sourceLineNo">051</span> public AnnotationMethodInterceptor(AnnotationHandler handler) {<a name="line.51"></a>
<span class="sourceLineNo">052</span> this(handler, new DefaultAnnotationResolver());<a name="line.52"></a>
<span class="sourceLineNo">053</span> }<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span> /**<a name="line.55"></a>
<span class="sourceLineNo">056</span> * Constructs an &lt;code&gt;AnnotationMethodInterceptor&lt;/code&gt; with the<a name="line.56"></a>
<span class="sourceLineNo">057</span> * {@link AnnotationHandler AnnotationHandler} that will be used to process annotations of a<a name="line.57"></a>
<span class="sourceLineNo">058</span> * corresponding type, using the specified {@code AnnotationResolver} to acquire annotations<a name="line.58"></a>
<span class="sourceLineNo">059</span> * at runtime.<a name="line.59"></a>
<span class="sourceLineNo">060</span> *<a name="line.60"></a>
<span class="sourceLineNo">061</span> * @param handler the handler to use to process any discovered annotation<a name="line.61"></a>
<span class="sourceLineNo">062</span> * @param resolver the resolver to use to locate/acquire the annotation<a name="line.62"></a>
<span class="sourceLineNo">063</span> * @since 1.1<a name="line.63"></a>
<span class="sourceLineNo">064</span> */<a name="line.64"></a>
<span class="sourceLineNo">065</span> public AnnotationMethodInterceptor(AnnotationHandler handler, AnnotationResolver resolver) {<a name="line.65"></a>
<span class="sourceLineNo">066</span> if (handler == null) {<a name="line.66"></a>
<span class="sourceLineNo">067</span> throw new IllegalArgumentException("AnnotationHandler argument cannot be null.");<a name="line.67"></a>
<span class="sourceLineNo">068</span> }<a name="line.68"></a>
<span class="sourceLineNo">069</span> setHandler(handler);<a name="line.69"></a>
<span class="sourceLineNo">070</span> setResolver(resolver != null ? resolver : new DefaultAnnotationResolver());<a name="line.70"></a>
<span class="sourceLineNo">071</span> }<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span> /**<a name="line.73"></a>
<span class="sourceLineNo">074</span> * Returns the {@code AnnotationHandler} used to perform authorization behavior based on<a name="line.74"></a>
<span class="sourceLineNo">075</span> * an annotation discovered at runtime.<a name="line.75"></a>
<span class="sourceLineNo">076</span> *<a name="line.76"></a>
<span class="sourceLineNo">077</span> * @return the {@code AnnotationHandler} used to perform authorization behavior based on<a name="line.77"></a>
<span class="sourceLineNo">078</span> * an annotation discovered at runtime.<a name="line.78"></a>
<span class="sourceLineNo">079</span> */<a name="line.79"></a>
<span class="sourceLineNo">080</span> public AnnotationHandler getHandler() {<a name="line.80"></a>
<span class="sourceLineNo">081</span> return handler;<a name="line.81"></a>
<span class="sourceLineNo">082</span> }<a name="line.82"></a>
<span class="sourceLineNo">083</span><a name="line.83"></a>
<span class="sourceLineNo">084</span> /**<a name="line.84"></a>
<span class="sourceLineNo">085</span> * Sets the {@code AnnotationHandler} used to perform authorization behavior based on<a name="line.85"></a>
<span class="sourceLineNo">086</span> * an annotation discovered at runtime.<a name="line.86"></a>
<span class="sourceLineNo">087</span> *<a name="line.87"></a>
<span class="sourceLineNo">088</span> * @param handler the {@code AnnotationHandler} used to perform authorization behavior based on<a name="line.88"></a>
<span class="sourceLineNo">089</span> * an annotation discovered at runtime.<a name="line.89"></a>
<span class="sourceLineNo">090</span> */<a name="line.90"></a>
<span class="sourceLineNo">091</span> public void setHandler(AnnotationHandler handler) {<a name="line.91"></a>
<span class="sourceLineNo">092</span> this.handler = handler;<a name="line.92"></a>
<span class="sourceLineNo">093</span> }<a name="line.93"></a>
<span class="sourceLineNo">094</span><a name="line.94"></a>
<span class="sourceLineNo">095</span> /**<a name="line.95"></a>
<span class="sourceLineNo">096</span> * Returns the {@code AnnotationResolver} to use to acquire annotations from intercepted<a name="line.96"></a>
<span class="sourceLineNo">097</span> * methods at runtime. The annotation is then used by the {@link #getHandler handler} to<a name="line.97"></a>
<span class="sourceLineNo">098</span> * perform authorization logic.<a name="line.98"></a>
<span class="sourceLineNo">099</span> *<a name="line.99"></a>
<span class="sourceLineNo">100</span> * @return the {@code AnnotationResolver} to use to acquire annotations from intercepted<a name="line.100"></a>
<span class="sourceLineNo">101</span> * methods at runtime.<a name="line.101"></a>
<span class="sourceLineNo">102</span> * @since 1.1<a name="line.102"></a>
<span class="sourceLineNo">103</span> */<a name="line.103"></a>
<span class="sourceLineNo">104</span> public AnnotationResolver getResolver() {<a name="line.104"></a>
<span class="sourceLineNo">105</span> return resolver;<a name="line.105"></a>
<span class="sourceLineNo">106</span> }<a name="line.106"></a>
<span class="sourceLineNo">107</span><a name="line.107"></a>
<span class="sourceLineNo">108</span> /**<a name="line.108"></a>
<span class="sourceLineNo">109</span> * Returns the {@code AnnotationResolver} to use to acquire annotations from intercepted<a name="line.109"></a>
<span class="sourceLineNo">110</span> * methods at runtime. The annotation is then used by the {@link #getHandler handler} to<a name="line.110"></a>
<span class="sourceLineNo">111</span> * perform authorization logic.<a name="line.111"></a>
<span class="sourceLineNo">112</span> *<a name="line.112"></a>
<span class="sourceLineNo">113</span> * @param resolver the {@code AnnotationResolver} to use to acquire annotations from intercepted<a name="line.113"></a>
<span class="sourceLineNo">114</span> * methods at runtime.<a name="line.114"></a>
<span class="sourceLineNo">115</span> * @since 1.1<a name="line.115"></a>
<span class="sourceLineNo">116</span> */<a name="line.116"></a>
<span class="sourceLineNo">117</span> public void setResolver(AnnotationResolver resolver) {<a name="line.117"></a>
<span class="sourceLineNo">118</span> this.resolver = resolver;<a name="line.118"></a>
<span class="sourceLineNo">119</span> }<a name="line.119"></a>
<span class="sourceLineNo">120</span><a name="line.120"></a>
<span class="sourceLineNo">121</span> /**<a name="line.121"></a>
<span class="sourceLineNo">122</span> * Returns &lt;code&gt;true&lt;/code&gt; if this interceptor supports, that is, should inspect, the specified<a name="line.122"></a>
<span class="sourceLineNo">123</span> * &lt;code&gt;MethodInvocation&lt;/code&gt;, &lt;code&gt;false&lt;/code&gt; otherwise.<a name="line.123"></a>
<span class="sourceLineNo">124</span> * &lt;p/&gt;<a name="line.124"></a>
<span class="sourceLineNo">125</span> * The default implementation simply does the following:<a name="line.125"></a>
<span class="sourceLineNo">126</span> * &lt;p/&gt;<a name="line.126"></a>
<span class="sourceLineNo">127</span> * &lt;code&gt;return {@link #getAnnotation(MethodInvocation) getAnnotation(mi)} != null&lt;/code&gt;<a name="line.127"></a>
<span class="sourceLineNo">128</span> *<a name="line.128"></a>
<span class="sourceLineNo">129</span> * @param mi the &lt;code&gt;MethodInvocation&lt;/code&gt; for the method being invoked.<a name="line.129"></a>
<span class="sourceLineNo">130</span> * @return &lt;code&gt;true&lt;/code&gt; if this interceptor supports, that is, should inspect, the specified<a name="line.130"></a>
<span class="sourceLineNo">131</span> * &lt;code&gt;MethodInvocation&lt;/code&gt;, &lt;code&gt;false&lt;/code&gt; otherwise.<a name="line.131"></a>
<span class="sourceLineNo">132</span> */<a name="line.132"></a>
<span class="sourceLineNo">133</span> public boolean supports(MethodInvocation mi) {<a name="line.133"></a>
<span class="sourceLineNo">134</span> return getAnnotation(mi) != null;<a name="line.134"></a>
<span class="sourceLineNo">135</span> }<a name="line.135"></a>
<span class="sourceLineNo">136</span><a name="line.136"></a>
<span class="sourceLineNo">137</span> /**<a name="line.137"></a>
<span class="sourceLineNo">138</span> * Returns the Annotation that this interceptor will process for the specified method invocation.<a name="line.138"></a>
<span class="sourceLineNo">139</span> * &lt;p/&gt;<a name="line.139"></a>
<span class="sourceLineNo">140</span> * The default implementation acquires the annotation using an annotation<a name="line.140"></a>
<span class="sourceLineNo">141</span> * {@link #getResolver resolver} using the internal annotation {@link #getHandler handler}'s<a name="line.141"></a>
<span class="sourceLineNo">142</span> * {@link org.apache.shiro.aop.AnnotationHandler#getAnnotationClass() annotationClass}.<a name="line.142"></a>
<span class="sourceLineNo">143</span> *<a name="line.143"></a>
<span class="sourceLineNo">144</span> * @param mi the MethodInvocation wrapping the Method from which the Annotation will be acquired.<a name="line.144"></a>
<span class="sourceLineNo">145</span> * @return the Annotation that this interceptor will process for the specified method invocation.<a name="line.145"></a>
<span class="sourceLineNo">146</span> */<a name="line.146"></a>
<span class="sourceLineNo">147</span> protected Annotation getAnnotation(MethodInvocation mi) {<a name="line.147"></a>
<span class="sourceLineNo">148</span> return getResolver().getAnnotation(mi, getHandler().getAnnotationClass());<a name="line.148"></a>
<span class="sourceLineNo">149</span> }<a name="line.149"></a>
<span class="sourceLineNo">150</span>}<a name="line.150"></a>
</pre>
</div>
</body>
</html>