| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.6.0_22) on Wed Feb 16 14:00:55 CST 2011 --> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| InstrumentationProvider (OpenJPA Parent POM 2.1.0 API) |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2011-02-16"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="InstrumentationProvider (OpenJPA Parent POM 2.1.0 API)"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/InstrumentationProvider.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationLevel.html" title="enum in org.apache.openjpa.lib.instrumentation"><B>PREV CLASS</B></A> |
| NEXT CLASS</FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="InstrumentationProvider.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.apache.openjpa.lib.instrumentation</FONT> |
| <BR> |
| Interface InstrumentationProvider</H2> |
| <DL> |
| <DT><B>All Known Implementing Classes:</B> <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> |
| <DL> |
| <DT><PRE>public interface <B>InstrumentationProvider</B></DL> |
| </PRE> |
| |
| <P> |
| Pluggable instrumentation providers (ex. JMX) must implement this interface. It |
| provides methods for controlling the provider and the instruments instrumented |
| by the provider. |
| <P> |
| |
| <P> |
| <HR> |
| |
| <P> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#addInstrument(org.apache.openjpa.lib.instrumentation.Instrument)">addInstrument</A></B>(<A HREF="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</A> instrument)</CODE> |
| |
| <BR> |
| Adds an instrument to this providers list of managed instruments.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/openjpa/lib/conf/Configuration.html" title="interface in org.apache.openjpa.lib.conf">Configuration</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#getConfiguration()">getConfiguration</A></B>()</CODE> |
| |
| <BR> |
| Gets the configuration associated with the instrumentation provider</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#getInstrument()">getInstrument</A></B>()</CODE> |
| |
| <BR> |
| Returns the string-based list of instruments directly configured by |
| this provider via setInstrument.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#getInstrumentAliases()">getInstrumentAliases</A></B>()</CODE> |
| |
| <BR> |
| Returns an string array of identifier to class name aliases for |
| instruments known to the instrumentation provider.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#getInstrumentByName(java.lang.String)">getInstrumentByName</A></B>(<A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</CODE> |
| |
| <BR> |
| Returns an instrument instrumented by this provider by name</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/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/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#getInstruments()">getInstruments</A></B>()</CODE> |
| |
| <BR> |
| Gets all instruments instrumented by this provider</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#getOptions()">getOptions</A></B>()</CODE> |
| |
| <BR> |
| Gets configuration options for this provider</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#initializeInstrument(org.apache.openjpa.lib.instrumentation.Instrument, java.lang.Object)">initializeInstrument</A></B>(<A HREF="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</A> instrument, |
| <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> context)</CODE> |
| |
| <BR> |
| Initializes an instrument within the provided context.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#initializeInstrument(org.apache.openjpa.lib.instrumentation.Instrument, java.lang.String, java.lang.Object)">initializeInstrument</A></B>(<A HREF="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</A> instrument, |
| <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> options, |
| <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> context)</CODE> |
| |
| <BR> |
| Initializes an instrument within the provided options and context.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#isStarted()">isStarted</A></B>()</CODE> |
| |
| <BR> |
| Whether the instrumentation provider started</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#removeInstrumentByName(java.lang.String)">removeInstrumentByName</A></B>(<A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</CODE> |
| |
| <BR> |
| Removes an instrument instrumented by this provider by name</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#setInstrument(java.lang.String)">setInstrument</A></B>(<A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> instruments)</CODE> |
| |
| <BR> |
| Used to associate one or more instruments to a provider.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#setOptions(java.lang.String)">setOptions</A></B>(<A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> options)</CODE> |
| |
| <BR> |
| Sets configuration options for this provider</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#start()">start</A></B>()</CODE> |
| |
| <BR> |
| Stops the instrumentation provider</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#startInstrument(org.apache.openjpa.lib.instrumentation.Instrument)">startInstrument</A></B>(<A HREF="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</A> instrument)</CODE> |
| |
| <BR> |
| Starts an instrument</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#startInstruments(org.apache.openjpa.lib.instrumentation.InstrumentationLevel, java.lang.Object)">startInstruments</A></B>(<A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationLevel.html" title="enum in org.apache.openjpa.lib.instrumentation">InstrumentationLevel</A> level, |
| <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> context)</CODE> |
| |
| <BR> |
| Starts all instruments of the specified instrumentation level and context.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#stop()">stop</A></B>()</CODE> |
| |
| <BR> |
| Starts the instrumentation provider</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#stopInstrument(org.apache.openjpa.lib.instrumentation.Instrument)">stopInstrument</A></B>(<A HREF="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</A> instrument)</CODE> |
| |
| <BR> |
| Stops an instrument</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#stopInstrument(org.apache.openjpa.lib.instrumentation.Instrument, boolean)">stopInstrument</A></B>(<A HREF="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</A> instrument, |
| boolean force)</CODE> |
| |
| <BR> |
| Stops an instrument, forcing the stop, if necessary.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#stopInstruments(org.apache.openjpa.lib.instrumentation.InstrumentationLevel, java.lang.Object)">stopInstruments</A></B>(<A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationLevel.html" title="enum in org.apache.openjpa.lib.instrumentation">InstrumentationLevel</A> level, |
| <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> context)</CODE> |
| |
| <BR> |
| Stops all instruments of the specified instrumentation level and context.</TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="isStarted()"><!-- --></A><H3> |
| isStarted</H3> |
| <PRE> |
| boolean <B>isStarted</B>()</PRE> |
| <DL> |
| <DD>Whether the instrumentation provider started |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>true if the provider is started</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="stop()"><!-- --></A><H3> |
| stop</H3> |
| <PRE> |
| void <B>stop</B>()</PRE> |
| <DL> |
| <DD>Starts the instrumentation provider |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="start()"><!-- --></A><H3> |
| start</H3> |
| <PRE> |
| void <B>start</B>()</PRE> |
| <DL> |
| <DD>Stops the instrumentation provider |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getConfiguration()"><!-- --></A><H3> |
| getConfiguration</H3> |
| <PRE> |
| <A HREF="../../../../../org/apache/openjpa/lib/conf/Configuration.html" title="interface in org.apache.openjpa.lib.conf">Configuration</A> <B>getConfiguration</B>()</PRE> |
| <DL> |
| <DD>Gets the configuration associated with the instrumentation provider |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the configuration associated with the provider</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setInstrument(java.lang.String)"><!-- --></A><H3> |
| setInstrument</H3> |
| <PRE> |
| void <B>setInstrument</B>(<A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> instruments)</PRE> |
| <DL> |
| <DD>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. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>instruments</CODE> - one or more instrument class names or aliases</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getInstrument()"><!-- --></A><H3> |
| getInstrument</H3> |
| <PRE> |
| <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getInstrument</B>()</PRE> |
| <DL> |
| <DD>Returns the string-based list of instruments directly configured by |
| this provider via setInstrument. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setOptions(java.lang.String)"><!-- --></A><H3> |
| setOptions</H3> |
| <PRE> |
| void <B>setOptions</B>(<A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> options)</PRE> |
| <DL> |
| <DD>Sets configuration options for this provider |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>options</CODE> - </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getOptions()"><!-- --></A><H3> |
| getOptions</H3> |
| <PRE> |
| <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getOptions</B>()</PRE> |
| <DL> |
| <DD>Gets configuration options for this provider |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>options</CODE> - </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getInstrumentAliases()"><!-- --></A><H3> |
| getInstrumentAliases</H3> |
| <PRE> |
| <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] <B>getInstrumentAliases</B>()</PRE> |
| <DL> |
| <DD>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"} |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>a string array of identifier, class name pairs.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addInstrument(org.apache.openjpa.lib.instrumentation.Instrument)"><!-- --></A><H3> |
| addInstrument</H3> |
| <PRE> |
| void <B>addInstrument</B>(<A HREF="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</A> instrument)</PRE> |
| <DL> |
| <DD>Adds an instrument to this providers list of managed instruments. The |
| instrument will participate in context-based lifecycle routines, |
| depending on the instrumentation level. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>instrument</CODE> - </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="stopInstruments(org.apache.openjpa.lib.instrumentation.InstrumentationLevel, java.lang.Object)"><!-- --></A><H3> |
| stopInstruments</H3> |
| <PRE> |
| void <B>stopInstruments</B>(<A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationLevel.html" title="enum in org.apache.openjpa.lib.instrumentation">InstrumentationLevel</A> level, |
| <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> context)</PRE> |
| <DL> |
| <DD>Stops all instruments of the specified instrumentation level and context. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>level</CODE> - instrumentation level<DD><CODE>context</CODE> - instrumentation context (factory, broker, config)</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="startInstruments(org.apache.openjpa.lib.instrumentation.InstrumentationLevel, java.lang.Object)"><!-- --></A><H3> |
| startInstruments</H3> |
| <PRE> |
| void <B>startInstruments</B>(<A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationLevel.html" title="enum in org.apache.openjpa.lib.instrumentation">InstrumentationLevel</A> level, |
| <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> context)</PRE> |
| <DL> |
| <DD>Starts all instruments of the specified instrumentation level and context. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>level</CODE> - instrumentation level<DD><CODE>context</CODE> - instrumentation context (factory, broker, config)</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="initializeInstrument(org.apache.openjpa.lib.instrumentation.Instrument, java.lang.Object)"><!-- --></A><H3> |
| initializeInstrument</H3> |
| <PRE> |
| void <B>initializeInstrument</B>(<A HREF="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</A> instrument, |
| <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> context)</PRE> |
| <DL> |
| <DD>Initializes an instrument within the provided context. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>instrument</CODE> - an instrument<DD><CODE>context</CODE> - instrumentation context (factory, broker, config)</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="initializeInstrument(org.apache.openjpa.lib.instrumentation.Instrument, java.lang.String, java.lang.Object)"><!-- --></A><H3> |
| initializeInstrument</H3> |
| <PRE> |
| void <B>initializeInstrument</B>(<A HREF="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</A> instrument, |
| <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> options, |
| <A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> context)</PRE> |
| <DL> |
| <DD>Initializes an instrument within the provided options and context. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>instrument</CODE> - an instrument<DD><CODE>options</CODE> - configuration options to provide the instrument during initialization<DD><CODE>context</CODE> - instrumentation context (factory, broker, config)</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getInstrumentByName(java.lang.String)"><!-- --></A><H3> |
| getInstrumentByName</H3> |
| <PRE> |
| <A HREF="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</A> <B>getInstrumentByName</B>(<A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</PRE> |
| <DL> |
| <DD>Returns an instrument instrumented by this provider by name |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the instrument to return |
| <DT><B>Returns:</B><DD>the instrument or null if not instrumented by this provider</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removeInstrumentByName(java.lang.String)"><!-- --></A><H3> |
| removeInstrumentByName</H3> |
| <PRE> |
| void <B>removeInstrumentByName</B>(<A HREF="http://java.sun.com/j2se/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</PRE> |
| <DL> |
| <DD>Removes an instrument instrumented by this provider by name |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the instrument to remove</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getInstruments()"><!-- --></A><H3> |
| getInstruments</H3> |
| <PRE> |
| <A HREF="http://java.sun.com/j2se/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/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</A>> <B>getInstruments</B>()</PRE> |
| <DL> |
| <DD>Gets all instruments instrumented by this provider |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>instruments instrumented by this provider</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="startInstrument(org.apache.openjpa.lib.instrumentation.Instrument)"><!-- --></A><H3> |
| startInstrument</H3> |
| <PRE> |
| void <B>startInstrument</B>(<A HREF="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</A> instrument)</PRE> |
| <DL> |
| <DD>Starts an instrument |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>instrument</CODE> - this instrument to start</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="stopInstrument(org.apache.openjpa.lib.instrumentation.Instrument)"><!-- --></A><H3> |
| stopInstrument</H3> |
| <PRE> |
| void <B>stopInstrument</B>(<A HREF="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</A> instrument)</PRE> |
| <DL> |
| <DD>Stops an instrument |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>instrument</CODE> - the instrument to stop</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="stopInstrument(org.apache.openjpa.lib.instrumentation.Instrument, boolean)"><!-- --></A><H3> |
| stopInstrument</H3> |
| <PRE> |
| void <B>stopInstrument</B>(<A HREF="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</A> instrument, |
| boolean force)</PRE> |
| <DL> |
| <DD>Stops an instrument, forcing the stop, if necessary. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>instrument</CODE> - the instrument to stop<DD><CODE>force</CODE> - forces the stop if the instrument does not stop gracefully.</DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/InstrumentationProvider.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationLevel.html" title="enum in org.apache.openjpa.lib.instrumentation"><B>PREV CLASS</B></A> |
| NEXT CLASS</FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="InstrumentationProvider.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2006-2011 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |
