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 TypeMethodDescription@Min(0L) StringGets the value of theintervalInSecondsproperty.@Min(1L) StringGets the value of thetimeoutInSecondsproperty.getUrl()Gets the value of theurlproperty.voidsetIntervalInSeconds(String interval) Sets the value of theintervalInSecondsproperty.voidsetTimeoutInSeconds(String timeout) Sets the value of thetimeoutInSecondsproperty.voidSets the value of theurlproperty.Methods inherited from interface org.jvnet.hk2.config.ConfigBeanProxy
createChild, deepCopy, getParent, getParent
-
Method Details
-
getUrl
String getUrl()Gets the value of theurlproperty.URL to ping to determine the health state of a listener. This must be a relative URL.
- Returns:
- possible object is
String
-
setUrl
Sets the value of theurlproperty.- Parameters:
url- allowed object isString- Throws:
PropertyVetoException
-
getIntervalInSeconds
Gets the value of theintervalInSecondsproperty.Interval, in seconds, between health checks. A value of
0means that the health check is disabled. Default is30seconds.Must be
0or greater.- Returns:
- possible object is
String
-
setIntervalInSeconds
Sets the value of theintervalInSecondsproperty.- Parameters:
interval- allowed object isString- Throws:
PropertyVetoException
-
getTimeoutInSeconds
Gets the value of thetimeoutInSecondsproperty.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
Sets the value of thetimeoutInSecondsproperty.- Parameters:
timeout- allowed object isString- Throws:
PropertyVetoException
-