Google Git
Sign in
apache / openjpa-site / f4f8b894b02554a0a851bbf380ef41d45c445062 / . / content / builds / 2.4.2 / apidocs / org / apache / openjpa / lib / instrumentation / InstrumentationProvider.html
blob: 7ca9f2f5a9e57e909d83f605856dd2e5b78e5709 [file] [log] [blame]
<!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:22 UTC 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InstrumentationProvider (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="InstrumentationProvider (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/InstrumentationProvider.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/lib/instrumentation/InstrumentationLevel.html" title="enum in org.apache.openjpa.lib.instrumentation"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html" target="_top">Frames</a></li>
<li><a href="InstrumentationProvider.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.lib.instrumentation</div>
<h2 title="Interface InstrumentationProvider" class="title">Interface InstrumentationProvider</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/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html" title="class in org.apache.openjpa.lib.instrumentation">AbstractInstrumentationProvider</a>, <a href="../../../../../org/apache/openjpa/instrumentation/jmx/JMXProvider.html" title="class in org.apache.openjpa.instrumentation.jmx">JMXProvider</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">InstrumentationProvider</span></pre>
<div class="block">Pluggable instrumentation providers (ex. JMX) must implement this interface. It
provides methods for controlling the provider and the instruments instrumented
by the provider.</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">&nbsp;</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>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#addInstrument(org.apache.openjpa.lib.instrumentation.Instrument)">addInstrument</a></strong>(<a href="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</a>&nbsp;instrument)</code>
<div class="block">Adds an instrument to this providers list of managed instruments.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/lib/conf/Configuration.html" title="interface in org.apache.openjpa.lib.conf">Configuration</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#getConfiguration()">getConfiguration</a></strong>()</code>
<div class="block">Gets the configuration associated with the instrumentation provider</div>
</td>
</tr>
<tr class="altColor">
<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/lib/instrumentation/InstrumentationProvider.html#getInstrument()">getInstrument</a></strong>()</code>
<div class="block">Returns the string-based list of instruments directly configured by
this provider via setInstrument.</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/lib/instrumentation/InstrumentationProvider.html#getInstrumentAliases()">getInstrumentAliases</a></strong>()</code>
<div class="block">Returns an string array of identifier to class name aliases for
instruments known to the instrumentation provider.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#getInstrumentByName(java.lang.String)">getInstrumentByName</a></strong>(<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>&nbsp;name)</code>
<div class="block">Returns an instrument instrumented by this provider by name</div>
</td>
</tr>
<tr class="rowColor">
<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>&lt;<a href="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#getInstruments()">getInstruments</a></strong>()</code>
<div class="block">Gets all instruments instrumented by this provider</div>
</td>
</tr>
<tr class="altColor">
<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/lib/instrumentation/InstrumentationProvider.html#getOptions()">getOptions</a></strong>()</code>
<div class="block">Gets configuration options for this provider</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#initializeInstrument(org.apache.openjpa.lib.instrumentation.Instrument,%20java.lang.Object)">initializeInstrument</a></strong>(<a href="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</a>&nbsp;instrument,
<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>&nbsp;context)</code>
<div class="block">Initializes an instrument within the provided context.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#initializeInstrument(org.apache.openjpa.lib.instrumentation.Instrument,%20java.lang.String,%20java.lang.Object)">initializeInstrument</a></strong>(<a href="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</a>&nbsp;instrument,
<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>&nbsp;options,
<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>&nbsp;context)</code>
<div class="block">Initializes an instrument within the provided options and context.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#isStarted()">isStarted</a></strong>()</code>
<div class="block">Whether the instrumentation provider started</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#removeInstrumentByName(java.lang.String)">removeInstrumentByName</a></strong>(<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>&nbsp;name)</code>
<div class="block">Removes an instrument instrumented by this provider by name</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#setInstrument(java.lang.String)">setInstrument</a></strong>(<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>&nbsp;instruments)</code>
<div class="block">Used to associate one or more instruments to a provider.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#setOptions(java.lang.String)">setOptions</a></strong>(<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>&nbsp;options)</code>
<div class="block">Sets configuration options for this provider</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#start()">start</a></strong>()</code>
<div class="block">Stops the instrumentation provider</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.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>&nbsp;instrument)</code>
<div class="block">Starts an instrument</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#startInstruments(org.apache.openjpa.lib.instrumentation.InstrumentationLevel,%20java.lang.Object)">startInstruments</a></strong>(<a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationLevel.html" title="enum in org.apache.openjpa.lib.instrumentation">InstrumentationLevel</a>&nbsp;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>&nbsp;context)</code>
<div class="block">Starts all instruments of the specified instrumentation 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/lib/instrumentation/InstrumentationProvider.html#stop()">stop</a></strong>()</code>
<div class="block">Starts 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/lib/instrumentation/InstrumentationProvider.html#stopInstrument(org.apache.openjpa.lib.instrumentation.Instrument)">stopInstrument</a></strong>(<a href="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</a>&nbsp;instrument)</code>
<div class="block">Stops 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/lib/instrumentation/InstrumentationProvider.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>&nbsp;instrument,
boolean&nbsp;force)</code>
<div class="block">Stops an instrument, forcing the stop, if necessary.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#stopInstruments(org.apache.openjpa.lib.instrumentation.InstrumentationLevel,%20java.lang.Object)">stopInstruments</a></strong>(<a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationLevel.html" title="enum in org.apache.openjpa.lib.instrumentation">InstrumentationLevel</a>&nbsp;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>&nbsp;context)</code>
<div class="block">Stops all instruments of the specified instrumentation level and context.</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="isStarted()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isStarted</h4>
<pre>boolean&nbsp;isStarted()</pre>
<div class="block">Whether the instrumentation provider started</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if the provider is started</dd></dl>
</li>
</ul>
<a name="stop()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stop</h4>
<pre>void&nbsp;stop()</pre>
<div class="block">Starts the instrumentation provider</div>
</li>
</ul>
<a name="start()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>start</h4>
<pre>void&nbsp;start()</pre>
<div class="block">Stops the instrumentation provider</div>
</li>
</ul>
<a name="getConfiguration()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfiguration</h4>
<pre><a href="../../../../../org/apache/openjpa/lib/conf/Configuration.html" title="interface in org.apache.openjpa.lib.conf">Configuration</a>&nbsp;getConfiguration()</pre>
<div class="block">Gets the configuration associated with the instrumentation provider</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the configuration associated with the provider</dd></dl>
</li>
</ul>
<a name="setInstrument(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInstrument</h4>
<pre>void&nbsp;setInstrument(<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>&nbsp;instruments)</pre>
<div class="block">Used to associate one or more instruments to a provider. Instruments
are specified by class name or alias. Multiple instruments must be
specified as a comma separated list.
example: DataCache,QueryCache,com.my.MyInstrument
where DataCache and QueryCache have aliases and com.my.MyInstrument is
a class implementing an Instrument.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>instruments</code> - one or more instrument class names or aliases</dd></dl>
</li>
</ul>
<a name="getInstrument()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstrument</h4>
<pre><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>&nbsp;getInstrument()</pre>
<div class="block">Returns the string-based list of instruments directly configured by
this provider via setInstrument.</div>
</li>
</ul>
<a name="setOptions(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOptions</h4>
<pre>void&nbsp;setOptions(<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>&nbsp;options)</pre>
<div class="block">Sets configuration options for this provider</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>options</code> - </dd></dl>
</li>
</ul>
<a name="getOptions()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOptions</h4>
<pre><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>&nbsp;getOptions()</pre>
<div class="block">Gets configuration options for this provider</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>options</code> - </dd></dl>
</li>
</ul>
<a name="getInstrumentAliases()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstrumentAliases</h4>
<pre><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>[]&nbsp;getInstrumentAliases()</pre>
<div class="block">Returns an string array of identifier to class name aliases for
instruments known to the instrumentation provider. Example:
{"DataCache", "org.apache.openjpa.instrumentation.DataCacheInstrument",
"QueryCache", "org.apache.openjpa.instrumentation.QueryCacheInstrument"}</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a string array of identifier, class name pairs.</dd></dl>
</li>
</ul>
<a name="addInstrument(org.apache.openjpa.lib.instrumentation.Instrument)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addInstrument</h4>
<pre>void&nbsp;addInstrument(<a href="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</a>&nbsp;instrument)</pre>
<div class="block">Adds an instrument to this providers list of managed instruments. The
instrument will participate in context-based lifecycle routines,
depending on the instrumentation level.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>instrument</code> - </dd></dl>
</li>
</ul>
<a name="stopInstruments(org.apache.openjpa.lib.instrumentation.InstrumentationLevel, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stopInstruments</h4>
<pre>void&nbsp;stopInstruments(<a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationLevel.html" title="enum in org.apache.openjpa.lib.instrumentation">InstrumentationLevel</a>&nbsp;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>&nbsp;context)</pre>
<div class="block">Stops all instruments of the specified instrumentation 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 (factory, broker, config)</dd></dl>
</li>
</ul>
<a name="startInstruments(org.apache.openjpa.lib.instrumentation.InstrumentationLevel, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startInstruments</h4>
<pre>void&nbsp;startInstruments(<a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationLevel.html" title="enum in org.apache.openjpa.lib.instrumentation">InstrumentationLevel</a>&nbsp;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>&nbsp;context)</pre>
<div class="block">Starts all instruments of the specified instrumentation 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 (factory, broker, config)</dd></dl>
</li>
</ul>
<a name="initializeInstrument(org.apache.openjpa.lib.instrumentation.Instrument, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initializeInstrument</h4>
<pre>void&nbsp;initializeInstrument(<a href="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</a>&nbsp;instrument,
<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>&nbsp;context)</pre>
<div class="block">Initializes an instrument within the provided context.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>instrument</code> - an instrument</dd><dd><code>context</code> - instrumentation context (factory, broker, config)</dd></dl>
</li>
</ul>
<a name="initializeInstrument(org.apache.openjpa.lib.instrumentation.Instrument, java.lang.String, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initializeInstrument</h4>
<pre>void&nbsp;initializeInstrument(<a href="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</a>&nbsp;instrument,
<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>&nbsp;options,
<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>&nbsp;context)</pre>
<div class="block">Initializes an instrument within the provided options and context.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>instrument</code> - an instrument</dd><dd><code>options</code> - configuration options to provide the instrument during initialization</dd><dd><code>context</code> - instrumentation context (factory, broker, config)</dd></dl>
</li>
</ul>
<a name="getInstrumentByName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstrumentByName</h4>
<pre><a href="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</a>&nbsp;getInstrumentByName(<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>&nbsp;name)</pre>
<div class="block">Returns an instrument instrumented by this provider by name</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the instrument to return</dd>
<dt><span class="strong">Returns:</span></dt><dd>the instrument or null if not instrumented by this provider</dd></dl>
</li>
</ul>
<a name="removeInstrumentByName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeInstrumentByName</h4>
<pre>void&nbsp;removeInstrumentByName(<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>&nbsp;name)</pre>
<div class="block">Removes an instrument instrumented by this provider by name</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the instrument to remove</dd></dl>
</li>
</ul>
<a name="getInstruments()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstruments</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>&lt;<a href="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</a>&gt;&nbsp;getInstruments()</pre>
<div class="block">Gets all instruments instrumented by this provider</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>instruments instrumented by this provider</dd></dl>
</li>
</ul>
<a name="startInstrument(org.apache.openjpa.lib.instrumentation.Instrument)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startInstrument</h4>
<pre>void&nbsp;startInstrument(<a href="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</a>&nbsp;instrument)</pre>
<div class="block">Starts an instrument</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)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stopInstrument</h4>
<pre>void&nbsp;stopInstrument(<a href="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</a>&nbsp;instrument)</pre>
<div class="block">Stops an instrument</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>instrument</code> - the instrument to stop</dd></dl>
</li>
</ul>
<a name="stopInstrument(org.apache.openjpa.lib.instrumentation.Instrument, boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>stopInstrument</h4>
<pre>void&nbsp;stopInstrument(<a href="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</a>&nbsp;instrument,
boolean&nbsp;force)</pre>
<div class="block">Stops an instrument, forcing the stop, if necessary.</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>
</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/InstrumentationProvider.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/lib/instrumentation/InstrumentationLevel.html" title="enum in org.apache.openjpa.lib.instrumentation"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html" target="_top">Frames</a></li>
<li><a href="InstrumentationProvider.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 &#169; 2006&#x2013;2017 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>