Blame | Last modification | View Log | RSS feed
<!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_26) on Fri Aug 17 13:40:05 IST 2012 --><TITLE>Alert (stat4j API)</TITLE><META NAME="date" CONTENT="2012-08-17"><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="Alert (stat4j 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/Alert.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"> PREV CLASS <A HREF="../../../net/sourceforge/stat4j/AlertTest.html" title="class in net.sourceforge.stat4j"><B>NEXT CLASS</B></A></FONT></TD><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"><A HREF="../../../index.html?net/sourceforge/stat4j/Alert.html" target="_top"><B>FRAMES</B></A> <A HREF="Alert.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">DETAIL: <A HREF="#field_detail">FIELD</A> | <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">net.sourceforge.stat4j</FONT><BR>Class Alert</H2><PRE>java.lang.Object<IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>net.sourceforge.stat4j.Alert</B></PRE><HR><DL><DT><PRE>public final class <B>Alert</B><DT>extends java.lang.Object</DL></PRE><P>Name: Alert.java Date: Sep 6, 2004 Description:Simple threshold based alert.This class represents a pre-configured alert for a statistic.The alert will be evaluated every time the statistic is updated. (alertsuppresion is not supported in this version)If the alert fires (either WARN or CRITICAL) then an alert message will besent to the nominated log4j category (console,email,NT event log etc)<P><P><DL><DT><B>Author:</B></DT><DD>Lara D'Abreo, Jakub Holy</DD><DT><B>See Also:</B><DD><CODE>Threashold</CODE></DL><HR><P><!-- =========== FIELD SUMMARY =========== --><A NAME="field_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>Field Summary</B></FONT></TH></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>protected java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../net/sourceforge/stat4j/Alert.html#category">category</A></B></CODE><BR> </TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>protected <A HREF="../../../net/sourceforge/stat4j/Threshold.html" title="class in net.sourceforge.stat4j">Threshold</A></CODE></FONT></TD><TD><CODE><B><A HREF="../../../net/sourceforge/stat4j/Alert.html#critical">critical</A></B></CODE><BR> </TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>protected java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../net/sourceforge/stat4j/Alert.html#description">description</A></B></CODE><BR> </TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>private boolean</CODE></FONT></TD><TD><CODE><B><A HREF="../../../net/sourceforge/stat4j/Alert.html#lastAlertCritical">lastAlertCritical</A></B></CODE><BR> </TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>protected long</CODE></FONT></TD><TD><CODE><B><A HREF="../../../net/sourceforge/stat4j/Alert.html#lastAlertedMs">lastAlertedMs</A></B></CODE><BR> </TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>protected java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../net/sourceforge/stat4j/Alert.html#name">name</A></B></CODE><BR> </TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>private long</CODE></FONT></TD><TD><CODE><B><A HREF="../../../net/sourceforge/stat4j/Alert.html#quietPeriodMs">quietPeriodMs</A></B></CODE><BR> </TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>protected java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../net/sourceforge/stat4j/Alert.html#statisticName">statisticName</A></B></CODE><BR> </TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>protected <A HREF="../../../net/sourceforge/stat4j/Threshold.html" title="class in net.sourceforge.stat4j">Threshold</A></CODE></FONT></TD><TD><CODE><B><A HREF="../../../net/sourceforge/stat4j/Alert.html#warn">warn</A></B></CODE><BR> </TD></TR></TABLE> <!-- ======== 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="../../../net/sourceforge/stat4j/Alert.html#Alert()">Alert</A></B>()</CODE><BR> </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"><CODE> boolean</CODE></FONT></TD><TD><CODE><B><A HREF="../../../net/sourceforge/stat4j/Alert.html#evaluateAlert(double)">evaluateAlert</A></B>(double value)</CODE><BR> </TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../net/sourceforge/stat4j/Alert.html#getName()">getName</A></B>()</CODE><BR> </TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../net/sourceforge/stat4j/Alert.html#getStatisticName()">getStatisticName</A></B>()</CODE><BR> </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="../../../net/sourceforge/stat4j/Alert.html#init(java.lang.String, java.util.Properties)">init</A></B>(java.lang.String name,java.util.Properties properties)</CODE><BR> </TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>(package private) boolean</CODE></FONT></TD><TD><CODE><B><A HREF="../../../net/sourceforge/stat4j/Alert.html#isTriggered(net.sourceforge.stat4j.Threshold, double, boolean)">isTriggered</A></B>(<A HREF="../../../net/sourceforge/stat4j/Threshold.html" title="class in net.sourceforge.stat4j">Threshold</A> t,double value,boolean critical)</CODE><BR> </TD></TR></TABLE> <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.Object</B></TH></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD></TR></TABLE> <P><!-- ============ FIELD DETAIL =========== --><A NAME="field_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>Field Detail</B></FONT></TH></TR></TABLE><A NAME="name"><!-- --></A><H3>name</H3><PRE>protected java.lang.String <B>name</B></PRE><DL><DL></DL></DL><HR><A NAME="statisticName"><!-- --></A><H3>statisticName</H3><PRE>protected java.lang.String <B>statisticName</B></PRE><DL><DL></DL></DL><HR><A NAME="category"><!-- --></A><H3>category</H3><PRE>protected java.lang.String <B>category</B></PRE><DL><DL></DL></DL><HR><A NAME="description"><!-- --></A><H3>description</H3><PRE>protected java.lang.String <B>description</B></PRE><DL><DL></DL></DL><HR><A NAME="warn"><!-- --></A><H3>warn</H3><PRE>protected <A HREF="../../../net/sourceforge/stat4j/Threshold.html" title="class in net.sourceforge.stat4j">Threshold</A> <B>warn</B></PRE><DL><DL></DL></DL><HR><A NAME="critical"><!-- --></A><H3>critical</H3><PRE>protected <A HREF="../../../net/sourceforge/stat4j/Threshold.html" title="class in net.sourceforge.stat4j">Threshold</A> <B>critical</B></PRE><DL><DL></DL></DL><HR><A NAME="lastAlertedMs"><!-- --></A><H3>lastAlertedMs</H3><PRE>protected long <B>lastAlertedMs</B></PRE><DL><DL></DL></DL><HR><A NAME="quietPeriodMs"><!-- --></A><H3>quietPeriodMs</H3><PRE>private long <B>quietPeriodMs</B></PRE><DL><DL></DL></DL><HR><A NAME="lastAlertCritical"><!-- --></A><H3>lastAlertCritical</H3><PRE>private boolean <B>lastAlertCritical</B></PRE><DL><DL></DL></DL><!-- ========= 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="Alert()"><!-- --></A><H3>Alert</H3><PRE>public <B>Alert</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="init(java.lang.String, java.util.Properties)"><!-- --></A><H3>init</H3><PRE>public void <B>init</B>(java.lang.String name,java.util.Properties properties)</PRE><DL><DD><DL></DL></DD></DL><HR><A NAME="evaluateAlert(double)"><!-- --></A><H3>evaluateAlert</H3><PRE>public boolean <B>evaluateAlert</B>(double value)</PRE><DL><DD><DL></DL></DD></DL><HR><A NAME="isTriggered(net.sourceforge.stat4j.Threshold, double, boolean)"><!-- --></A><H3>isTriggered</H3><PRE>boolean <B>isTriggered</B>(<A HREF="../../../net/sourceforge/stat4j/Threshold.html" title="class in net.sourceforge.stat4j">Threshold</A> t,double value,boolean critical)</PRE><DL><DD><DL></DL></DD></DL><HR><A NAME="getName()"><!-- --></A><H3>getName</H3><PRE>public java.lang.String <B>getName</B>()</PRE><DL><DD><DL><DT><B>Returns:</B><DD></DL></DD></DL><HR><A NAME="getStatisticName()"><!-- --></A><H3>getStatisticName</H3><PRE>public java.lang.String <B>getStatisticName</B>()</PRE><DL><DD><DL><DT><B>Returns:</B><DD></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/Alert.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"> PREV CLASS <A HREF="../../../net/sourceforge/stat4j/AlertTest.html" title="class in net.sourceforge.stat4j"><B>NEXT CLASS</B></A></FONT></TD><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"><A HREF="../../../index.html?net/sourceforge/stat4j/Alert.html" target="_top"><B>FRAMES</B></A> <A HREF="Alert.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">DETAIL: <A HREF="#field_detail">FIELD</A> | <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>