com.sun.enterprise.config.serverbeans

Interface Cluster

All Superinterfaces:

org.jvnet.hk2.config.ConfigBeanProxy, org.glassfish.api.admin.config.Named, javax.validation.Payload, org.jvnet.hk2.config.types.PropertyBag, RefContainer, org.glassfish.api.admin.config.ReferenceContainer, SystemPropertyBag

@ConfigRefConstraint(message="{configref.invalid}",
                     payload=ConfigRefValidator.class)
@ReferenceConstraint(skipDuringCreation=true,
                     payload=Cluster.class)
public interface Cluster
extends org.jvnet.hk2.config.ConfigBeanProxy, org.jvnet.hk2.config.types.PropertyBag, org.glassfish.api.admin.config.Named, SystemPropertyBag, org.glassfish.api.admin.config.ReferenceContainer, RefContainer, javax.validation.Payload

A cluster defines a homogeneous set of server instances that share the same applications, resources, and configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Cluster.Decorator
static class	Cluster.DeleteDecorator
static class	Cluster.Duck

Method Summary

Methods

Modifier and Type	Method and Description
void	createResourceRef(String enabled, String refName)
void	deleteResourceRef(String refName)
ApplicationRef	getApplicationRef(String appName)
String	getBroadcast() Gets the value of the broadcast property.
String	getConfigRef() points to a named config.
List<ClusterExtension>	getExtensions()
<T extends ClusterExtension> List<T>	getExtensionsByType(Class<T> type)
<T extends ClusterExtension> T	getExtensionsByTypeAndName(Class<T> type, String name)
String	getGmsBindInterfaceAddress() Gets the value of the gmsBindInterfaceAddress property.
String	getGmsEnabled() Gets the value of the gmsEnabled property.
String	getGmsMulticastAddress() Gets the value of the gmsMulticastAddress property.
String	getGmsMulticastPort() Gets the value of the gmsMulticastPort property.
String	getHeartbeatAddress() Deprecated.
String	getHeartbeatEnabled() Deprecated.
String	getHeartbeatPort() Deprecated.
List<Server>	getInstances()
String	getName()
List<org.jvnet.hk2.config.types.Property>	getProperty() Properties as per PropertyBag
String	getReference() Returns the cluster configuration reference
ResourceRef	getResourceRef(String refName)
List<ServerRef>	getServerRef() Gets the value of the serverRef property.
ServerRef	getServerRefByRef(String ref)
List<SystemProperty>	getSystemProperty() Gets the value of the systemProperty property.
boolean	isCluster()
boolean	isDas()
boolean	isInstance()
boolean	isResourceRefExists(String refName)
boolean	isServer()
boolean	isVirtual()
void	setBroadcast(String value) Sets the value of the broadcast property.
void	setConfigRef(String value) Sets the value of the configRef property.
void	setGmsBindInterfaceAddress(String value) Sets the value of the gmsBindInterfaceAddress property.
void	setGmsEnabled(String value) Sets the value of the gmsEnabled property.
void	setGmsMulticastAddress(String value) Sets the value of the gmsMulticastAddress property.
void	setGmsMulticastPort(String value) Sets the value of the gmsMulticastPort property.
void	setHeartbeatAddress(String value) Deprecated.
void	setHeartbeatEnabled(String value) Deprecated.
void	setHeartbeatPort(String value) Deprecated.
void	setName(String value) Sets the cluster name

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

getProperty, getPropertyValue, getPropertyValue

Methods inherited from interface com.sun.enterprise.config.serverbeans.SystemPropertyBag

containsProperty, getPropertyValue, getSystemProperty, getSystemPropertyValue

Methods inherited from interface com.sun.enterprise.config.serverbeans.RefContainer

getApplicationRef, getResourceRef

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

createChild, deepCopy, getParent, getParent

Method Detail

setName

void setName(String value)
             throws PropertyVetoException

Sets the cluster name

