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