| <!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_121) on Fri Jan 06 19:36:25 UTC 2017 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>JMXProvider (OpenJPA Parent POM 2.4.2 API)</title> |
| <meta name="date" content="2017-01-06"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="JMXProvider (OpenJPA Parent POM 2.4.2 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </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/JMXProvider.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/openjpa/instrumentation/jmx/JMXInstrument.html" title="interface in org.apache.openjpa.instrumentation.jmx"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/openjpa/instrumentation/jmx/PreparedQueryCacheJMXInstrument.html" title="class in org.apache.openjpa.instrumentation.jmx"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/openjpa/instrumentation/jmx/JMXProvider.html" target="_top">Frames</a></li> |
| <li><a href="JMXProvider.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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">org.apache.openjpa.instrumentation.jmx</div> |
| <h2 title="Class JMXProvider" class="title">Class JMXProvider</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html" title="class in org.apache.openjpa.lib.instrumentation">org.apache.openjpa.lib.instrumentation.AbstractInstrumentationProvider</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.openjpa.instrumentation.jmx.JMXProvider</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../org/apache/openjpa/lib/conf/Configurable.html" title="interface in org.apache.openjpa.lib.conf">Configurable</a>, <a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html" title="interface in org.apache.openjpa.lib.instrumentation">InstrumentationProvider</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">JMXProvider</span> |
| extends <a href="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html" title="class in org.apache.openjpa.lib.instrumentation">AbstractInstrumentationProvider</a></pre> |
| <div class="block">A simple MBean JMX instrumentation provider</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/instrumentation/jmx/JMXProvider.html#JMX_INSTRUMENT_ALIASES">JMX_INSTRUMENT_ALIASES</a></strong></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/instrumentation/jmx/JMXProvider.html#MBEAN_DOMAIN">MBEAN_DOMAIN</a></strong></code> |
| <div class="block">The MBean domain for OpenJPA</div> |
| </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="../../../../../org/apache/openjpa/instrumentation/jmx/JMXProvider.html#JMXProvider()">JMXProvider</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>static <a href="http://download.oracle.com/javase/6/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/instrumentation/jmx/JMXProvider.html#createObjectName(org.apache.openjpa.instrumentation.jmx.JMXInstrument,%20java.util.Map)">createObjectName</a></strong>(<a href="../../../../../org/apache/openjpa/instrumentation/jmx/JMXInstrument.html" title="interface in org.apache.openjpa.instrumentation.jmx">JMXInstrument</a> instrument, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> props)</code> |
| <div class="block">Creates an object name for the supplied instrument and key properties</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/instrumentation/jmx/JMXProvider.html#getInstrumentAliases()">getInstrumentAliases</a></strong>()</code> |
| <div class="block">Returns aliases for built-in instruments.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://download.oracle.com/javase/6/docs/api/javax/management/MBeanServer.html?is-external=true" title="class or interface in javax.management">MBeanServer</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/instrumentation/jmx/JMXProvider.html#getMBeanServer()">getMBeanServer</a></strong>()</code> |
| <div class="block">Returns the mbean server</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/instrumentation/jmx/JMXProvider.html#registerMBean(org.apache.openjpa.instrumentation.jmx.JMXInstrument)">registerMBean</a></strong>(<a href="../../../../../org/apache/openjpa/instrumentation/jmx/JMXInstrument.html" title="interface in org.apache.openjpa.instrumentation.jmx">JMXInstrument</a> mBean)</code> |
| <div class="block">Register an MBean with the mbean server.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/instrumentation/jmx/JMXProvider.html#start()">start</a></strong>()</code> |
| <div class="block">Stops the instrumentation provider</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/instrumentation/jmx/JMXProvider.html#startInstrument(org.apache.openjpa.lib.instrumentation.Instrument)">startInstrument</a></strong>(<a href="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</a> instrument)</code> |
| <div class="block">Start an instrument.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/instrumentation/jmx/JMXProvider.html#stop()">stop</a></strong>()</code> |
| <div class="block">Stops all instruments registered with this provider and releases the |
| reference to the Platform MBean server instance.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/instrumentation/jmx/JMXProvider.html#stopInstrument(org.apache.openjpa.lib.instrumentation.Instrument,%20boolean)">stopInstrument</a></strong>(<a href="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</a> instrument, |
| boolean force)</code> |
| <div class="block">Stop an instrument.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.openjpa.lib.instrumentation.AbstractInstrumentationProvider"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.openjpa.lib.instrumentation.<a href="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html" title="class in org.apache.openjpa.lib.instrumentation">AbstractInstrumentationProvider</a></h3> |
| <code><a href="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html#addInstrument(org.apache.openjpa.lib.instrumentation.Instrument)">addInstrument</a>, <a href="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html#endConfiguration()">endConfiguration</a>, <a href="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html#getConfiguration()">getConfiguration</a>, <a href="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html#getInstrument()">getInstrument</a>, <a href="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html#getInstrumentByName(java.lang.String)">getInstrumentByName</a>, <a href="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html#getInstruments()">getInstruments</a>, <a href="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html#getOptions()">getOptions</a>, <a href="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html#initializeInstrument(org.apache.openjpa.lib.instrumentation.Instrument,%20java.lang.Object)">initializeInstrument</a>, <a href="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html#initializeInstrument(org.apache.openjpa.lib.instrumentation.Instrument,%20java.lang.String,%20java.lang.Object)">initializeInstrument</a>, <a href="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html#isStarted()">isStarted</a>, <a href="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html#removeInstrumentByName(java.lang.String)">removeInstrumentByName</a>, <a href="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html#setConfiguration(org.apache.openjpa.lib.conf.Configuration)">setConfiguration</a>, <a href="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html#setInstrument(java.lang.String)">setInstrument</a>, <a href="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html#setOptions(java.lang.String)">setOptions</a>, <a href="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html#setStarted(boolean)">setStarted</a>, <a href="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html#startConfiguration()">startConfiguration</a>, <a href="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html#startInstruments(org.apache.openjpa.lib.instrumentation.InstrumentationLevel,%20java.lang.Object)">startInstruments</a>, <a href="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html#stopInstrument(org.apache.openjpa.lib.instrumentation.Instrument)">stopInstrument</a>, <a href="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html#stopInstruments(org.apache.openjpa.lib.instrumentation.InstrumentationLevel,%20java.lang.Object)">stopInstruments</a></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.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="JMX_INSTRUMENT_ALIASES"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>JMX_INSTRUMENT_ALIASES</h4> |
| <pre>public static final <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] JMX_INSTRUMENT_ALIASES</pre> |
| </li> |
| </ul> |
| <a name="MBEAN_DOMAIN"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>MBEAN_DOMAIN</h4> |
| <pre>public static final <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> MBEAN_DOMAIN</pre> |
| <div class="block">The MBean domain for OpenJPA</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.openjpa.instrumentation.jmx.JMXProvider.MBEAN_DOMAIN">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="JMXProvider()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>JMXProvider</h4> |
| <pre>public JMXProvider()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="registerMBean(org.apache.openjpa.instrumentation.jmx.JMXInstrument)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerMBean</h4> |
| <pre>protected void registerMBean(<a href="../../../../../org/apache/openjpa/instrumentation/jmx/JMXInstrument.html" title="interface in org.apache.openjpa.instrumentation.jmx">JMXInstrument</a> mBean)</pre> |
| <div class="block">Register an MBean with the mbean server.</div> |
| </li> |
| </ul> |
| <a name="getMBeanServer()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMBeanServer</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://download.oracle.com/javase/6/docs/api/javax/management/MBeanServer.html?is-external=true" title="class or interface in javax.management">MBeanServer</a>> getMBeanServer()</pre> |
| <div class="block">Returns the mbean server</div> |
| </li> |
| </ul> |
| <a name="start()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>start</h4> |
| <pre>public void start()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#start()">InstrumentationProvider</a></code></strong></div> |
| <div class="block">Stops the instrumentation provider</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#start()">start</a></code> in interface <code><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html" title="interface in org.apache.openjpa.lib.instrumentation">InstrumentationProvider</a></code></dd> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html#start()">start</a></code> in class <code><a href="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html" title="class in org.apache.openjpa.lib.instrumentation">AbstractInstrumentationProvider</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="stop()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stop</h4> |
| <pre>public void stop()</pre> |
| <div class="block">Stops all instruments registered with this provider and releases the |
| reference to the Platform MBean server instance.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#stop()">stop</a></code> in interface <code><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html" title="interface in org.apache.openjpa.lib.instrumentation">InstrumentationProvider</a></code></dd> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html#stop()">stop</a></code> in class <code><a href="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html" title="class in org.apache.openjpa.lib.instrumentation">AbstractInstrumentationProvider</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createObjectName(org.apache.openjpa.instrumentation.jmx.JMXInstrument, java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createObjectName</h4> |
| <pre>public static <a href="http://download.oracle.com/javase/6/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a> createObjectName(<a href="../../../../../org/apache/openjpa/instrumentation/jmx/JMXInstrument.html" title="interface in org.apache.openjpa.instrumentation.jmx">JMXInstrument</a> instrument, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> props) |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Creates an object name for the supplied instrument and key properties</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>instrument</code> - the instrument</dd><dd><code>props</code> - additional key properties</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the JMX object name</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - a generic JMX-type exception</dd></dl> |
| </li> |
| </ul> |
| <a name="startInstrument(org.apache.openjpa.lib.instrumentation.Instrument)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startInstrument</h4> |
| <pre>public void startInstrument(<a href="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</a> instrument)</pre> |
| <div class="block">Start an instrument. Registers an mbean with the server.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>instrument</code> - this instrument to start</dd></dl> |
| </li> |
| </ul> |
| <a name="stopInstrument(org.apache.openjpa.lib.instrumentation.Instrument, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stopInstrument</h4> |
| <pre>public void stopInstrument(<a href="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</a> instrument, |
| boolean force)</pre> |
| <div class="block">Stop an instrument. Unregisters an mbean with the server.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>instrument</code> - the instrument to stop</dd><dd><code>force</code> - forces the stop if the instrument does not stop gracefully.</dd></dl> |
| </li> |
| </ul> |
| <a name="getInstrumentAliases()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getInstrumentAliases</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getInstrumentAliases()</pre> |
| <div class="block">Returns aliases for built-in instruments.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#getInstrumentAliases()">getInstrumentAliases</a></code> in interface <code><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html" title="interface in org.apache.openjpa.lib.instrumentation">InstrumentationProvider</a></code></dd> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html#getInstrumentAliases()">getInstrumentAliases</a></code> in class <code><a href="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html" title="class in org.apache.openjpa.lib.instrumentation">AbstractInstrumentationProvider</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a string array of identifier, class name pairs.</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><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/JMXProvider.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/openjpa/instrumentation/jmx/JMXInstrument.html" title="interface in org.apache.openjpa.instrumentation.jmx"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/openjpa/instrumentation/jmx/PreparedQueryCacheJMXInstrument.html" title="class in org.apache.openjpa.instrumentation.jmx"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/openjpa/instrumentation/jmx/JMXProvider.html" target="_top">Frames</a></li> |
| <li><a href="JMXProvider.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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>Copyright © 2006–2017 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |