Package com.io7m.cardant.server.service.health

# Class CAServerHealth

java.lang.Object
com.io7m.cardant.server.service.health.CAServerHealth

All Implemented Interfaces:
  `com.io7m.repetoir.core.RPServiceType`, `AutoCloseable`

public final class CAServerHealth extends Object implements com.io7m.repetoir.core.RPServiceType, AutoCloseable
The server health service.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `close()`
  `static CAServerHealth`
  `create(com.io7m.repetoir.core.RPServiceDirectoryType services)`
  The server health service.
  `String`
  `description()`
  `String`
  `status()`
  `static String`
  `statusOKText()`
  `String`
  `toString()`

  ### Methods inherited from class java.lang.Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- ## Method Details

  - ### statusOKText

    public static String statusOKText()
    Returns:
      The string used to indicate a healthy server

  - ### create

    public static CAServerHealth create(com.io7m.repetoir.core.RPServiceDirectoryType services)
    The server health service.
    Parameters:
      `services` - The services
    Returns:
      The health service

  - ### status

    public String status()
    Returns:
      The current health status

  - ### toString

    public String toString()
    Overrides:
      `toString` in class `Object`

  - ### description

    public String description()
    Specified by:
      `description` in interface `com.io7m.repetoir.core.RPServiceType`

  - ### close

    public void close()
    Specified by:
      `close` in interface `AutoCloseable`