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 a 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.

Nested Class Summary

Nested classes/interfaces inherited from interface org.jvnet.hk2.config.types.PropertyBag

org.jvnet.hk2.config.types.PropertyBag.Duck

Method Summary

Methods

Modifier and Type	Method and Description
FailureDetection	getFailureDetection() Gets the value of the groupManagementService property.
String	getFdProtocolMaxTries() Deprecated.
String	getFdProtocolTimeoutInMillis() Deprecated.
String	getGroupDiscoveryTimeoutInMillis() Gets the value of the groupDiscoveryTimeoutInMillis property.
String	getMergeProtocolMaxIntervalInMillis() Deprecated.
String	getMergeProtocolMinIntervalInMillis() Deprecated.
String	getPingProtocolTimeoutInMillis() Deprecated.
List<org.jvnet.hk2.config.types.Property>	getProperty() Properties as per PropertyBag
String	getVsProtocolTimeoutInMillis() Deprecated.
void	setFailureDetection(FailureDetection value) Sets the value of the failureDetection property
void	setFdProtocolMaxTries(String value) Deprecated.
void	setFdProtocolTimeoutInMillis(String value) Deprecated.
void	setGroupDiscoveryTimeoutInMillis(String value) Sets the value of the groupDiscoveryTimeoutInMillis property.
void	setMergeProtocolMaxIntervalInMillis(String value) Deprecated.
void	setMergeProtocolMinIntervalInMillis(String value) Deprecated.
void	setPingProtocolTimeoutInMillis(String value) Deprecated.
void	setVsProtocolTimeoutInMillis(String value) Deprecated.

Methods inherited from interface org.jvnet.hk2.config.types.PropertyBag

getProperty, getPropertyValue, getPropertyValue

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

createChild, deepCopy, getParent, getParent

Method Detail

getFailureDetection

@NotNull
FailureDetection getFailureDetection()

Gets the value of the groupManagementService property.

Returns:

possible object is GroupManagementService

Since:

glassfish v3.1

setFailureDetection

void setFailureDetection(FailureDetection value)
                         throws PropertyVetoException

Sets the value of the failureDetection property

Parameters:

value - allowed object is FailureDetection

Throws:

PropertyVetoException

Since:

glassfish v3.1

getGroupDiscoveryTimeoutInMillis

@Min(value=1000L)
@Max(value=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 value)
                                      throws PropertyVetoException

Sets the value of the groupDiscoveryTimeoutInMillis property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

Since:

glassfish v3.1

getFdProtocolMaxTries

@Deprecated
String getFdProtocolMaxTries()

Deprecated.

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 value)
                           throws PropertyVetoException

Deprecated.

Sets the value of the fdProtocolMaxTries property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getFdProtocolTimeoutInMillis

@Deprecated
String getFdProtocolTimeoutInMillis()

Deprecated.

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 value)
                                  throws PropertyVetoException

Deprecated.

Sets the value of the fdProtocolTimeoutInMillis property.

Parameters:

value - 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 sub-group information before performing a merge. Must be a positive integer.

Returns:

possible object is String

setMergeProtocolMaxIntervalInMillis

@Deprecated
void setMergeProtocolMaxIntervalInMillis(String value)
                                         throws PropertyVetoException

Deprecated.

Sets the value of the mergeProtocolMaxIntervalInMillis property.

Parameters:

value - 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 sub-group information before performing a merge. Must be a positive integer

Returns:

possible object is String

setMergeProtocolMinIntervalInMillis

@Deprecated
void setMergeProtocolMinIntervalInMillis(String value)
                                         throws PropertyVetoException

Deprecated.

Sets the value of the mergeProtocolMinIntervalInMillis property.

Parameters:

value - 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:

getGroupDiscoveryTimeoutInMillis()

setPingProtocolTimeoutInMillis

@Deprecated
void setPingProtocolTimeoutInMillis(String value)
                                    throws PropertyVetoException

Deprecated.

Sets the value of the pingProtocolTimeoutInMillis property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

See Also:

setGroupDiscoveryTimeoutInMillis(String)

getVsProtocolTimeoutInMillis

@Deprecated
String getVsProtocolTimeoutInMillis()

Deprecated.

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 value)
                                  throws PropertyVetoException

Deprecated.

Sets the value of the vsProtocolTimeoutInMillis property.

Parameters:

value - 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