| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /> |
| <title>EventBus xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../apidocs/org/apache/shiro/event/EventBus.html">View Javadoc</a></div><pre> |
| |
| <a name="1" href="#1">1</a> <em class="jxr_comment">/*</em> |
| <a name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> |
| <a name="3" href="#3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> |
| <a name="4" href="#4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em> |
| <a name="5" href="#5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> |
| <a name="6" href="#6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> |
| <a name="7" href="#7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> |
| <a name="8" href="#8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> |
| <a name="9" href="#9">9</a> <em class="jxr_comment"> *</em> |
| <a name="10" href="#10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> |
| <a name="11" href="#11">11</a> <em class="jxr_comment"> *</em> |
| <a name="12" href="#12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> |
| <a name="13" href="#13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> |
| <a name="14" href="#14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> |
| <a name="15" href="#15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> |
| <a name="16" href="#16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> |
| <a name="17" href="#17">17</a> <em class="jxr_comment"> * under the License.</em> |
| <a name="18" href="#18">18</a> <em class="jxr_comment"> */</em> |
| <a name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.event; |
| <a name="20" href="#20">20</a> |
| <a name="21" href="#21">21</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="22" href="#22">22</a> <em class="jxr_javadoccomment"> * An event bus can publish events to event subscribers as well as provide a mechanism for registering and unregistering</em> |
| <a name="23" href="#23">23</a> <em class="jxr_javadoccomment"> * event subscribers.</em> |
| <a name="24" href="#24">24</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="25" href="#25">25</a> <em class="jxr_javadoccomment"> * An event bus enables a publish/subscribe paradigm within Shiro - components can publish or consume events they</em> |
| <a name="26" href="#26">26</a> <em class="jxr_javadoccomment"> * find relevant without needing to be tightly coupled to other components. This affords great</em> |
| <a name="27" href="#27">27</a> <em class="jxr_javadoccomment"> * flexibility within Shiro by promoting loose coupling and high cohesion between components and a much safer pluggable</em> |
| <a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * architecture.</em> |
| <a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * <h2>Sending Events</h2></em> |
| <a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * If a component wishes to publish events to other components:</em> |
| <a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * MyEvent myEvent = createMyEvent();</em> |
| <a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * eventBus.publish(myEvent);</em> |
| <a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * The event bus will determine the type of event and then dispatch the event to components that wish to receive</em> |
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * events of that type.</em> |
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * <h2>Receiving Events</h2></em> |
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * A component can receive events of interest by doing the following.</em> |
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * <ol></em> |
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * <li>For each type of event you wish to consume, create a public method that accepts a single event argument.</em> |
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * The method argument type indicates the type of event to receive.</li></em> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * <li>Annotate each of these public methods with the {@link org.apache.shiro.event.Subscribe Subscribe} annotation.</li></em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * <li>Register the component with the event bus:</em> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * eventBus.register(myComponent);</em> |
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * </li></em> |
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * </ol></em> |
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * After registering the component, when when an event of a respective type is published, the component's</em> |
| <a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * {@code Subscribe}-annotated method(s) will be invoked as expected.</em> |
| <a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * This design (and its constituent helper components) was largely influenced by</em> |
| <a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * Guava's <a href="<a href="http://docs.guava-libraries.googlecode.com/git/javadoc/com/google/common/eventbus/EventBus.html" target="alexandria_uri">http://docs.guava-libraries.googlecode.com/git/javadoc/com/google/common/eventbus/EventBus.html</a>">EventBus</a></em> |
| <a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * concept, although no code was viewed/copied/imported (even though Guava code is Apache 2.0 licensed and could have</em> |
| <a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * been used).</em> |
| <a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * @since 1.3</em> |
| <a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="59" href="#59">59</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../org/apache/shiro/event/EventBus.html">EventBus</a> { |
| <a name="60" href="#60">60</a> |
| <a name="61" href="#61">61</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * Publishes the specified event to an event subsystem that will deliver events to relevant {@link Subscribe}rs.</em> |
| <a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * @param event The event object to distribute to relevant subscribers.</em> |
| <a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="66" href="#66">66</a> <strong class="jxr_keyword">void</strong> publish(Object event); |
| <a name="67" href="#67">67</a> |
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * Registers all event handler methods on the specified instance to receive relevant events. The handler methods</em> |
| <a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * are determined by the {@code EventBus} implementation, typically by using an</em> |
| <a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.event.support.EventListenerResolver EventListenerResolver}</em> |
| <a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * (e.g. {@link org.apache.shiro.event.support.AnnotationEventListenerResolver AnnotationEventListenerResolver}).</em> |
| <a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * @param subscriber the object whose event handler methods should be registered to receive events.</em> |
| <a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="76" href="#76">76</a> <strong class="jxr_keyword">void</strong> register(Object subscriber); |
| <a name="77" href="#77">77</a> |
| <a name="78" href="#78">78</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * Unregisters all previously-registered event handler methods on the specified instance. If the specified object</em> |
| <a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * was not previously registered, calling this method has no effect.</em> |
| <a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * @param subscriber the previously</em> |
| <a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="84" href="#84">84</a> <strong class="jxr_keyword">void</strong> unregister(Object subscriber); |
| <a name="85" href="#85">85</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
