| <!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>InstrumentationManager (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="InstrumentationManager (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/InstrumentationManager.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/DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openjpa/instrumentation/InstrumentationManagerImpl.html" title="class in org.apache.openjpa.instrumentation"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openjpa/instrumentation/InstrumentationManager.html" target="_top">Frames</a></li> |
| <li><a href="InstrumentationManager.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.openjpa.instrumentation</div> |
| <h2 title="Interface InstrumentationManager" class="title">Interface InstrumentationManager</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../org/apache/openjpa/lib/util/Closeable.html" title="interface in org.apache.openjpa.lib.util">Closeable</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/openjpa/instrumentation/InstrumentationManagerImpl.html" title="class in org.apache.openjpa.instrumentation">InstrumentationManagerImpl</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">InstrumentationManager</span> |
| extends <a href="../../../../org/apache/openjpa/lib/util/Closeable.html" title="interface in org.apache.openjpa.lib.util">Closeable</a></pre> |
| <div class="block">Managers of instrumentation providers must implement this interface. It |
| provides methods for initializing multiple providers via configuration in |
| addition to managing instrumentation providers and the state of the providers.</div> |
| </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="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><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="../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html" title="interface in org.apache.openjpa.lib.instrumentation">InstrumentationProvider</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/InstrumentationManager.html#getProviders()">getProviders</a></strong>()</code> |
| <div class="block">Returns all providers managed by this manager.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/InstrumentationManager.html#initialize(org.apache.openjpa.conf.OpenJPAConfiguration,%20org.apache.openjpa.lib.conf.PluginListValue)">initialize</a></strong>(<a href="../../../../org/apache/openjpa/conf/OpenJPAConfiguration.html" title="interface in org.apache.openjpa.conf">OpenJPAConfiguration</a> conf, |
| <a href="../../../../org/apache/openjpa/lib/conf/PluginListValue.html" title="class in org.apache.openjpa.lib.conf">PluginListValue</a> providers)</code> |
| <div class="block">Used to initialize one or more providers using the supplied configuration.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/InstrumentationManager.html#manageProvider(org.apache.openjpa.lib.instrumentation.InstrumentationProvider)">manageProvider</a></strong>(<a href="../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html" title="interface in org.apache.openjpa.lib.instrumentation">InstrumentationProvider</a> provider)</code> |
| <div class="block">Manage a given 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/InstrumentationManager.html#start(org.apache.openjpa.lib.instrumentation.InstrumentationLevel,%20java.lang.Object)">start</a></strong>(<a href="../../../../org/apache/openjpa/lib/instrumentation/InstrumentationLevel.html" title="enum in org.apache.openjpa.lib.instrumentation">InstrumentationLevel</a> level, |
| <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> context)</code> |
| <div class="block">Starts all instruments for all managed providers for a given level |
| and context.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/InstrumentationManager.html#stop(org.apache.openjpa.lib.instrumentation.InstrumentationLevel,%20java.lang.Object)">stop</a></strong>(<a href="../../../../org/apache/openjpa/lib/instrumentation/InstrumentationLevel.html" title="enum in org.apache.openjpa.lib.instrumentation">InstrumentationLevel</a> broker, |
| <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> context)</code> |
| <div class="block">Stops all instruments for all managed providers for a given level |
| and context.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.openjpa.lib.util.Closeable"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.openjpa.lib.util.<a href="../../../../org/apache/openjpa/lib/util/Closeable.html" title="interface in org.apache.openjpa.lib.util">Closeable</a></h3> |
| <code><a href="../../../../org/apache/openjpa/lib/util/Closeable.html#close()">close</a></code></li> |
| </ul> |
| </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="initialize(org.apache.openjpa.conf.OpenJPAConfiguration, org.apache.openjpa.lib.conf.PluginListValue)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initialize</h4> |
| <pre>void initialize(<a href="../../../../org/apache/openjpa/conf/OpenJPAConfiguration.html" title="interface in org.apache.openjpa.conf">OpenJPAConfiguration</a> conf, |
| <a href="../../../../org/apache/openjpa/lib/conf/PluginListValue.html" title="class in org.apache.openjpa.lib.conf">PluginListValue</a> providers)</pre> |
| <div class="block">Used to initialize one or more providers using the supplied configuration.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>conf</code> - the configuration to use for initialization</dd><dd><code>providers</code> - one or more providers as supplied via plugin list value</dd></dl> |
| </li> |
| </ul> |
| <a name="manageProvider(org.apache.openjpa.lib.instrumentation.InstrumentationProvider)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>manageProvider</h4> |
| <pre>void manageProvider(<a href="../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html" title="interface in org.apache.openjpa.lib.instrumentation">InstrumentationProvider</a> provider)</pre> |
| <div class="block">Manage a given provider. This will plug the instruments managed by the |
| the provider into the life cycle of the manager</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>provider</code> - the instrumentation provider</dd></dl> |
| </li> |
| </ul> |
| <a name="start(org.apache.openjpa.lib.instrumentation.InstrumentationLevel, java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>start</h4> |
| <pre>void start(<a href="../../../../org/apache/openjpa/lib/instrumentation/InstrumentationLevel.html" title="enum in org.apache.openjpa.lib.instrumentation">InstrumentationLevel</a> level, |
| <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> context)</pre> |
| <div class="block">Starts all instruments for all managed providers for a given level |
| and context.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>level</code> - instrumentation level</dd><dd><code>context</code> - instrumentation context (broker, factory, config,...)</dd></dl> |
| </li> |
| </ul> |
| <a name="stop(org.apache.openjpa.lib.instrumentation.InstrumentationLevel, java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stop</h4> |
| <pre>void stop(<a href="../../../../org/apache/openjpa/lib/instrumentation/InstrumentationLevel.html" title="enum in org.apache.openjpa.lib.instrumentation">InstrumentationLevel</a> broker, |
| <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> context)</pre> |
| <div class="block">Stops all instruments for all managed providers for a given level |
| and context.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>level</code> - instrumentation level</dd><dd><code>context</code> - instrumentation context (broker, factory, config,...)</dd></dl> |
| </li> |
| </ul> |
| <a name="getProviders()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getProviders</h4> |
| <pre><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="../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html" title="interface in org.apache.openjpa.lib.instrumentation">InstrumentationProvider</a>> getProviders()</pre> |
| <div class="block">Returns all providers managed by this manager.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>all providers managed by this manager</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/InstrumentationManager.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/DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openjpa/instrumentation/InstrumentationManagerImpl.html" title="class in org.apache.openjpa.instrumentation"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openjpa/instrumentation/InstrumentationManager.html" target="_top">Frames</a></li> |
| <li><a href="InstrumentationManager.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 © 2006–2017 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |