Interface HealthChecker

All Superinterfaces:
org.jvnet.hk2.config.ConfigBeanProxy

public interface HealthChecker extends org.jvnet.hk2.config.ConfigBeanProxy
Each cluster would be configured for a ping based health check mechanism.
  • Method Summary

    Modifier and Type
    Method
    Description
    @Min(0L) String
    Gets the value of the intervalInSeconds property.
    @Min(1L) String
    Gets the value of the timeoutInSeconds property.
    Gets the value of the url property.
    void
    Sets the value of the intervalInSeconds property.
    void
    Sets the value of the timeoutInSeconds property.
    void
    Sets the value of the url property.

    Methods inherited from interface org.jvnet.hk2.config.ConfigBeanProxy

    createChild, deepCopy, getParent, getParent
  • Method Details

    • getUrl

      String getUrl()
      Gets the value of the url property.

      URL to ping to determine the health state of a listener. This must be a relative URL.

      Returns:
      possible object is String
    • setUrl

      void setUrl(String url) throws PropertyVetoException
      Sets the value of the url property.
      Parameters:
      url - allowed object is String
      Throws:
      PropertyVetoException
    • getIntervalInSeconds

      @Min(0L) @Min(0L) String getIntervalInSeconds()
      Gets the value of the intervalInSeconds property.

      Interval, in seconds, between health checks. A value of 0 means that the health check is disabled. Default is 30 seconds.

      Must be 0 or greater.

      Returns:
      possible object is String
    • setIntervalInSeconds

      void setIntervalInSeconds(String interval) throws PropertyVetoException
      Sets the value of the intervalInSeconds property.
      Parameters:
      interval - allowed object is String
      Throws:
      PropertyVetoException
    • getTimeoutInSeconds

      @Min(1L) @Min(1L) String getTimeoutInSeconds()
      Gets the value of the timeoutInSeconds property.

      Maximum time, in seconds, that a server must respond to a health check request to be considered healthy. Default is 10 seconds.

      Must be greater than 0.

      Returns:
      possible object is String
    • setTimeoutInSeconds

      void setTimeoutInSeconds(String timeout) throws PropertyVetoException
      Sets the value of the timeoutInSeconds property.
      Parameters:
      timeout - allowed object is String
      Throws:
      PropertyVetoException