| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="it"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_80) on Thu Jun 14 10:03:56 CEST 2018 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Instrument (OpenJPA Parent POM 2.4.3 API)</title> |
| <meta name="date" content="2018-06-14"> |
| <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="Instrument (OpenJPA Parent POM 2.4.3 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/Instrument.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/AbstractInstrumentationProvider.html" title="class in org.apache.openjpa.lib.instrumentation"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationLevel.html" title="enum in org.apache.openjpa.lib.instrumentation"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/openjpa/lib/instrumentation/Instrument.html" target="_top">Frames</a></li> |
| <li><a href="Instrument.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.lib.instrumentation</div> |
| <h2 title="Interface Instrument" class="title">Interface Instrument</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../../org/apache/openjpa/instrumentation/jmx/JMXInstrument.html" title="interface in org.apache.openjpa.instrumentation.jmx">JMXInstrument</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html" title="class in org.apache.openjpa.instrumentation">AbstractDataCacheInstrument</a>, <a href="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrument.html" title="class in org.apache.openjpa.lib.instrumentation">AbstractInstrument</a>, <a href="../../../../../org/apache/openjpa/instrumentation/AbstractPreparedQueryCacheInstrument.html" title="class in org.apache.openjpa.instrumentation">AbstractPreparedQueryCacheInstrument</a>, <a href="../../../../../org/apache/openjpa/instrumentation/AbstractQueryCacheInstrument.html" title="class in org.apache.openjpa.instrumentation">AbstractQueryCacheInstrument</a>, <a href="../../../../../org/apache/openjpa/instrumentation/jmx/DataCacheJMXInstrument.html" title="class in org.apache.openjpa.instrumentation.jmx">DataCacheJMXInstrument</a>, <a href="../../../../../org/apache/openjpa/instrumentation/jmx/PreparedQueryCacheJMXInstrument.html" title="class in org.apache.openjpa.instrumentation.jmx">PreparedQueryCacheJMXInstrument</a>, <a href="../../../../../org/apache/openjpa/instrumentation/jmx/QueryCacheJMXInstrument.html" title="class in org.apache.openjpa.instrumentation.jmx">QueryCacheJMXInstrument</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">Instrument</span></pre> |
| <div class="block">Interface that must be implemented by instruments.</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://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html#getContext()">getContext</a></strong>()</code> |
| <div class="block">Gets the context of the instrument.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationLevel.html" title="enum in org.apache.openjpa.lib.instrumentation">InstrumentationLevel</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html#getLevel()">getLevel</a></strong>()</code> |
| <div class="block">Gets the instrumentation level of this instrument.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.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/Instrument.html#getName()">getName</a></strong>()</code> |
| <div class="block">Returns the name of the instrument.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.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/Instrument.html#getOptions()">getOptions</a></strong>()</code> |
| <div class="block">Returns the options specified for the instrument in string form.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><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/lib/instrumentation/Instrument.html#getProvider()">getProvider</a></strong>()</code> |
| <div class="block">Gets the instrumentation provider for the 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/Instrument.html#initialize()">initialize</a></strong>()</code> |
| <div class="block">Initializes the instrument.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html#isStarted()">isStarted</a></strong>()</code> |
| <div class="block">Returns true if the instrument is started.</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/Instrument.html#restart()">restart</a></strong>()</code> |
| <div class="block">Restarts the 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/Instrument.html#setContext(java.lang.Object)">setContext</a></strong>(<a href="http://docs.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">Sets the context of the 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/Instrument.html#setOptions(java.lang.String)">setOptions</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> options)</code> |
| <div class="block">Sets options to specify for the instrument in standard string form.</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/Instrument.html#setProvider(org.apache.openjpa.lib.instrumentation.InstrumentationProvider)">setProvider</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">Sets the instrumentation provider for the 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/Instrument.html#setStarted(boolean)">setStarted</a></strong>(boolean started)</code> |
| <div class="block">Sets whether the instrument is an available state.</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/Instrument.html#start()">start</a></strong>()</code> |
| <div class="block">Starts the 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/Instrument.html#stop()">stop</a></strong>()</code> |
| <div class="block">Starts the instrument.</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="getName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getName</h4> |
| <pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getName()</pre> |
| <div class="block">Returns the name of the instrument. Must be unique per-provider.</div> |
| </li> |
| </ul> |
| <a name="getOptions()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOptions</h4> |
| <pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getOptions()</pre> |
| <div class="block">Returns the options specified for the instrument in string form.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>options configuration options for the instrument</dd></dl> |
| </li> |
| </ul> |
| <a name="setOptions(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setOptions</h4> |
| <pre>void setOptions(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> options)</pre> |
| <div class="block">Sets options to specify for the instrument in standard string form. |
| ex. DataCache(Options='Start=true')</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>options</code> - options</dd></dl> |
| </li> |
| </ul> |
| <a name="getContext()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContext</h4> |
| <pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getContext()</pre> |
| <div class="block">Gets the context of the instrument. Typically, a reference to a broker |
| or broker factory.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the context associated with the instrument.</dd></dl> |
| </li> |
| </ul> |
| <a name="setContext(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setContext</h4> |
| <pre>void setContext(<a href="http://docs.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">Sets the context of the instrument. Typically, a reference to a broker |
| or broker factory.</div> |
| </li> |
| </ul> |
| <a name="setProvider(org.apache.openjpa.lib.instrumentation.InstrumentationProvider)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setProvider</h4> |
| <pre>void setProvider(<a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html" title="interface in org.apache.openjpa.lib.instrumentation">InstrumentationProvider</a> provider)</pre> |
| <div class="block">Sets the instrumentation provider for the instrument.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>provider</code> - instrumentation provider of the instrument</dd></dl> |
| </li> |
| </ul> |
| <a name="getProvider()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProvider</h4> |
| <pre><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html" title="interface in org.apache.openjpa.lib.instrumentation">InstrumentationProvider</a> getProvider()</pre> |
| <div class="block">Gets the instrumentation provider for the instrument.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>instrumentation provider of the instrument</dd></dl> |
| </li> |
| </ul> |
| <a name="initialize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initialize</h4> |
| <pre>void initialize()</pre> |
| <div class="block">Initializes the instrument. Depending on the instrument, the provider, |
| options, and various options may need to be set before calling this method.</div> |
| </li> |
| </ul> |
| <a name="getLevel()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLevel</h4> |
| <pre><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationLevel.html" title="enum in org.apache.openjpa.lib.instrumentation">InstrumentationLevel</a> getLevel()</pre> |
| <div class="block">Gets the instrumentation level of this instrument. The instrumentation level |
| determines if and when the instrument will automatically start and stop.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the instrumentation level of the instrument</dd></dl> |
| </li> |
| </ul> |
| <a name="isStarted()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isStarted</h4> |
| <pre>boolean isStarted()</pre> |
| <div class="block">Returns true if the instrument is started.</div> |
| </li> |
| </ul> |
| <a name="setStarted(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setStarted</h4> |
| <pre>void setStarted(boolean started)</pre> |
| <div class="block">Sets whether the instrument is an available state.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>started</code> - </dd></dl> |
| </li> |
| </ul> |
| <a name="start()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>start</h4> |
| <pre>void start()</pre> |
| <div class="block">Starts the instrument. Typically this will be performed through the provider, |
| but in some cases an instrument will have its own specialized startup.</div> |
| </li> |
| </ul> |
| <a name="stop()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stop</h4> |
| <pre>void stop()</pre> |
| <div class="block">Starts the instrument. Typically this will be performed through the provider, |
| but in some cases an instrument will have its own specialized shutdown.</div> |
| </li> |
| </ul> |
| <a name="restart()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>restart</h4> |
| <pre>void restart()</pre> |
| <div class="block">Restarts the instrument. Typically this will be performed through the provider, |
| but in some cases an instrument will have its own specialized restart.</div> |
| </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/Instrument.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/AbstractInstrumentationProvider.html" title="class in org.apache.openjpa.lib.instrumentation"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationLevel.html" title="enum in org.apache.openjpa.lib.instrumentation"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/openjpa/lib/instrumentation/Instrument.html" target="_top">Frames</a></li> |
| <li><a href="Instrument.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–2018 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