Specified by:

setName in interface org.glassfish.api.admin.config.Named

Parameters:

value - cluster name

Throws:

PropertyVetoException - if a listener vetoes the change

getName

@Pattern(regexp="[A-Za-z0-9_][A-Za-z0-9\\-_\\.;]*",
         message="{cluster.invalid.name}",
         payload=Cluster.class)
String getName()

Specified by:

getName in interface org.glassfish.api.admin.config.Named

getConfigRef

@NotNull
@Pattern(regexp="[A-Za-z0-9_][A-Za-z0-9\\-_\\.;]*")
@ReferenceConstraint.RemoteKey(message="{resourceref.invalid.configref}",
                               type=Config.class)
String getConfigRef()

points to a named config. All server instances in the cluster will share this config.

Returns:

a named config name

setConfigRef

void setConfigRef(String value)
                  throws PropertyVetoException

Sets the value of the configRef property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException - if a listener vetoes the change

getGmsEnabled

@NotNull
String getGmsEnabled()

Gets the value of the gmsEnabled property. When "gms-enabled" is set to "true", the GMS services will be started as a lifecycle module in each the application server in the cluster.

Returns:

true | false as a string, null means false

setGmsEnabled

void setGmsEnabled(String value)
                   throws PropertyVetoException

Sets the value of the gmsEnabled property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException - if a listener vetoes the change

getBroadcast

@NotNull
String getBroadcast()

Gets the value of the broadcast property. When "broadcast" is set to default of "udpmulticast" and GmsMulticastPort GMSMulticastAddress are not set, then their values are generated. When "broadcast" is set to implied unicast using udp or tcp protocol, then the VIRUTAL_MUTLICAST_URI_LIST is generated for virtual broadcast over unicast mode.

Returns:

true | false as a string, null means false

setBroadcast

void setBroadcast(String value)
                  throws PropertyVetoException

Sets the value of the broadcast property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException - if a listener vetoes the change

getGmsMulticastPort

@Min(value=2048L)
@Max(value=49151L)
String getGmsMulticastPort()

Gets the value of the gmsMulticastPort property. This is the communication port GMS uses to listen for group events. This should be a valid port number.

Returns:

possible object is String

setGmsMulticastPort

void setGmsMulticastPort(String value)
                         throws PropertyVetoException

Sets the value of the gmsMulticastPort property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException - if a listener vetoes the change

getGmsMulticastAddress

String getGmsMulticastAddress()

Gets the value of the gmsMulticastAddress property. This is the address (only multicast supported) at which GMS will listen for group events. Must be unique for each cluster.

Returns:

possible object is String

setGmsMulticastAddress

void setGmsMulticastAddress(String value)
                            throws PropertyVetoException

Sets the value of the gmsMulticastAddress property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException - if a listener vetoes the change

getGmsBindInterfaceAddress

String getGmsBindInterfaceAddress()

Gets the value of the gmsBindInterfaceAddress property.

Returns:

possible object is String

setGmsBindInterfaceAddress

void setGmsBindInterfaceAddress(String value)
                                throws PropertyVetoException

Sets the value of the gmsBindInterfaceAddress property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException - if a listener vetoes the change

getHeartbeatEnabled

@Deprecated
String getHeartbeatEnabled()

Deprecated.

Gets the value of the heartbeatEnabled property. When "heartbeat-enabled" is set to "true", the GMS services will be started as a lifecycle module in each the application server in the cluster.When "heartbeat-enabled" is set to "false", GMS will not be started and its services will be unavailable. Clusters should function albeit with reduced functionality.

Returns:

true | false as a string, null means false

setHeartbeatEnabled

@Deprecated
void setHeartbeatEnabled(String value)
                         throws PropertyVetoException

Deprecated.

Sets the value of the heartbeatEnabled property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException - if a listener vetoes the change

getHeartbeatPort

