| <!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.event.support;</a> |
| <span class="sourceLineNo">020</span><a id="line.20"></a> |
| <span class="sourceLineNo">021</span><a id="line.21">import org.apache.shiro.event.Subscribe;</a> |
| <span class="sourceLineNo">022</span><a id="line.22">import org.apache.shiro.util.ClassUtils;</a> |
| <span class="sourceLineNo">023</span><a id="line.23"></a> |
| <span class="sourceLineNo">024</span><a id="line.24">import java.lang.annotation.Annotation;</a> |
| <span class="sourceLineNo">025</span><a id="line.25">import java.lang.reflect.Method;</a> |
| <span class="sourceLineNo">026</span><a id="line.26">import java.util.ArrayList;</a> |
| <span class="sourceLineNo">027</span><a id="line.27">import java.util.Collections;</a> |
| <span class="sourceLineNo">028</span><a id="line.28">import java.util.List;</a> |
| <span class="sourceLineNo">029</span><a id="line.29"></a> |
| <span class="sourceLineNo">030</span><a id="line.30">/**</a> |
| <span class="sourceLineNo">031</span><a id="line.31"> * Inspects an object for annotated methods of interest and creates an {@link EventListener} instance for each method</a> |
| <span class="sourceLineNo">032</span><a id="line.32"> * discovered. An event bus will call the resulting listeners as relevant events arrive.</a> |
| <span class="sourceLineNo">033</span><a id="line.33"> * <p/></a> |
| <span class="sourceLineNo">034</span><a id="line.34"> * The default {@link #setAnnotationClass(Class) annotationClass} is {@link Subscribe}, indicating each</a> |
| <span class="sourceLineNo">035</span><a id="line.35"> * {@link Subscribe}-annotated method will be represented as an EventListener.</a> |
| <span class="sourceLineNo">036</span><a id="line.36"> *</a> |
| <span class="sourceLineNo">037</span><a id="line.37"> * @see SingleArgumentMethodEventListener</a> |
| <span class="sourceLineNo">038</span><a id="line.38"> * @since 1.3</a> |
| <span class="sourceLineNo">039</span><a id="line.39"> */</a> |
| <span class="sourceLineNo">040</span><a id="line.40">public class AnnotationEventListenerResolver implements EventListenerResolver {</a> |
| <span class="sourceLineNo">041</span><a id="line.41"></a> |
| <span class="sourceLineNo">042</span><a id="line.42"> private Class<? extends Annotation> annotationClass;</a> |
| <span class="sourceLineNo">043</span><a id="line.43"></a> |
| <span class="sourceLineNo">044</span><a id="line.44"> public AnnotationEventListenerResolver() {</a> |
| <span class="sourceLineNo">045</span><a id="line.45"> this.annotationClass = Subscribe.class;</a> |
| <span class="sourceLineNo">046</span><a id="line.46"> }</a> |
| <span class="sourceLineNo">047</span><a id="line.47"></a> |
| <span class="sourceLineNo">048</span><a id="line.48"> /**</a> |
| <span class="sourceLineNo">049</span><a id="line.49"> * Returns a new collection of {@link EventListener} instances, each instance corresponding to an annotated</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> * method discovered on the specified {@code instance} argument.</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> *</a> |
| <span class="sourceLineNo">052</span><a id="line.52"> * @param instance the instance to inspect for annotated event handler methods.</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> * @return a new collection of {@link EventListener} instances, each instance corresponding to an annotated</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> * method discovered on the specified {@code instance} argument.</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> */</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> public List<EventListener> getEventListeners(Object instance) {</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> if (instance == null) {</a> |
| <span class="sourceLineNo">058</span><a id="line.58"> return Collections.emptyList();</a> |
| <span class="sourceLineNo">059</span><a id="line.59"> }</a> |
| <span class="sourceLineNo">060</span><a id="line.60"></a> |
| <span class="sourceLineNo">061</span><a id="line.61"> List<Method> methods = ClassUtils.getAnnotatedMethods(instance.getClass(), getAnnotationClass());</a> |
| <span class="sourceLineNo">062</span><a id="line.62"> if (methods == null || methods.isEmpty()) {</a> |
| <span class="sourceLineNo">063</span><a id="line.63"> return Collections.emptyList();</a> |
| <span class="sourceLineNo">064</span><a id="line.64"> }</a> |
| <span class="sourceLineNo">065</span><a id="line.65"></a> |
| <span class="sourceLineNo">066</span><a id="line.66"> List<EventListener> listeners = new ArrayList<EventListener>(methods.size());</a> |
| <span class="sourceLineNo">067</span><a id="line.67"></a> |
| <span class="sourceLineNo">068</span><a id="line.68"> for (Method m : methods) {</a> |
| <span class="sourceLineNo">069</span><a id="line.69"> listeners.add(new SingleArgumentMethodEventListener(instance, m));</a> |
| <span class="sourceLineNo">070</span><a id="line.70"> }</a> |
| <span class="sourceLineNo">071</span><a id="line.71"></a> |
| <span class="sourceLineNo">072</span><a id="line.72"> return listeners;</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> }</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"> * Returns the type of annotation that indicates a method that should be represented as an {@link EventListener},</a> |
| <span class="sourceLineNo">077</span><a id="line.77"> * defaults to {@link Subscribe}.</a> |
| <span class="sourceLineNo">078</span><a id="line.78"> *</a> |
| <span class="sourceLineNo">079</span><a id="line.79"> * @return the type of annotation that indicates a method that should be represented as an {@link EventListener},</a> |
| <span class="sourceLineNo">080</span><a id="line.80"> * defaults to {@link Subscribe}.</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> */</a> |
| <span class="sourceLineNo">082</span><a id="line.82"> public Class<? extends Annotation> getAnnotationClass() {</a> |
| <span class="sourceLineNo">083</span><a id="line.83"> return annotationClass;</a> |
| <span class="sourceLineNo">084</span><a id="line.84"> }</a> |
| <span class="sourceLineNo">085</span><a id="line.85"></a> |
| <span class="sourceLineNo">086</span><a id="line.86"> /**</a> |
| <span class="sourceLineNo">087</span><a id="line.87"> * Sets the type of annotation that indicates a method that should be represented as an {@link EventListener}.</a> |
| <span class="sourceLineNo">088</span><a id="line.88"> * The default value is {@link Subscribe}.</a> |
| <span class="sourceLineNo">089</span><a id="line.89"> *</a> |
| <span class="sourceLineNo">090</span><a id="line.90"> * @param annotationClass the type of annotation that indicates a method that should be represented as an</a> |
| <span class="sourceLineNo">091</span><a id="line.91"> * {@link EventListener}. The default value is {@link Subscribe}.</a> |
| <span class="sourceLineNo">092</span><a id="line.92"> */</a> |
| <span class="sourceLineNo">093</span><a id="line.93"> public void setAnnotationClass(Class<? extends Annotation> annotationClass) {</a> |
| <span class="sourceLineNo">094</span><a id="line.94"> this.annotationClass = annotationClass;</a> |
| <span class="sourceLineNo">095</span><a id="line.95"> }</a> |
| <span class="sourceLineNo">096</span><a id="line.96">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
