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 Details

  • 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 the ref property.

      A reference to the name of a server defined elsewhere.

      Specified by:
      getRef in interface Ref
      Returns:
      possible object is String
    • setRef

      void setRef(String ref) throws PropertyVetoException
      Sets the value of the ref property.
      Specified by:
      setRef in interface Ref
      Parameters:
      ref - allowed object is String
      Throws:
      PropertyVetoException
    • getDisableTimeoutInMinutes

      String getDisableTimeoutInMinutes()
      Gets the value of the disableTimeoutInMinutes property.

      The time, in minutes, that it takes this server to reach a quiescent state after having been disabled.

      Returns:
      possible object is String
    • setDisableTimeoutInMinutes

      void setDisableTimeoutInMinutes(String disableTimeout) throws PropertyVetoException
      Sets the value of the disableTimeoutInMinutes property.
      Parameters:
      disableTimeout - allowed object is String
      Throws:
      PropertyVetoException
    • getLbEnabled

      String getLbEnabled()
      Gets the value of the lbEnabled property.

      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

      void setLbEnabled(String lbEnabled) throws PropertyVetoException
      Sets the value of the lbEnabled property.
      Parameters:
      lbEnabled - allowed object is String
      Throws:
      PropertyVetoException
    • getEnabled

      String getEnabled()
      Gets the value of the enabled property.

      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

      void setEnabled(String enabled) throws PropertyVetoException
      Sets the value of the enabled property.
      Parameters:
      enabled - allowed object is String
      Throws:
      PropertyVetoException
    • getHealthChecker

      HealthChecker getHealthChecker()
      Gets the value of the healthChecker property.
      Returns:
      possible object is HealthChecker
    • setHealthChecker

      void setHealthChecker(HealthChecker healthChecker) throws PropertyVetoException
      Sets the value of the healthChecker property.
      Parameters:
      healthChecker - allowed object is HealthChecker
      Throws:
      PropertyVetoException