MonitoringClient.html revision d81978a0815d5b8a75633c35e3e1f8708d36f017
<!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_06) on Wed Jun 25 13:23:27 CEST 2008 -->
<TITLE>
MonitoringClient
</TITLE>
<META NAME="date" CONTENT="2008-06-25">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="MonitoringClient";
}
}
</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="/org/opends/testqa/monitoringclient/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/MonitoringClient.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-files/index-1.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/opends/testqa/monitoringclient/LDAPMonitor.html" title="class in org.opends.testqa.monitoringclient"><B>PREV CLASS</B></A>
<A HREF="/org/opends/testqa/monitoringclient/SNMPMonitor.html" title="class in org.opends.testqa.monitoringclient"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="/index.html?org/opends/testqa/monitoringclient/MonitoringClient.html" target="_top"><B>FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="/allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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">
<BR>
Class MonitoringClient</H2>
<PRE>
<IMG SRC="/resources/inherit.gif" ALT="extended by "><B>org.opends.testqa.monitoringclient.MonitoringClient</B>
</PRE>
<HR>
<DL>
</PRE>
<P>
Main class of the monitoring client.
<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/opends/testqa/monitoringclient/MonitoringClient.html#MonitoringClient(java.util.Properties)">MonitoringClient</A></B>(java.util.Properties parsedArguments)</CODE>
<BR>
Wake up the producers very interval of time.</TD>
</TR>
</TABLE>
<!-- ========== 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">
<TD><CODE><B><A HREF="/org/opends/testqa/monitoringclient/MonitoringClient.html#argumentParser(java.lang.String[])">argumentParser</A></B>(java.lang.String[] args)</CODE>
<BR>
Parse the command line argument.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="/org/opends/testqa/monitoringclient/DatasBuffer.html" title="class in org.opends.testqa.monitoringclient">DatasBuffer</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="/org/opends/testqa/monitoringclient/MonitoringClient.html#getDatasBuffer()">getDatasBuffer</A></B>()</CODE>
<BR>
Returns the buffer for the datas.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="/org/opends/testqa/monitoringclient/ErrorsBuffer.html" title="class in org.opends.testqa.monitoringclient">ErrorsBuffer</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="/org/opends/testqa/monitoringclient/MonitoringClient.html#getErrorsBuffer()">getErrorsBuffer</A></B>()</CODE>
<BR>
Returns the buffer for the errors.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="/org/opends/testqa/monitoringclient/MonitoringClient.html#getInterval()">getInterval</A></B>()</CODE>
<BR>
Returns the interval.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="/org/opends/testqa/monitoringclient/MonitoringClient.html#getNbConsumers()">getNbConsumers</A></B>()</CODE>
<BR>
Returns the number of consumers.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="/org/opends/testqa/monitoringclient/MonitoringClient.html#getTimeUnit()">getTimeUnit</A></B>()</CODE>
<BR>
Return the time unit.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static void</CODE></FONT></TD>
<TD><CODE><B><A HREF="/org/opends/testqa/monitoringclient/MonitoringClient.html#main(java.lang.String[])">main</A></B>(java.lang.String[] args)</CODE>
<BR>
The main method of the MonitoringClient class.</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/opends/testqa/monitoringclient/MonitoringClient.html#setProducersConfig(java.util.Hashtable)">setProducersConfig</A></B>(java.util.Hashtable producersConfig)</CODE>
<BR>
Sets the properties of the producers.</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/opends/testqa/monitoringclient/MonitoringClient.html#start()">start</A></B>()</CODE>
<BR>
Start the producers and de consumers and wake up the producers every
interval of time.</TD>
</TR>
</TABLE>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<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>
MonitoringClient</H3>
<PRE>
<DL>
<DD>Wake up the producers very interval of time.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>parsedArguments</CODE> - The parsed arguments</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>
main</H3>
<PRE>
<DL>
<DD>The main method of the MonitoringClient class.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>args</CODE> - The command-line arguments provided to this program.</DL>
</DD>
</DL>
<HR>
<A NAME="start()"><!-- --></A><H3>
start</H3>
<PRE>
public void <B>start</B>()</PRE>
<DL>
<DD>Start the producers and de consumers and wake up the producers every
interval of time.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getDatasBuffer()"><!-- --></A><H3>
getDatasBuffer</H3>
<PRE>
public <A HREF="/org/opends/testqa/monitoringclient/DatasBuffer.html" title="class in org.opends.testqa.monitoringclient">DatasBuffer</A> <B>getDatasBuffer</B>()</PRE>
<DL>
<DD>Returns the buffer for the datas.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>The buffer for the datas.</DL>
</DD>
</DL>
<HR>
<A NAME="getErrorsBuffer()"><!-- --></A><H3>
getErrorsBuffer</H3>
<PRE>
public <A HREF="/org/opends/testqa/monitoringclient/ErrorsBuffer.html" title="class in org.opends.testqa.monitoringclient">ErrorsBuffer</A> <B>getErrorsBuffer</B>()</PRE>
<DL>
<DD>Returns the buffer for the errors.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>The buffer for the errors.</DL>
</DD>
</DL>
<HR>
<A NAME="getInterval()"><!-- --></A><H3>
getInterval</H3>
<PRE>
public int <B>getInterval</B>()</PRE>
<DL>
<DD>Returns the interval.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>The interval of time between each threads wake up.</DL>
</DD>
</DL>
<HR>
<A NAME="getTimeUnit()"><!-- --></A><H3>
getTimeUnit</H3>
<PRE>
public int <B>getTimeUnit</B>()</PRE>
<DL>
<DD>Return the time unit.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the time unit</DL>
</DD>
</DL>
<HR>
<A NAME="getNbConsumers()"><!-- --></A><H3>
getNbConsumers</H3>
<PRE>
public int <B>getNbConsumers</B>()</PRE>
<DL>
<DD>Returns the number of consumers.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>The number of consumers.</DL>
</DD>
</DL>
<HR>
setProducersConfig</H3>
<PRE>
<DL>
<DD>Sets the properties of the producers.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>producersConfig</CODE> - The properties of the producers.</DL>
</DD>
</DL>
<HR>
argumentParser</H3>
<PRE>
<DL>
<DD>Parse the command line argument.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>args</CODE> - the command line argument
<DT><B>Returns:</B><DD>the parsed argument</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="/org/opends/testqa/monitoringclient/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/MonitoringClient.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-files/index-1.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/opends/testqa/monitoringclient/LDAPMonitor.html" title="class in org.opends.testqa.monitoringclient"><B>PREV CLASS</B></A>
<A HREF="/org/opends/testqa/monitoringclient/SNMPMonitor.html" title="class in org.opends.testqa.monitoringclient"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="/index.html?org/opends/testqa/monitoringclient/MonitoringClient.html" target="_top"><B>FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="/allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>