<!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 (version 1.7.0_40) on Fri Oct 18 06:47:24 UTC 2013 --> <title>LoggerBroadcaster (MX4J API)</title> <meta name="date" content="2013-10-18"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { parent.document.title="LoggerBroadcaster (MX4J API)"; } //--> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> <div class="topNav"><a name="navbar_top"> <!-- --> </a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/LoggerBroadcaster.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="../../mx4j/log/Logger.html" title="class in mx4j.log"><span class="strong">Prev Class</span></a></li> <li><a href="../../mx4j/log/LoggerBroadcaster.LoggerNotifier.html" title="class in mx4j.log"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../index.html?mx4j/log/LoggerBroadcaster.html" target="_top">Frames</a></li> <li><a href="LoggerBroadcaster.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><a href="#nested_class_summary">Nested</a> | </li> <li>Field | </li> <li><a href="#constructor_summary">Constr</a> | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor_detail">Constr</a> | </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">mx4j.log</div> <h2 title="Class LoggerBroadcaster" class="title">Class LoggerBroadcaster</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>javax.management.NotificationBroadcasterSupport</li> <li> <ul class="inheritance"> <li>mx4j.log.LoggerBroadcaster</li> </ul> </li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd>javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, javax.management.NotificationEmitter, <a href="../../mx4j/log/LoggerBroadcasterMBean.html" title="interface in mx4j.log">LoggerBroadcasterMBean</a></dd> </dl> <hr> <br> <pre>public class <span class="strong">LoggerBroadcaster</span> extends javax.management.NotificationBroadcasterSupport implements javax.management.MBeanRegistration, <a href="../../mx4j/log/LoggerBroadcasterMBean.html" title="interface in mx4j.log">LoggerBroadcasterMBean</a></pre> <div class="block">This broadcaster MBean allows to redirect MX4J internal logging to registered JMX listeners. <p> Simply register this MBean in the MBeanServer, register one or more listener (eventually with filters on the notification type), then call (directly or through MBeanServer) one of the <code>start</code> operations. From this moment, MX4J internal logging is redirected to this MBean, and from here to all registered listeners, basing on their filters.</div> <dl><dt><span class="strong">Version:</span></dt> <dd>$Revision: 1.7 $</dd></dl> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- ======== NESTED CLASS SUMMARY ======== --> <ul class="blockList"> <li class="blockList"><a name="nested_class_summary"> <!-- --> </a> <h3>Nested Class Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Class and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>static class </code></td> <td class="colLast"><code><strong><a href="../../mx4j/log/LoggerBroadcaster.LoggerNotifier.html" title="class in mx4j.log">LoggerBroadcaster.LoggerNotifier</a></strong></code> </td> </tr> </table> </li> </ul> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_summary"> <!-- --> </a> <h3>Constructor Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> <caption><span>Constructors</span><span class="tabEnd"> </span></caption> <tr> <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> <td class="colOne"><code><strong><a href="../../mx4j/log/LoggerBroadcaster.html#LoggerBroadcaster()">LoggerBroadcaster</a></strong>()</code> </td> </tr> </table> </li> </ul> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="method_summary"> <!-- --> </a> <h3>Method Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> <caption><span>Methods</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>protected <a href="../../mx4j/log/Logger.html" title="class in mx4j.log">Logger</a></code></td> <td class="colLast"><code><strong><a href="../../mx4j/log/LoggerBroadcaster.html#createLoggerPrototype()">createLoggerPrototype</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>javax.management.MBeanNotificationInfo[]</code></td> <td class="colLast"><code><strong><a href="../../mx4j/log/LoggerBroadcaster.html#getNotificationInfo()">getNotificationInfo</a></strong>()</code> <div class="block">Returns the metadata information associated with this emitter.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../mx4j/log/LoggerBroadcaster.html#postDeregister()">postDeregister</a></strong>()</code> <div class="block">Callback called just after the MBean has been successfully unregistered.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../mx4j/log/LoggerBroadcaster.html#postRegister(java.lang.Boolean)">postRegister</a></strong>(java.lang.Boolean registrationDone)</code> <div class="block">Callback called just after the MBean has been registered (successfully or not).</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../mx4j/log/LoggerBroadcaster.html#preDeregister()">preDeregister</a></strong>()</code> <div class="block">Callback called just before MBean unregistration from the MBeanServer.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>javax.management.ObjectName</code></td> <td class="colLast"><code><strong><a href="../../mx4j/log/LoggerBroadcaster.html#preRegister(javax.management.MBeanServer, javax.management.ObjectName)">preRegister</a></strong>(javax.management.MBeanServer server, javax.management.ObjectName name)</code> <div class="block">Callback called just before MBean registration in the MBeanServer.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../mx4j/log/LoggerBroadcaster.html#removeNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object)">removeNotificationListener</a></strong>(javax.management.NotificationListener listener, javax.management.NotificationFilter filter, java.lang.Object handback)</code> <div class="block">Removes a notification listener from this MBean.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../mx4j/log/LoggerBroadcaster.html#sendNotification(javax.management.Notification)">sendNotification</a></strong>(javax.management.Notification n)</code> <div class="block">Sends the given notification to all registered listeners</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../mx4j/log/LoggerBroadcaster.html#start()">start</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../mx4j/log/LoggerBroadcaster.html#start(java.lang.String)">start</a></strong>(java.lang.String category)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../mx4j/log/LoggerBroadcaster.html#stop()">stop</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../mx4j/log/LoggerBroadcaster.html#stop(java.lang.String)">stop</a></strong>(java.lang.String category)</code> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_javax.management.NotificationBroadcasterSupport"> <!-- --> </a> <h3>Methods inherited from class javax.management.NotificationBroadcasterSupport</h3> <code>addNotificationListener, handleNotification, removeNotificationListener</code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class java.lang.Object</h3> <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_mx4j.log.LoggerBroadcasterMBean"> <!-- --> </a> <h3>Methods inherited from interface mx4j.log.<a href="../../mx4j/log/LoggerBroadcasterMBean.html" title="interface in mx4j.log">LoggerBroadcasterMBean</a></h3> <code><a href="../../mx4j/log/LoggerBroadcasterMBean.html#addNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object)">addNotificationListener</a></code></li> </ul> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="LoggerBroadcaster()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>LoggerBroadcaster</h4> <pre>public LoggerBroadcaster()</pre> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="preRegister(javax.management.MBeanServer, javax.management.ObjectName)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>preRegister</h4> <pre>public javax.management.ObjectName preRegister(javax.management.MBeanServer server, javax.management.ObjectName name) throws java.lang.Exception</pre> <div class="block"><strong>Description copied from interface: <code>javax.management.MBeanRegistration</code></strong></div> <div class="block">Callback called just before MBean registration in the MBeanServer. Any exception thrown by this method will cause the MBean registration to abort.</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>preRegister</code> in interface <code>javax.management.MBeanRegistration</code></dd> <dt><span class="strong">Parameters:</span></dt><dd><code>server</code> - The MBeanServer on which the MBean will be registered.</dd><dd><code>name</code> - The <code>ObjectName</code> of the MBean.</dd> <dt><span class="strong">Returns:</span></dt><dd>The <code>ObjectName</code> of the registered MBean, must not be null</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.Exception</code> - Any possible exception generated by this method will be caught by the <code>MBeanServer</code> and re-thrown as an <code>MBeanRegistrationException</code> to the client.</dd></dl> </li> </ul> <a name="postRegister(java.lang.Boolean)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>postRegister</h4> <pre>public void postRegister(java.lang.Boolean registrationDone)</pre> <div class="block"><strong>Description copied from interface: <code>javax.management.MBeanRegistration</code></strong></div> <div class="block">Callback called just after the MBean has been registered (successfully or not).</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>postRegister</code> in interface <code>javax.management.MBeanRegistration</code></dd> <dt><span class="strong">Parameters:</span></dt><dd><code>registrationDone</code> - True if the registration was successful, false otherwise.</dd></dl> </li> </ul> <a name="preDeregister()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>preDeregister</h4> <pre>public void preDeregister() throws java.lang.Exception</pre> <div class="block"><strong>Description copied from interface: <code>javax.management.MBeanRegistration</code></strong></div> <div class="block">Callback called just before MBean unregistration from the MBeanServer. Any exception thrown by this method will cause the MBean unregistration to abort.</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>preDeregister</code> in interface <code>javax.management.MBeanRegistration</code></dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.Exception</code> - Any possible exception generated by this method will be caught by the <code>MBeanServer</code> and re-thrown as an <code>MBeanRegistrationException</code> to the client.</dd></dl> </li> </ul> <a name="postDeregister()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>postDeregister</h4> <pre>public void postDeregister()</pre> <div class="block"><strong>Description copied from interface: <code>javax.management.MBeanRegistration</code></strong></div> <div class="block">Callback called just after the MBean has been successfully unregistered.</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>postDeregister</code> in interface <code>javax.management.MBeanRegistration</code></dd> </dl> </li> </ul> <a name="removeNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>removeNotificationListener</h4> <pre>public void removeNotificationListener(javax.management.NotificationListener listener, javax.management.NotificationFilter filter, java.lang.Object handback) throws javax.management.ListenerNotFoundException</pre> <div class="block"><strong>Description copied from interface: <code>javax.management.NotificationEmitter</code></strong></div> <div class="block">Removes a notification listener from this MBean. The MBean must have a registered listener that exactly matches the given listener, filter, and handback parameters.</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>removeNotificationListener</code> in interface <code>javax.management.NotificationEmitter</code></dd> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../mx4j/log/LoggerBroadcasterMBean.html#removeNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object)">removeNotificationListener</a></code> in interface <code><a href="../../mx4j/log/LoggerBroadcasterMBean.html" title="interface in mx4j.log">LoggerBroadcasterMBean</a></code></dd> <dt><strong>Overrides:</strong></dt> <dd><code>removeNotificationListener</code> in class <code>javax.management.NotificationBroadcasterSupport</code></dd> <dt><span class="strong">Parameters:</span></dt><dd><code>listener</code> - The listener that was previously added to this MBean.</dd><dd><code>filter</code> - The filter that was specified when the listener was added.</dd><dd><code>handback</code> - The handback that was specified when the listener was added.</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>javax.management.ListenerNotFoundException</code> - If the triple listener, filter, handback is not registered with the emitter</dd></dl> </li> </ul> <a name="sendNotification(javax.management.Notification)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>sendNotification</h4> <pre>public void sendNotification(javax.management.Notification n)</pre> <div class="block"><strong>Description copied from class: <code>javax.management.NotificationBroadcasterSupport</code></strong></div> <div class="block">Sends the given notification to all registered listeners</div> <dl> <dt><strong>Overrides:</strong></dt> <dd><code>sendNotification</code> in class <code>javax.management.NotificationBroadcasterSupport</code></dd> <dt><span class="strong">Parameters:</span></dt><dd><code>n</code> - The notification to send</dd></dl> </li> </ul> <a name="start()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>start</h4> <pre>public void start()</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../mx4j/log/LoggerBroadcasterMBean.html#start()">start</a></code> in interface <code><a href="../../mx4j/log/LoggerBroadcasterMBean.html" title="interface in mx4j.log">LoggerBroadcasterMBean</a></code></dd> </dl> </li> </ul> <a name="start(java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>start</h4> <pre>public void start(java.lang.String category)</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../mx4j/log/LoggerBroadcasterMBean.html#start(java.lang.String)">start</a></code> in interface <code><a href="../../mx4j/log/LoggerBroadcasterMBean.html" title="interface in mx4j.log">LoggerBroadcasterMBean</a></code></dd> </dl> </li> </ul> <a name="stop()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>stop</h4> <pre>public void stop()</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../mx4j/log/LoggerBroadcasterMBean.html#stop()">stop</a></code> in interface <code><a href="../../mx4j/log/LoggerBroadcasterMBean.html" title="interface in mx4j.log">LoggerBroadcasterMBean</a></code></dd> </dl> </li> </ul> <a name="stop(java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>stop</h4> <pre>public void stop(java.lang.String category)</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../mx4j/log/LoggerBroadcasterMBean.html#stop(java.lang.String)">stop</a></code> in interface <code><a href="../../mx4j/log/LoggerBroadcasterMBean.html" title="interface in mx4j.log">LoggerBroadcasterMBean</a></code></dd> </dl> </li> </ul> <a name="getNotificationInfo()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getNotificationInfo</h4> <pre>public javax.management.MBeanNotificationInfo[] getNotificationInfo()</pre> <div class="block"><strong>Description copied from interface: <code>javax.management.NotificationBroadcaster</code></strong></div> <div class="block">Returns the metadata information associated with this emitter.</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>getNotificationInfo</code> in interface <code>javax.management.NotificationBroadcaster</code></dd> <dt><strong>Overrides:</strong></dt> <dd><code>getNotificationInfo</code> in class <code>javax.management.NotificationBroadcasterSupport</code></dd> </dl> </li> </ul> <a name="createLoggerPrototype()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>createLoggerPrototype</h4> <pre>protected <a href="../../mx4j/log/Logger.html" title="class in mx4j.log">Logger</a> createLoggerPrototype()</pre> </li> </ul> </li> </ul> </li> </ul> </div> </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a name="navbar_bottom"> <!-- --> </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/LoggerBroadcaster.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="../../mx4j/log/Logger.html" title="class in mx4j.log"><span class="strong">Prev Class</span></a></li> <li><a href="../../mx4j/log/LoggerBroadcaster.LoggerNotifier.html" title="class in mx4j.log"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../index.html?mx4j/log/LoggerBroadcaster.html" target="_top">Frames</a></li> <li><a href="LoggerBroadcaster.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><a href="#nested_class_summary">Nested</a> | </li> <li>Field | </li> <li><a href="#constructor_summary">Constr</a> | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor_detail">Constr</a> | </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><center><small>Copyright © 2001-2005 The MX4J Contributors. All Rights Reserved.</small></center></small></p> </body> </html>