Package com.sun.enterprise.config.serverbeans

Interface GroupManagementService

All Superinterfaces:
org.jvnet.hk2.config.ConfigBeanProxy, org.glassfish.api.admin.config.ConfigExtension, org.glassfish.api.admin.config.Container, org.jvnet.hk2.config.types.PropertyBag
public interface GroupManagementService extends org.jvnet.hk2.config.types.PropertyBag, org.glassfish.api.admin.config.ConfigExtension
Group-management-service(GMS) is an in-process service that provides cluster monitoring and group communication services. GMS notifies registered modules in an application server instance when one or more members in the cluster fail (become unreachable). GMS also provides the ability to send and receive messages between a group of processes. GMS is an abstraction layer that plugs-in group communication technologies which rely on a configurable stack of protocols. Each of these protocols has properties that can be changed for a given network and deployment topology. These relevant configurable protocols are:
  • failure-detection enables its members to periodically monitor other group members to determine their availability in the group.
  • group-discovery is used for discovery of group & its members.
  • failure-detection.verify-failure-timeout-in-millis verifies suspect instances by adding a verification layer to mark a failure suspicion as a confirmed failure.

  • Method Details

    • getFailureDetection

      @NotNull @NotNull FailureDetection getFailureDetection()
      Gets the value of the groupManagementService property.
      Returns:
      possible object is GroupManagementService
      Since:
      glassfish v3.1

    • setFailureDetection

      void setFailureDetection(FailureDetection failureDetection) throws PropertyVetoException
      Sets the value of the failureDetection property.
      Parameters:
      failureDetection - allowed object is FailureDetection
      Throws:
      PropertyVetoException
      Since:
      glassfish v3.1

    • getGroupDiscoveryTimeoutInMillis

      @Min(1000L) @Max(120000L) @Min(1000L) @Max(120000L) String getGroupDiscoveryTimeoutInMillis()
      Gets the value of the groupDiscoveryTimeoutInMillis property.

      Amount of time in milliseconds that GMS waits for discovery of other members in this group. Must be a positive integer.

      Returns:
      possible object is String
      Since:
      glassfish v3.1

    • setGroupDiscoveryTimeoutInMillis

      void setGroupDiscoveryTimeoutInMillis(String groupDiscoveryTimeout) throws PropertyVetoException
      Sets the value of the groupDiscoveryTimeoutInMillis property.
      Parameters:
      groupDiscoveryTimeout - allowed object is String
      Throws:
      PropertyVetoException
      Since:
      glassfish v3.1

    • getFdProtocolMaxTries

      @Deprecated String getFdProtocolMaxTries()
      Deprecated.
      Replaced by FailureDetection.getMaxMissedHeartbeats().
      Gets the value of the fdProtocolMaxTries property.

      Maximum number of attempts to try before GMS confirms that a failure is suspected in the group. Must be a positive integer.

      Returns:
      possible object is String

    • setFdProtocolMaxTries

      @Deprecated void setFdProtocolMaxTries(String fdProtocolMaxTries) throws PropertyVetoException
      Deprecated.
      Replaced by FailureDetection.setMaxMissedHeartbeats(String)
      Sets the value of the fdProtocolMaxTries property.
      Parameters:
      fdProtocolMaxTries - allowed object is String
      Throws:
      PropertyVetoException

    • getFdProtocolTimeoutInMillis

      @Deprecated String getFdProtocolTimeoutInMillis()
      Deprecated.
      Replaced by FailureDetection.getHeartbeatFrequencyInMillis().
      Gets the value of the fdProtocolTimeoutInMillis property.

      Period of time between monitoring attempts to detect failure. Must be a positive integer.

      Returns:
      possible object is String

    • setFdProtocolTimeoutInMillis

      @Deprecated void setFdProtocolTimeoutInMillis(String fdProtocolTimeout) throws PropertyVetoException
      Deprecated.
      Replaced by FailureDetection.setHeartbeatFrequencyInMillis(String).
      Sets the value of the fdProtocolTimeoutInMillis property.
      Parameters:
      fdProtocolTimeout - allowed object is String
      Throws:
      PropertyVetoException

    • getMergeProtocolMaxIntervalInMillis

      @Deprecated String getMergeProtocolMaxIntervalInMillis()
      Deprecated.
      Gets the value of the mergeProtocolMaxIntervalInMillis property.

      Specifies the maximum amount of time to wait to collect subgroup information before performing a merge. Must be a positive integer.

      Returns:
      possible object is String

    • setMergeProtocolMaxIntervalInMillis

      @Deprecated void setMergeProtocolMaxIntervalInMillis(String maxInterval) throws PropertyVetoException
      Deprecated.
      Sets the value of the mergeProtocolMaxIntervalInMillis property.
      Parameters:
      maxInterval - allowed object is String
      Throws:
      PropertyVetoException

    • getMergeProtocolMinIntervalInMillis

      @Deprecated String getMergeProtocolMinIntervalInMillis()
      Deprecated.
      Gets the value of the mergeProtocolMinIntervalInMillis property.

      Specifies the minimum amount of time to wait to collect subgroup information before performing a merge. Must be a positive integer

      Returns:
      possible object is String

    • setMergeProtocolMinIntervalInMillis

      @Deprecated void setMergeProtocolMinIntervalInMillis(String minInterval) throws PropertyVetoException
      Deprecated.
      Sets the value of the mergeProtocolMinIntervalInMillis property.
      Parameters:
      minInterval - allowed object is String
      Throws:
      PropertyVetoException

    • getPingProtocolTimeoutInMillis

      @Deprecated String getPingProtocolTimeoutInMillis()
      Deprecated.
      Gets the value of the pingProtocolTimeoutInMillis property.

      Amount of time in milliseconds that GMS waits for discovery of other members in this group. Must be a positive integer.

      Returns:
      possible object is String
      See Also:

    • setPingProtocolTimeoutInMillis

      @Deprecated void setPingProtocolTimeoutInMillis(String pingProtocolTimeout) throws PropertyVetoException
      Deprecated.
      Sets the value of the pingProtocolTimeoutInMillis property.
      Parameters:
      pingProtocolTimeout - allowed object is String
      Throws:
      PropertyVetoException
      See Also:

    • getVsProtocolTimeoutInMillis

      @Deprecated String getVsProtocolTimeoutInMillis()
      Deprecated.
      Replaced by FailureDetection.getVerifyFailureWaittimeInMillis().
      Gets the value of the vsProtocolTimeoutInMillis property.

      After this timeout a suspected failure is marked as verified. Must be a positive integer.

      Returns:
      possible object is String

    • setVsProtocolTimeoutInMillis

      @Deprecated void setVsProtocolTimeoutInMillis(String vsProtocolTimeout) throws PropertyVetoException
      Deprecated.
      Replaced by FailureDetection.setVerifyFailureWaittimeInMillis(String).
      Sets the value of the vsProtocolTimeoutInMillis property.
      Parameters:
      vsProtocolTimeout - allowed object is String
      Throws:
      PropertyVetoException

    • getProperty

      @ToDo(priority=IMPORTANT, details="Provide PropertyDesc for legal props") @PropertiesDesc(props={}) List<org.jvnet.hk2.config.types.Property> getProperty()
      Properties as per PropertyBag
      Specified by:
      getProperty in interface org.jvnet.hk2.config.types.PropertyBag