Interface ServerRef
- All Superinterfaces:
org.jvnet.hk2.config.ConfigBeanProxy,jakarta.validation.Payload,Ref
@ReferenceConstraint(skipDuringCreation=true,
payload=ServerRef.class)
public interface ServerRef
extends org.jvnet.hk2.config.ConfigBeanProxy, Ref, jakarta.validation.Payload
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionGets the value of thedisableTimeoutInMinutesproperty.Gets the value of theenabledproperty.Gets the value of thehealthCheckerproperty.Gets the value of thelbEnabledproperty.@NotNull @Pattern(regexp="[A-Za-z0-9_][A-Za-z0-9\\-_\\.;]*",message="{server.invalid.name}",payload=ServerRef.class) StringgetRef()Gets the value of therefproperty.voidsetDisableTimeoutInMinutes(String disableTimeout) Sets the value of thedisableTimeoutInMinutesproperty.voidsetEnabled(String enabled) Sets the value of theenabledproperty.voidsetHealthChecker(HealthChecker healthChecker) Sets the value of thehealthCheckerproperty.voidsetLbEnabled(String lbEnabled) Sets the value of thelbEnabledproperty.voidSets the value of therefproperty.Methods inherited from interface org.jvnet.hk2.config.ConfigBeanProxy
createChild, deepCopy, getParent, getParent
-
Field Details
-
LBENABLED_DEFAULT_VALUE
- See Also:
-
-
Method Details
-
getRef
@NotNull @Pattern(regexp="[A-Za-z0-9_][A-Za-z0-9\\-_\\.;]*", message="{server.invalid.name}", payload=ServerRef.class) @RemoteKey(message="{resourceref.invalid.server-ref}", type=Server.class) @NotNull @Pattern(regexp="[A-Za-z0-9_][A-Za-z0-9\\-_\\.;]*",message="{server.invalid.name}",payload=ServerRef.class) String getRef()Gets the value of therefproperty.A reference to the name of a server defined elsewhere.
-
setRef
Sets the value of therefproperty.- Specified by:
setRefin interfaceRef- Parameters:
ref- allowed object isString- Throws:
PropertyVetoException
-
getDisableTimeoutInMinutes
String getDisableTimeoutInMinutes()Gets the value of thedisableTimeoutInMinutesproperty.The time, in minutes, that it takes this server to reach a quiescent state after having been disabled.
- Returns:
- possible object is
String
-
setDisableTimeoutInMinutes
Sets the value of thedisableTimeoutInMinutesproperty.- Parameters:
disableTimeout- allowed object isString- Throws:
PropertyVetoException
-
getLbEnabled
String getLbEnabled()Gets the value of thelbEnabledproperty.Causes any and all load-balancers using this server to consider this server available to them.
Defaults to
available(true).- Returns:
- possible object is
String
-
setLbEnabled
Sets the value of thelbEnabledproperty.- Parameters:
lbEnabled- allowed object isString- Throws:
PropertyVetoException
-
getEnabled
String getEnabled()Gets the value of theenabledproperty.A boolean flag that causes the server to be enabled to serve end-users, or not.
Default is to be
enabled(true).- Returns:
- possible object is
String
-
setEnabled
Sets the value of theenabledproperty.- Parameters:
enabled- allowed object isString- Throws:
PropertyVetoException
-
getHealthChecker
HealthChecker getHealthChecker()Gets the value of thehealthCheckerproperty.- Returns:
- possible object is
HealthChecker
-
setHealthChecker
Sets the value of thehealthCheckerproperty.- Parameters:
healthChecker- allowed object isHealthChecker- Throws:
PropertyVetoException
-