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