@Deprecated
String getHeartbeatPort()

Deprecated.

Gets the value of the heartbeatPort property. This is the communication port GMS uses to listen for group events. This should be a valid port number.

Returns:

possible object is String

setHeartbeatPort

@Deprecated
void setHeartbeatPort(String value)
                      throws PropertyVetoException

Deprecated.

Sets the value of the heartbeatPort property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException - if a listener vetoes the change

getHeartbeatAddress

@Deprecated
String getHeartbeatAddress()

Deprecated.

Gets the value of the heartbeatAddress property. This is the address (only multicast supported) at which GMS will listen for group events.

Returns:

possible object is String

setHeartbeatAddress

@Deprecated
void setHeartbeatAddress(String value)
                         throws PropertyVetoException

Deprecated.

Sets the value of the heartbeatAddress property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException - if a listener vetoes the change

getServerRef

List<ServerRef> getServerRef()

Gets the value of the serverRef property. List of servers in the cluster

Returns:

list of configured ServerRef

getSystemProperty

@ToDo(priority=IMPORTANT,
      details="Provide PropertyDesc for legal system props")
List<SystemProperty> getSystemProperty()

Gets the value of the systemProperty property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the systemProperty property.

For example, to add a new item, do as follows:

    getSystemProperty().add(newItem);
 

Objects of the following type(s) are allowed in the list SystemProperty

Specified by:

getSystemProperty in interface SystemPropertyBag

getProperty

@ToDo(priority=IMPORTANT,
      details="Complete PropertyDesc for legal props")
@PropertiesDesc(props=@PropertyDesc(name="GMS_LISTENER_PORT",defaultValue="9090",description="GMS listener port"))
List<org.jvnet.hk2.config.types.Property> getProperty()

Properties as per PropertyBag

Specified by:

getProperty in interface org.jvnet.hk2.config.types.PropertyBag

getExtensions

List<ClusterExtension> getExtensions()

getReference

@DuckTyped
String getReference()

Returns the cluster configuration reference

Specified by:

getReference in interface org.glassfish.api.admin.config.ReferenceContainer

Returns:

the config-ref attribute

getInstances

@DuckTyped
List<Server> getInstances()

getServerRefByRef

@DuckTyped
ServerRef getServerRefByRef(String ref)

isCluster

@DuckTyped
boolean isCluster()

Specified by:

isCluster in interface org.glassfish.api.admin.config.ReferenceContainer

isServer

@DuckTyped
boolean isServer()

Specified by:

isServer in interface org.glassfish.api.admin.config.ReferenceContainer

isDas

@DuckTyped
boolean isDas()

Specified by:

isDas in interface org.glassfish.api.admin.config.ReferenceContainer

isInstance

@DuckTyped
boolean isInstance()

Specified by:

isInstance in interface org.glassfish.api.admin.config.ReferenceContainer

isVirtual

@DuckTyped
boolean isVirtual()

getApplicationRef

@DuckTyped
ApplicationRef getApplicationRef(String appName)

getResourceRef

@DuckTyped
ResourceRef getResourceRef(String refName)

isResourceRefExists

@DuckTyped
boolean isResourceRefExists(String refName)

createResourceRef

@DuckTyped
void createResourceRef(String enabled,
                               String refName)
                       throws org.jvnet.hk2.config.TransactionFailure

Throws:

org.jvnet.hk2.config.TransactionFailure

deleteResourceRef

@DuckTyped
void deleteResourceRef(String refName)
                       throws org.jvnet.hk2.config.TransactionFailure

Throws:

org.jvnet.hk2.config.TransactionFailure

getExtensionsByType

@DuckTyped
<T extends ClusterExtension> List<T> getExtensionsByType(Class<T> type)

getExtensionsByTypeAndName

@DuckTyped
<T extends ClusterExtension> T getExtensionsByTypeAndName(Class<T> type,
                                                                  String name)