com.sun.enterprise.config.serverbeans
Interface LbConfig

All Superinterfaces:

org.jvnet.hk2.config.ConfigBeanProxy, org.jvnet.hk2.component.Injectable, javax.validation.Payload, org.jvnet.hk2.config.types.PropertyBag

@RefConstraint(message="{ref.invalid}",
               payload=RefValidator.class)
public interface LbConfig
extends org.jvnet.hk2.config.ConfigBeanProxy, org.jvnet.hk2.component.Injectable, org.jvnet.hk2.config.types.PropertyBag, javax.validation.Payload

Nested Class Summary

static class	LbConfig.Decorator
static class	LbConfig.DeleteDecorator
static class	LbConfig.Duck

Field Summary

static String	LAST_APPLIED_PROPERTY
static String	LAST_EXPORTED_PROPERTY

Method Summary

List<Ref>	getClusterRefOrServerRef() Gets the value of the clusterRefOrServerRef property.
String	getHttpsRouting() Gets the value of the httpsRouting property.
Date	getLastApplied()
Date	getLastExported()
String	getMonitoringEnabled() Gets the value of the monitoringEnabled property.
String	getName() Gets the value of the name property.
List<org.jvnet.hk2.config.types.Property>	getProperty() Properties as per PropertyBag
<T> T	getRefByRef(Class<T> type, String ref)
<T> List<T>	getRefs(Class<T> type)
String	getReloadPollIntervalInSeconds() Gets the value of the reloadPollIntervalInSeconds property.
String	getResponseTimeoutInSeconds() Gets the value of the responseTimeoutInSeconds property.
String	getRouteCookieEnabled() Gets the value of the routeCookieEnabled property.
void	setHttpsRouting(String value) Sets the value of the httpsRouting property.
boolean	setLastApplied()
boolean	setLastExported()
void	setMonitoringEnabled(String value) Sets the value of the monitoringEnabled property.
void	setName(String value) Sets the value of the name property.
void	setReloadPollIntervalInSeconds(String value) Sets the value of the reloadPollIntervalInSeconds property.
void	setResponseTimeoutInSeconds(String value) Sets the value of the responseTimeoutInSeconds property.
void	setRouteCookieEnabled(String value) Sets the value of the routeCookieEnabled property.

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

createChild, deepCopy, getParent, getParent

Methods inherited from interface org.jvnet.hk2.component.Injectable

injectedInto

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

getProperty, getPropertyValue, getPropertyValue

Field Detail

LAST_APPLIED_PROPERTY

static final String LAST_APPLIED_PROPERTY

See Also:

Constant Field Values

LAST_EXPORTED_PROPERTY

static final String LAST_EXPORTED_PROPERTY

See Also:

Constant Field Values

Method Detail

getName

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

Gets the value of the name property. Name of the load balancer configuration

Returns:

possible object is String

setName

void setName(String value)
             throws PropertyVetoException

Sets the value of the name property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getResponseTimeoutInSeconds

@Min(value=0L)
String getResponseTimeoutInSeconds()

Gets the value of the responseTimeoutInSeconds property. Period within which a server must return a response or otherwise it will be considered unhealthy. Default value is 60 seconds. Must be greater than or equal to 0. A value of 0 effectively turns off this check functionality, meaning the server will always be considered healthy

Returns:

possible object is String

setResponseTimeoutInSeconds

void setResponseTimeoutInSeconds(String value)
                                 throws PropertyVetoException

Sets the value of the responseTimeoutInSeconds property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getHttpsRouting

String getHttpsRouting()

Gets the value of the httpsRouting property. Boolean flag indicating how load-balancer will route https requests. If true then an https request to the load-balancer will result in an https request to the server; if false then https requests to the load-balancer result in http requests to the server. Default is to use http (i.e. value of false)

Returns:

possible object is String

setHttpsRouting

void setHttpsRouting(String value)
                     throws PropertyVetoException

Sets the value of the httpsRouting property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getReloadPollIntervalInSeconds

String getReloadPollIntervalInSeconds()

Gets the value of the reloadPollIntervalInSeconds property. Maximum period, in seconds, that a change to the load balancer configuration file takes before it is detected by the load balancer and the file reloaded. A value of 0 indicates that reloading is disabled. Default period is 1 minute (60 sec)

Returns:

possible object is String

setReloadPollIntervalInSeconds

void setReloadPollIntervalInSeconds(String value)
                                    throws PropertyVetoException

Sets the value of the reloadPollIntervalInSeconds property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getMonitoringEnabled

String getMonitoringEnabled()

Gets the value of the monitoringEnabled property. Boolean flag that determines whether monitoring is switched on or not. Default is that monitoring is switched off (false)

Returns:

possible object is String

setMonitoringEnabled

void setMonitoringEnabled(String value)
                          throws PropertyVetoException

Sets the value of the monitoringEnabled property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getRouteCookieEnabled

String getRouteCookieEnabled()

Gets the value of the routeCookieEnabled property. Boolean flag that determines whether a route cookie is or is not enabled. Default is enabled (true).

Returns:

possible object is String

setRouteCookieEnabled

void setRouteCookieEnabled(String value)
                           throws PropertyVetoException

Sets the value of the routeCookieEnabled property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getClusterRefOrServerRef

List<Ref> getClusterRefOrServerRef()

Gets the value of the clusterRefOrServerRef 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 clusterRefOrServerRef property.

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

    getClusterRefOrServerRef().add(newItem);
 

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

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

getRefs

@DuckTyped
<T> List<T> getRefs(Class<T> type)

getRefByRef

@DuckTyped
<T> T getRefByRef(Class<T> type,
                            String ref)

getLastExported

@DuckTyped
Date getLastExported()

getLastApplied

@DuckTyped
Date getLastApplied()

setLastExported

@DuckTyped
boolean setLastExported()

setLastApplied

@DuckTyped
boolean setLastApplied()