blob: 6399a3471d2ed5a54be75da3e9a4824f655de293 [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.event.support;</a>
<span class="sourceLineNo">020</span><a id="line.20"></a>
<span class="sourceLineNo">021</span><a id="line.21">import java.lang.reflect.Method;</a>
<span class="sourceLineNo">022</span><a id="line.22">import java.lang.reflect.Modifier;</a>
<span class="sourceLineNo">023</span><a id="line.23"></a>
<span class="sourceLineNo">024</span><a id="line.24">/**</a>
<span class="sourceLineNo">025</span><a id="line.25"> * A event listener that invokes a target object's method that accepts a single event argument.</a>
<span class="sourceLineNo">026</span><a id="line.26"> *</a>
<span class="sourceLineNo">027</span><a id="line.27"> * @since 1.3</a>
<span class="sourceLineNo">028</span><a id="line.28"> */</a>
<span class="sourceLineNo">029</span><a id="line.29">public class SingleArgumentMethodEventListener implements TypedEventListener {</a>
<span class="sourceLineNo">030</span><a id="line.30"></a>
<span class="sourceLineNo">031</span><a id="line.31"> private final Object target;</a>
<span class="sourceLineNo">032</span><a id="line.32"> private final Method method;</a>
<span class="sourceLineNo">033</span><a id="line.33"></a>
<span class="sourceLineNo">034</span><a id="line.34"> public SingleArgumentMethodEventListener(Object target, Method method) {</a>
<span class="sourceLineNo">035</span><a id="line.35"> this.target = target;</a>
<span class="sourceLineNo">036</span><a id="line.36"> this.method = method;</a>
<span class="sourceLineNo">037</span><a id="line.37"> //assert that the method is defined as expected:</a>
<span class="sourceLineNo">038</span><a id="line.38"> getMethodArgumentType(method);</a>
<span class="sourceLineNo">039</span><a id="line.39"></a>
<span class="sourceLineNo">040</span><a id="line.40"> assertPublicMethod(method);</a>
<span class="sourceLineNo">041</span><a id="line.41"> }</a>
<span class="sourceLineNo">042</span><a id="line.42"></a>
<span class="sourceLineNo">043</span><a id="line.43"> public Object getTarget() {</a>
<span class="sourceLineNo">044</span><a id="line.44"> return this.target;</a>
<span class="sourceLineNo">045</span><a id="line.45"> }</a>
<span class="sourceLineNo">046</span><a id="line.46"></a>
<span class="sourceLineNo">047</span><a id="line.47"> public Method getMethod() {</a>
<span class="sourceLineNo">048</span><a id="line.48"> return this.method;</a>
<span class="sourceLineNo">049</span><a id="line.49"> }</a>
<span class="sourceLineNo">050</span><a id="line.50"></a>
<span class="sourceLineNo">051</span><a id="line.51"> private void assertPublicMethod(Method method) {</a>
<span class="sourceLineNo">052</span><a id="line.52"> int modifiers = method.getModifiers();</a>
<span class="sourceLineNo">053</span><a id="line.53"> if (!Modifier.isPublic(modifiers)) {</a>
<span class="sourceLineNo">054</span><a id="line.54"> throw new IllegalArgumentException("Event handler method [" + method + "] must be public.");</a>
<span class="sourceLineNo">055</span><a id="line.55"> }</a>
<span class="sourceLineNo">056</span><a id="line.56"> }</a>
<span class="sourceLineNo">057</span><a id="line.57"></a>
<span class="sourceLineNo">058</span><a id="line.58"> public boolean accepts(Object event) {</a>
<span class="sourceLineNo">059</span><a id="line.59"> return event != null &amp;&amp; getEventType().isInstance(event);</a>
<span class="sourceLineNo">060</span><a id="line.60"> }</a>
<span class="sourceLineNo">061</span><a id="line.61"></a>
<span class="sourceLineNo">062</span><a id="line.62"> public Class getEventType() {</a>
<span class="sourceLineNo">063</span><a id="line.63"> return getMethodArgumentType(getMethod());</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"> public void onEvent(Object event) {</a>
<span class="sourceLineNo">067</span><a id="line.67"> Method method = getMethod();</a>
<span class="sourceLineNo">068</span><a id="line.68"> try {</a>
<span class="sourceLineNo">069</span><a id="line.69"> method.invoke(getTarget(), event);</a>
<span class="sourceLineNo">070</span><a id="line.70"> } catch (Exception e) {</a>
<span class="sourceLineNo">071</span><a id="line.71"> throw new IllegalStateException("Unable to invoke event handler method [" + method + "].", e);</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"></a>
<span class="sourceLineNo">075</span><a id="line.75"> protected Class getMethodArgumentType(Method method) {</a>
<span class="sourceLineNo">076</span><a id="line.76"> Class[] paramTypes = method.getParameterTypes();</a>
<span class="sourceLineNo">077</span><a id="line.77"> if (paramTypes.length != 1) {</a>
<span class="sourceLineNo">078</span><a id="line.78"> //the default implementation expects a single typed argument and nothing more:</a>
<span class="sourceLineNo">079</span><a id="line.79"> String msg = "Event handler methods must accept a single argument.";</a>
<span class="sourceLineNo">080</span><a id="line.80"> throw new IllegalArgumentException(msg);</a>
<span class="sourceLineNo">081</span><a id="line.81"> }</a>
<span class="sourceLineNo">082</span><a id="line.82"> return paramTypes[0];</a>
<span class="sourceLineNo">083</span><a id="line.83"> }</a>
<span class="sourceLineNo">084</span><a id="line.84">}</a>
</pre>
</div>
</main>
</body>
</html>