| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="fr"> |
| <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.event;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>/**<a name="line.21"></a> |
| <span class="sourceLineNo">022</span> * An event bus can publish events to event subscribers as well as provide a mechanism for registering and unregistering<a name="line.22"></a> |
| <span class="sourceLineNo">023</span> * event subscribers.<a name="line.23"></a> |
| <span class="sourceLineNo">024</span> * <p/><a name="line.24"></a> |
| <span class="sourceLineNo">025</span> * An event bus enables a publish/subscribe paradigm within Shiro - components can publish or consume events they<a name="line.25"></a> |
| <span class="sourceLineNo">026</span> * find relevant without needing to be tightly coupled to other components. This affords great<a name="line.26"></a> |
| <span class="sourceLineNo">027</span> * flexibility within Shiro by promoting loose coupling and high cohesion between components and a much safer pluggable<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> * architecture.<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> * <h2>Sending Events</h2><a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * If a component wishes to publish events to other components:<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * <pre><a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * MyEvent myEvent = createMyEvent();<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * eventBus.publish(myEvent);<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * </pre><a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * The event bus will determine the type of event and then dispatch the event to components that wish to receive<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * events of that type.<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * <h2>Receiving Events</h2><a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * A component can receive events of interest by doing the following.<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * <ol><a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * <li>For each type of event you wish to consume, create a public method that accepts a single event argument.<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * The method argument type indicates the type of event to receive.</li><a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * <li>Annotate each of these public methods with the {@link org.apache.shiro.event.Subscribe Subscribe} annotation.</li><a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * <li>Register the component with the event bus:<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * <pre><a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * eventBus.register(myComponent);<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * </pre><a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * </li><a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * </ol><a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * After registering the component, when when an event of a respective type is published, the component's<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * {@code Subscribe}-annotated method(s) will be invoked as expected.<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * <p/><a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * This design (and its constituent helper components) was largely influenced by<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * Guava's <a href="http://docs.guava-libraries.googlecode.com/git/javadoc/com/google/common/eventbus/EventBus.html">EventBus</a><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * concept, although no code was viewed/copied/imported (even though Guava code is Apache 2.0 licensed and could have<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * been used).<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> *<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * @since 1.3<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> */<a name="line.58"></a> |
| <span class="sourceLineNo">059</span>public interface EventBus {<a name="line.59"></a> |
| <span class="sourceLineNo">060</span><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> /**<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * Publishes the specified event to an event subsystem that will deliver events to relevant {@link Subscribe}rs.<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> *<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * @param event The event object to distribute to relevant subscribers.<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> */<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> void publish(Object event);<a name="line.66"></a> |
| <span class="sourceLineNo">067</span><a name="line.67"></a> |
| <span class="sourceLineNo">068</span> /**<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * Registers all event handler methods on the specified instance to receive relevant events. The handler methods<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * are determined by the {@code EventBus} implementation, typically by using an<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * {@link org.apache.shiro.event.support.EventListenerResolver EventListenerResolver}<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * (e.g. {@link org.apache.shiro.event.support.AnnotationEventListenerResolver AnnotationEventListenerResolver}).<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> *<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * @param subscriber the object whose event handler methods should be registered to receive events.<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> */<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> void register(Object subscriber);<a name="line.76"></a> |
| <span class="sourceLineNo">077</span><a name="line.77"></a> |
| <span class="sourceLineNo">078</span> /**<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * Unregisters all previously-registered event handler methods on the specified instance. If the specified object<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * was not previously registered, calling this method has no effect.<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> *<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * @param subscriber the previously<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> */<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> void unregister(Object subscriber);<a name="line.84"></a> |
| <span class="sourceLineNo">085</span>}<a name="line.85"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
