Package de.elo.ix.client.health

Interface HealthCheckService

All Superinterfaces:
byps.BRemote, byps.Remote, de.elo.utils.net.Remote, Remote
public interface HealthCheckService extends byps.BRemote
Functions for health check.
Since:
10.00.020.015

  • Method Details

    • updateMeanValue

      void updateMeanValue(ClientInfo ci, String name, double meanValue, long sampleSize) throws byps.RemoteException
      Update arithmetic mean. This function adds the given mean value to the already existing value in the database. The new value is computed as: (db-meanValue * db-sampleSize + meanValue * sampleSize) / (db-sampleSize + sampleSize). Example: 
      
 IXConnection conn = ...
 double value = (1.1 + 1.2 + 1.3) / 3;
 conn.getHealthCheckService().updateMeanValue("valuename", 1.2, 3);
      Parameters:
      ci - ClientInfo
      name - Value name
      meanValue - New mean value
      sampleSize - Specifies the number of samples used to compute the mean value.
      Throws:
      byps.RemoteException

    • updateDoubleValue

      void updateDoubleValue(ClientInfo ci, String name, double doubleValue) throws byps.RemoteException
      Update one value. This function overwrites an existing value. Example: 
      
 IXConnection conn = ...
 conn.getHealthCheckService().updateDoubleValue("valuename", 1.2);
      Parameters:
      ci - ClientInfo
      name - Value name
      doubleValue - New value
      Throws:
      byps.RemoteException

    • computeDoubleValue

      void computeDoubleValue(ClientInfo ci, String hciValueName, double hciUpdateValue, HealthCheckValueOperation hciUpdateOperation) throws byps.RemoteException
      Compute value. This function computes a new value using the specified operation. Example: 
      
 IXConnection conn = ...
 conn.getHealthCheckService().computeDoubleValue("valuename", 1.2, HealthCheckValueOperation.ADD);
      Parameters:
      ci - ClientInfo
      hciValueName - Value name
      hciUpdateValue - New value
      hciUpdateOperation - Operation used to compute the new value. For HealthCheckValueOperation.MEAN, sample size is assumed as 1.
      Throws:
      byps.RemoteException
      Since:
      10.00.020.016

    • update

      void update(ClientInfo ci, HealthCheckInfo hci) throws byps.RemoteException
      Update one value. Example: 
      
 IXConnection conn = ...
 HealthCheckInfo hci = new HealthCheckInfo();
 hci.setName("valuename");
 hci.setStringValue("string1");
 conn.getHealthCheckService().update(hci);
      Parameters:
      ci - ClientInfo
      hci - HeathCheckInfo object
      Throws:
      byps.RemoteException

    • updateAll

      void updateAll(ClientInfo ci, List<HealthCheckInfo> hcis) throws byps.RemoteException
      Update given values.
      Parameters:
      ci - ClientInfo
      hcis - HeathCheckInfo objects
      Throws:
      byps.RemoteException

    • uploadAll

      Object uploadAll(ClientInfo ci, Object reserved) throws byps.RemoteException
      Force uploading health check data to web service. This function should only be used in test scenarios. Indexserver automatically uploads health check data one time per month.
      Parameters:
      ci - ClientInfo
      reserved - Reserved, must be null.
      Returns:
      reserved
      Throws:
      byps.RemoteException

    • read

      HealthCheckInfos read(ClientInfo ci, List<String> names) throws byps.RemoteException
      Read given health check values.
      Parameters:
      ci - ClientInfo
      names -
      Returns:
      HealthChckInfos object.
      Throws:
      byps.RemoteException