blob: 3d1c3f9cd6b62ed3177fd807caba97380a4fe603 [file] [log] [blame]
<!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_43) on Tue Apr 16 17:05:01 CDT 2013 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
AbstractInstrumentationProvider (OpenJPA Parent POM 2.2.2 API)
</TITLE>
<META NAME="date" CONTENT="2013-04-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="AbstractInstrumentationProvider (OpenJPA Parent POM 2.2.2 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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/AbstractInstrumentationProvider.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrument.html" title="class in org.apache.openjpa.lib.instrumentation"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="AbstractInstrumentationProvider.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<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>
Class AbstractInstrumentationProvider</H2>
<PRE>
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.openjpa.lib.instrumentation.AbstractInstrumentationProvider</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/apache/openjpa/lib/conf/Configurable.html" title="interface in org.apache.openjpa.lib.conf">Configurable</A>, <A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html" title="interface in org.apache.openjpa.lib.instrumentation">InstrumentationProvider</A></DD>
</DL>
<DL>
<DT><B>Direct Known Subclasses:</B> <DD><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 abstract class <B>AbstractInstrumentationProvider</B><DT>extends <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><DT>implements <A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html" title="interface in org.apache.openjpa.lib.instrumentation">InstrumentationProvider</A>, <A HREF="../../../../../org/apache/openjpa/lib/conf/Configurable.html" title="interface in org.apache.openjpa.lib.conf">Configurable</A></DL>
</PRE>
<P>
Specialized instrumentation providers can extend this class to get basic
provider state and capabilities. It implements Configurable so it can
be used within the configuration framework to participate in automatic
configuration.
<P>
<P>
<HR>
<P>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_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>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html#AbstractInstrumentationProvider()">AbstractInstrumentationProvider</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== 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>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.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>&nbsp;instrument)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html#endConfiguration()">endConfiguration</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Invoked upon completion of bean property configuration for this object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<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/AbstractInstrumentationProvider.html#getConfiguration()">getConfiguration</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>&nbsp;<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></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html#getInstrument()">getInstrument</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>&nbsp;<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></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html#getInstrumentAliases()">getInstrumentAliases</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>&nbsp;<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/AbstractInstrumentationProvider.html#getInstrumentByName(java.lang.String)">getInstrumentByName</A></B>(<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>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>&nbsp;<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></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html#getInstruments()">getInstruments</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>&nbsp;<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></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html#getOptions()">getOptions</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets configuration options for this provider</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.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>&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>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.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>&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>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html#isStarted()">isStarted</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Whether the instrumentation provider started</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html#removeInstrumentByName(java.lang.String)">removeInstrumentByName</A></B>(<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>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html#setConfiguration(org.apache.openjpa.lib.conf.Configuration)">setConfiguration</A></B>(<A HREF="../../../../../org/apache/openjpa/lib/conf/Configuration.html" title="interface in org.apache.openjpa.lib.conf">Configuration</A>&nbsp;conf)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Invoked prior to setting bean properties.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html#setInstrument(java.lang.String)">setInstrument</A></B>(<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;instrument)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html#setOptions(java.lang.String)">setOptions</A></B>(<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>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets configuration options for this provider</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html#setStarted(boolean)">setStarted</A></B>(boolean&nbsp;started)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>abstract &nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html#start()">start</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Stops the instrumentation provider</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html#startConfiguration()">startConfiguration</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Invoked before bean property configuration is begun on this object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.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>&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>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>abstract &nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html#stop()">stop</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Starts the instrumentation provider</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.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>&nbsp;instrument)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Stops an instrument</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.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>&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>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Stops all instruments of the specified instrumentation level and context.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.apache.openjpa.lib.instrumentation.InstrumentationProvider"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface org.apache.openjpa.lib.instrumentation.<A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html" title="interface in org.apache.openjpa.lib.instrumentation">InstrumentationProvider</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#startInstrument(org.apache.openjpa.lib.instrumentation.Instrument)">startInstrument</A>, <A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#stopInstrument(org.apache.openjpa.lib.instrumentation.Instrument, boolean)">stopInstrument</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_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>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="AbstractInstrumentationProvider()"><!-- --></A><H3>
AbstractInstrumentationProvider</H3>
<PRE>
public <B>AbstractInstrumentationProvider</B>()</PRE>
<DL>
</DL>
<!-- ============ 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="setConfiguration(org.apache.openjpa.lib.conf.Configuration)"><!-- --></A><H3>
setConfiguration</H3>
<PRE>
public void <B>setConfiguration</B>(<A HREF="../../../../../org/apache/openjpa/lib/conf/Configuration.html" title="interface in org.apache.openjpa.lib.conf">Configuration</A>&nbsp;conf)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/openjpa/lib/conf/Configurable.html#setConfiguration(org.apache.openjpa.lib.conf.Configuration)">Configurable</A></CODE></B></DD>
<DD>Invoked prior to setting bean properties.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/lib/conf/Configurable.html#setConfiguration(org.apache.openjpa.lib.conf.Configuration)">setConfiguration</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/lib/conf/Configurable.html" title="interface in org.apache.openjpa.lib.conf">Configurable</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getConfiguration()"><!-- --></A><H3>
getConfiguration</H3>
<PRE>
public <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><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#getConfiguration()">InstrumentationProvider</A></CODE></B></DD>
<DD>Gets the configuration associated with the instrumentation provider
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#getConfiguration()">getConfiguration</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html" title="interface in org.apache.openjpa.lib.instrumentation">InstrumentationProvider</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the configuration associated with the provider</DL>
</DD>
</DL>
<HR>
<A NAME="startConfiguration()"><!-- --></A><H3>
startConfiguration</H3>
<PRE>
public void <B>startConfiguration</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/openjpa/lib/conf/Configurable.html#startConfiguration()">Configurable</A></CODE></B></DD>
<DD>Invoked before bean property configuration is begun on this object.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/lib/conf/Configurable.html#startConfiguration()">startConfiguration</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/lib/conf/Configurable.html" title="interface in org.apache.openjpa.lib.conf">Configurable</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="endConfiguration()"><!-- --></A><H3>
endConfiguration</H3>
<PRE>
public void <B>endConfiguration</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/openjpa/lib/conf/Configurable.html#endConfiguration()">Configurable</A></CODE></B></DD>
<DD>Invoked upon completion of bean property configuration for this object.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/lib/conf/Configurable.html#endConfiguration()">endConfiguration</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/lib/conf/Configurable.html" title="interface in org.apache.openjpa.lib.conf">Configurable</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setInstrument(java.lang.String)"><!-- --></A><H3>
setInstrument</H3>
<PRE>
public void <B>setInstrument</B>(<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;instrument)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#setInstrument(java.lang.String)">InstrumentationProvider</A></CODE></B></DD>
<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>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#setInstrument(java.lang.String)">setInstrument</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html" title="interface in org.apache.openjpa.lib.instrumentation">InstrumentationProvider</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>instrument</CODE> - one or more instrument class names or aliases</DL>
</DD>
</DL>
<HR>
<A NAME="getInstrument()"><!-- --></A><H3>
getInstrument</H3>
<PRE>
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getInstrument</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#getInstrument()">InstrumentationProvider</A></CODE></B></DD>
<DD>Returns the string-based list of instruments directly configured by
this provider via setInstrument.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#getInstrument()">getInstrument</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html" title="interface in org.apache.openjpa.lib.instrumentation">InstrumentationProvider</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD></DL>
</DD>
</DL>
<HR>
<A NAME="setOptions(java.lang.String)"><!-- --></A><H3>
setOptions</H3>
<PRE>
public void <B>setOptions</B>(<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>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#setOptions(java.lang.String)">InstrumentationProvider</A></CODE></B></DD>
<DD>Sets configuration options for this provider
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#setOptions(java.lang.String)">setOptions</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html" title="interface in org.apache.openjpa.lib.instrumentation">InstrumentationProvider</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getOptions()"><!-- --></A><H3>
getOptions</H3>
<PRE>
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getOptions</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#getOptions()">InstrumentationProvider</A></CODE></B></DD>
<DD>Gets configuration options for this provider
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#getOptions()">getOptions</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html" title="interface in org.apache.openjpa.lib.instrumentation">InstrumentationProvider</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="addInstrument(org.apache.openjpa.lib.instrumentation.Instrument)"><!-- --></A><H3>
addInstrument</H3>
<PRE>
public void <B>addInstrument</B>(<A HREF="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</A>&nbsp;instrument)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#addInstrument(org.apache.openjpa.lib.instrumentation.Instrument)">InstrumentationProvider</A></CODE></B></DD>
<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>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#addInstrument(org.apache.openjpa.lib.instrumentation.Instrument)">addInstrument</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html" title="interface in org.apache.openjpa.lib.instrumentation">InstrumentationProvider</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="initializeInstrument(org.apache.openjpa.lib.instrumentation.Instrument, java.lang.Object)"><!-- --></A><H3>
initializeInstrument</H3>
<PRE>
public void <B>initializeInstrument</B>(<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>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#initializeInstrument(org.apache.openjpa.lib.instrumentation.Instrument, java.lang.Object)">InstrumentationProvider</A></CODE></B></DD>
<DD>Initializes an instrument within the provided context.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#initializeInstrument(org.apache.openjpa.lib.instrumentation.Instrument, java.lang.Object)">initializeInstrument</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html" title="interface in org.apache.openjpa.lib.instrumentation">InstrumentationProvider</A></CODE></DL>
</DD>
<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>
public void <B>initializeInstrument</B>(<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>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#initializeInstrument(org.apache.openjpa.lib.instrumentation.Instrument, java.lang.String, java.lang.Object)">InstrumentationProvider</A></CODE></B></DD>
<DD>Initializes an instrument within the provided options and context.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#initializeInstrument(org.apache.openjpa.lib.instrumentation.Instrument, java.lang.String, java.lang.Object)">initializeInstrument</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html" title="interface in org.apache.openjpa.lib.instrumentation">InstrumentationProvider</A></CODE></DL>
</DD>
<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>
public <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://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>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#getInstrumentByName(java.lang.String)">InstrumentationProvider</A></CODE></B></DD>
<DD>Returns an instrument instrumented by this provider by name
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#getInstrumentByName(java.lang.String)">getInstrumentByName</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html" title="interface in org.apache.openjpa.lib.instrumentation">InstrumentationProvider</A></CODE></DL>
</DD>
<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="getInstruments()"><!-- --></A><H3>
getInstruments</H3>
<PRE>
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A>&lt;<A HREF="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</A>&gt; <B>getInstruments</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#getInstruments()">InstrumentationProvider</A></CODE></B></DD>
<DD>Gets all instruments instrumented by this provider
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#getInstruments()">getInstruments</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html" title="interface in org.apache.openjpa.lib.instrumentation">InstrumentationProvider</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>instruments instrumented by this provider</DL>
</DD>
</DL>
<HR>
<A NAME="stopInstruments(org.apache.openjpa.lib.instrumentation.InstrumentationLevel, java.lang.Object)"><!-- --></A><H3>
stopInstruments</H3>
<PRE>
public void <B>stopInstruments</B>(<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>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#stopInstruments(org.apache.openjpa.lib.instrumentation.InstrumentationLevel, java.lang.Object)">InstrumentationProvider</A></CODE></B></DD>
<DD>Stops all instruments of the specified instrumentation level and context.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#stopInstruments(org.apache.openjpa.lib.instrumentation.InstrumentationLevel, java.lang.Object)">stopInstruments</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html" title="interface in org.apache.openjpa.lib.instrumentation">InstrumentationProvider</A></CODE></DL>
</DD>
<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>
public void <B>startInstruments</B>(<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>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#startInstruments(org.apache.openjpa.lib.instrumentation.InstrumentationLevel, java.lang.Object)">InstrumentationProvider</A></CODE></B></DD>
<DD>Starts all instruments of the specified instrumentation level and context.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#startInstruments(org.apache.openjpa.lib.instrumentation.InstrumentationLevel, java.lang.Object)">startInstruments</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html" title="interface in org.apache.openjpa.lib.instrumentation">InstrumentationProvider</A></CODE></DL>
</DD>
<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="stopInstrument(org.apache.openjpa.lib.instrumentation.Instrument)"><!-- --></A><H3>
stopInstrument</H3>
<PRE>
public void <B>stopInstrument</B>(<A HREF="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</A>&nbsp;instrument)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#stopInstrument(org.apache.openjpa.lib.instrumentation.Instrument)">InstrumentationProvider</A></CODE></B></DD>
<DD>Stops an instrument
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#stopInstrument(org.apache.openjpa.lib.instrumentation.Instrument)">stopInstrument</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html" title="interface in org.apache.openjpa.lib.instrumentation">InstrumentationProvider</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>instrument</CODE> - the instrument to stop</DL>
</DD>
</DL>
<HR>
<A NAME="removeInstrumentByName(java.lang.String)"><!-- --></A><H3>
removeInstrumentByName</H3>
<PRE>
public void <B>removeInstrumentByName</B>(<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>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#removeInstrumentByName(java.lang.String)">InstrumentationProvider</A></CODE></B></DD>
<DD>Removes an instrument instrumented by this provider by name
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#removeInstrumentByName(java.lang.String)">removeInstrumentByName</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html" title="interface in org.apache.openjpa.lib.instrumentation">InstrumentationProvider</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the instrument to remove</DL>
</DD>
</DL>
<HR>
<A NAME="isStarted()"><!-- --></A><H3>
isStarted</H3>
<PRE>
public boolean <B>isStarted</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#isStarted()">InstrumentationProvider</A></CODE></B></DD>
<DD>Whether the instrumentation provider started
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#isStarted()">isStarted</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html" title="interface in org.apache.openjpa.lib.instrumentation">InstrumentationProvider</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>true if the provider is started</DL>
</DD>
</DL>
<HR>
<A NAME="setStarted(boolean)"><!-- --></A><H3>
setStarted</H3>
<PRE>
protected void <B>setStarted</B>(boolean&nbsp;started)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getInstrumentAliases()"><!-- --></A><H3>
getInstrumentAliases</H3>
<PRE>
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] <B>getInstrumentAliases</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#getInstrumentAliases()">InstrumentationProvider</A></CODE></B></DD>
<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>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#getInstrumentAliases()">getInstrumentAliases</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html" title="interface in org.apache.openjpa.lib.instrumentation">InstrumentationProvider</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>a string array of identifier, class name pairs.</DL>
</DD>
</DL>
<HR>
<A NAME="start()"><!-- --></A><H3>
start</H3>
<PRE>
public abstract void <B>start</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#start()">InstrumentationProvider</A></CODE></B></DD>
<DD>Stops the instrumentation provider
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#start()">start</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html" title="interface in org.apache.openjpa.lib.instrumentation">InstrumentationProvider</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="stop()"><!-- --></A><H3>
stop</H3>
<PRE>
public abstract void <B>stop</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#stop()">InstrumentationProvider</A></CODE></B></DD>
<DD>Starts the instrumentation provider
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html#stop()">stop</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html" title="interface in org.apache.openjpa.lib.instrumentation">InstrumentationProvider</A></CODE></DL>
</DD>
<DD><DL>
</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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/AbstractInstrumentationProvider.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrument.html" title="class in org.apache.openjpa.lib.instrumentation"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="AbstractInstrumentationProvider.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright &#169; 2006-2013 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved.
</BODY>
</HTML>