| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_92) on Mon Aug 29 13:54:36 EDT 2016 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>EventBus (Apache Shiro 1.3.1 API)</title> |
| <meta name="date" content="2016-08-29"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="EventBus (Apache Shiro 1.3.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/EventBus.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/shiro/event/Event.html" title="class in org.apache.shiro.event"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/shiro/event/EventBusAware.html" title="interface in org.apache.shiro.event"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/shiro/event/EventBus.html" target="_top">Frames</a></li> |
| <li><a href="EventBus.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.shiro.event</div> |
| <h2 title="Interface EventBus" class="title">Interface EventBus</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/shiro/event/support/DefaultEventBus.html" title="class in org.apache.shiro.event.support">DefaultEventBus</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <a href="../../../../src-html/org/apache/shiro/event/EventBus.html#line.59">EventBus</a></pre> |
| <div class="block">An event bus can publish events to event subscribers as well as provide a mechanism for registering and unregistering |
| event subscribers. |
| <p/> |
| An event bus enables a publish/subscribe paradigm within Shiro - components can publish or consume events they |
| find relevant without needing to be tightly coupled to other components. This affords great |
| flexibility within Shiro by promoting loose coupling and high cohesion between components and a much safer pluggable |
| architecture. |
| <h2>Sending Events</h2> |
| If a component wishes to publish events to other components: |
| <pre> |
| MyEvent myEvent = createMyEvent(); |
| eventBus.publish(myEvent); |
| </pre> |
| The event bus will determine the type of event and then dispatch the event to components that wish to receive |
| events of that type. |
| <h2>Receiving Events</h2> |
| A component can receive events of interest by doing the following. |
| <ol> |
| <li>For each type of event you wish to consume, create a public method that accepts a single event argument. |
| The method argument type indicates the type of event to receive.</li> |
| <li>Annotate each of these public methods with the <a href="../../../../org/apache/shiro/event/Subscribe.html" title="annotation in org.apache.shiro.event"><code>Subscribe</code></a> annotation.</li> |
| <li>Register the component with the event bus: |
| <pre> |
| eventBus.register(myComponent); |
| </pre> |
| </li> |
| </ol> |
| After registering the component, when when an event of a respective type is published, the component's |
| <code>Subscribe</code>-annotated method(s) will be invoked as expected. |
| <p/> |
| This design (and its constituent helper components) was largely influenced by |
| Guava's <a href="http://docs.guava-libraries.googlecode.com/git/javadoc/com/google/common/eventbus/EventBus.html">EventBus</a> |
| concept, although no code was viewed/copied/imported (even though Guava code is Apache 2.0 licensed and could have |
| been used).</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.3</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/shiro/event/EventBus.html#publish-java.lang.Object-">publish</a></span>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> event)</code> |
| <div class="block">Publishes the specified event to an event subsystem that will deliver events to relevant <a href="../../../../org/apache/shiro/event/Subscribe.html" title="annotation in org.apache.shiro.event"><code>Subscribe</code></a>rs.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/shiro/event/EventBus.html#register-java.lang.Object-">register</a></span>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> subscriber)</code> |
| <div class="block">Registers all event handler methods on the specified instance to receive relevant events.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/shiro/event/EventBus.html#unregister-java.lang.Object-">unregister</a></span>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> subscriber)</code> |
| <div class="block">Unregisters all previously-registered event handler methods on the specified instance.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="publish-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>publish</h4> |
| <pre>void <a href="../../../../src-html/org/apache/shiro/event/EventBus.html#line.66">publish</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> event)</pre> |
| <div class="block">Publishes the specified event to an event subsystem that will deliver events to relevant <a href="../../../../org/apache/shiro/event/Subscribe.html" title="annotation in org.apache.shiro.event"><code>Subscribe</code></a>rs.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>event</code> - The event object to distribute to relevant subscribers.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="register-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>register</h4> |
| <pre>void <a href="../../../../src-html/org/apache/shiro/event/EventBus.html#line.76">register</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> subscriber)</pre> |
| <div class="block">Registers all event handler methods on the specified instance to receive relevant events. The handler methods |
| are determined by the <code>EventBus</code> implementation, typically by using an |
| <a href="../../../../org/apache/shiro/event/support/EventListenerResolver.html" title="interface in org.apache.shiro.event.support"><code>EventListenerResolver</code></a> |
| (e.g. <a href="../../../../org/apache/shiro/event/support/AnnotationEventListenerResolver.html" title="class in org.apache.shiro.event.support"><code>AnnotationEventListenerResolver</code></a>).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>subscriber</code> - the object whose event handler methods should be registered to receive events.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="unregister-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>unregister</h4> |
| <pre>void <a href="../../../../src-html/org/apache/shiro/event/EventBus.html#line.84">unregister</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> subscriber)</pre> |
| <div class="block">Unregisters all previously-registered event handler methods on the specified instance. If the specified object |
| was not previously registered, calling this method has no effect.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>subscriber</code> - the previously</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/EventBus.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/shiro/event/Event.html" title="class in org.apache.shiro.event"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/shiro/event/EventBusAware.html" title="interface in org.apache.shiro.event"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/shiro/event/EventBus.html" target="_top">Frames</a></li> |
| <li><a href="EventBus.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2004-2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |
