svn commit: r1496635 - /uima/sandbox/uima-ducc/trunk/uima-ducc-common/src/main/java/org/apache/uima/ducc/common/IServiceStatistics.java

[ch...@apache.org]

Author: challngr
Date: Tue Jun 25 20:56:31 2013
New Revision: 1496635

URL: http://svn.apache.org/r1496635
Log:
UIMA-3011 Refactor default UIMA-AS pinger to CLI, and add service_ping_arguments support.

Added:
    uima/sandbox/uima-ducc/trunk/uima-ducc-common/src/main/java/org/apache/uima/ducc/common/IServiceStatistics.java

Added: uima/sandbox/uima-ducc/trunk/uima-ducc-common/src/main/java/org/apache/uima/ducc/common/IServiceStatistics.java
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-common/src/main/java/org/apache/uima/ducc/common/IServiceStatistics.java?rev=1496635&view=auto
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-common/src/main/java/org/apache/uima/ducc/common/IServiceStatistics.java (added)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-common/src/main/java/org/apache/uima/ducc/common/IServiceStatistics.java Tue Jun 25 20:56:31 2013
@@ -0,0 +1,49 @@
+package org.apache.uima.ducc.common;
+
+import java.io.Serializable;
+
+/**
+ * The ServiceStatics class is used to return service health, availability, and monitoring statistics
+ * to the Service Manager.
+ */
+public interface  IServiceStatistics
+    extends Serializable
+{
+
+    /**
+     * Query whether the service is alive.
+     * @return "true" if the service is responsive, "false" otherwise.
+     */
+    public boolean isAlive();
+
+    /**
+     * Query wether the service is "healthy".
+     * @return "true" if the service is healthy, "false" otherwise.
+     */
+    public boolean isHealthy();
+
+    /**
+     * Return service statistics, if any.
+     * @return A string containing information regarding the service.  This is used only for display in the web server.
+     */
+    public String  getInfo();
+
+    /**
+     * Set the "aliveness" of the service.  This is called by each pinger for each service.
+     * @param alive Set to "true" if the service is responseve, "false" otherwise.
+     */
+    public void setAlive(boolean alive);
+ 
+    /**
+     * Set the "health" of the service.  This is called by each pinger for each service.
+     * @param healthy Set to "true" if the service is healthy, "false" otherwise.
+     */
+    public void setHealthy(boolean healthy);
+
+    /**
+     * Set the monitor statistics for the service.  This is called by each pinger for each service.
+     * @param info This is an arbitrary string summarizing the service's performance.  This is used only in the web serverl
+     */
+    public void setInfo(String info);
+
+}