com.sun.enterprise.config.serverbeans

Interface ClusterRef

All Superinterfaces:

org.jvnet.hk2.config.ConfigBeanProxy, jakarta.validation.Payload, Ref

@ReferenceConstraint(skipDuringCreation=true,
                     payload=ClusterRef.class)
public interface ClusterRef
extends org.jvnet.hk2.config.ConfigBeanProxy, Ref, jakarta.validation.Payload

Element relating a reference to a cluster to be load balanced to an (optional) health-checker

Nested Class Summary

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

org.jvnet.hk2.config.ConfigBeanProxy.Duck

Method Summary

Modifier and Type	Method and Description
HealthChecker	getHealthChecker() Gets the value of the healthChecker property.
String	getLbPolicy() Gets the value of the lbPolicy property.
String	getLbPolicyModule() Gets the value of the lbPolicyModule property.
@NotNull @Pattern(regexp="[A-Za-z0-9_][A-Za-z0-9\\-_\\.;]*") String	getRef() Gets the value of the ref property.
void	setHealthChecker(HealthChecker value) Sets the value of the healthChecker property.
void	setLbPolicy(String value) Sets the value of the lbPolicy property.
void	setLbPolicyModule(String value) Sets the value of the lbPolicyModule property.
void	setRef(String value) Sets the value of the ref property.

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

createChild, deepCopy, getParent, getParent

Method Detail

getRef

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

Gets the value of the ref property.

Specified by:

getRef in interface Ref

Returns:

possible object is String

setRef

void setRef(String value)
     throws PropertyVetoException

Sets the value of the ref property.

Specified by:

setRef in interface Ref

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getLbPolicy

String getLbPolicy()

Gets the value of the lbPolicy property. load balancing policy to be used for this cluster. Possible values are round-robin , weighted-round-robin or user-defined. round-robin is the default. For weighted-round-robin, the weights of the instance are considered while load balancing. For user-defined, the policy is implemented by a shared library which is loaded by the load balancer and the instance selected is delegated to the loaded module.

Returns:

possible object is String

setLbPolicy

void setLbPolicy(String value)
          throws PropertyVetoException

Sets the value of the lbPolicy property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getLbPolicyModule

String getLbPolicyModule()

Gets the value of the lbPolicyModule property. Specifies the absolute path to the shared library implementing the user-defined policy. This should be specified only when the lb-policy is user-defined. The shared library should exist and be readable in the machine where load balancer is running.

Returns:

possible object is String

setLbPolicyModule

void setLbPolicyModule(String value)
                throws PropertyVetoException

Sets the value of the lbPolicyModule property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getHealthChecker

HealthChecker getHealthChecker()

Gets the value of the healthChecker property. Each cluster would be configured for a ping based health check mechanism.

Returns:

possible object is HealthChecker

setHealthChecker

void setHealthChecker(HealthChecker value)
               throws PropertyVetoException

Sets the value of the healthChecker property.

Parameters:

value - allowed object is HealthChecker

Throws:

PropertyVetoException