com.sun.appserv.management.config
Interface LBConfig

All Superinterfaces:

AMX, AMXConfig, AMXMBeanLogging, ClusterRefConfigCR, ConfigElement, ConfigRemover, Container, NamedConfigElement, NotificationBroadcaster, NotificationEmitter, PropertiesAccess, ServerRefConfigCR

public interface LBConfig
extends AMXConfig, PropertiesAccess, NamedConfigElement, ServerRefConfigCR, ClusterRefConfigCR, Container

Configuration for the lb-config element.

See Also:

LoadBalancer

Field Summary

static String

J2EE_TYPE The j2eeType as returned by AMX.getJ2EEType().

Fields inherited from interface com.sun.appserv.management.config.PropertiesAccess

PROPERTY_PREFIX

Fields inherited from interface com.sun.appserv.management.config.ServerRefConfigCR

DISABLE_TIMEOUT_IN_MINUTES_KEY, ENABLED_KEY, LB_ENABLED_KEY

Fields inherited from interface com.sun.appserv.management.config.ClusterRefConfigCR

LB_POLICY_KEY, LB_POLICY_MODULE_KEY

Fields inherited from interface com.sun.appserv.management.base.Container

ATTR_CONTAINEE_J2EE_TYPES

Method Summary

Map<String,ClusterRefConfig>	getClusterRefConfigMap() Calls Container.getContaineeMap(XTypes.CLUSTER_REF_CONFIG ).
boolean	getHttpsRouting() Returns a boolean flag indicating how load-balancer will route HTTPS requests.
boolean	getMonitoringEnabled() Returns the boolean flag that determines whether monitoring is switched on or not.
String	getReloadPollIntervalInSeconds() Returns the 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.
String	getResponseTimeoutInSeconds() Returns the period, in seconds, within which a server must return a response or otherwise it will be considered unhealthy.
boolean	getRouteCookieEnabled() Returns the boolean flag that determines whether a route cookie is or is not enabled.
Map<String,ServerRefConfig>	getServerRefConfigMap() Calls Container.getContaineeMap(XTypes.SERVER_REF_CONFIG ).
void	setHttpsRouting(boolean value) Set the boolean flag indicating how load-balancer will route HTTPS requests.
void	setMonitoringEnabled(boolean value) Set the boolean flag that determines whether monitoring is switched on or not.
void	setReloadPollIntervalInSeconds(String reloadPollIntervalInSeconds) Set the 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.
void	setResponseTimeoutInSeconds(String responseTimeoutInSeconds) Set the period, in seconds, within which a server must return a response or otherwise it will be considered unhealthy.
void	setRouteCookieEnabled(boolean value) Set the boolean flag that determines whether a route cookie is or is not enabled.

Methods inherited from interface com.sun.appserv.management.config.PropertiesAccess

createProperty, existsProperty, getProperties, getPropertyNames, getPropertyValue, removeProperty, setPropertyValue

Methods inherited from interface com.sun.appserv.management.config.ServerRefConfigCR

createServerRefConfig, createServerRefConfig, removeServerRefConfig

Methods inherited from interface com.sun.appserv.management.config.ConfigRemover

removeConfig

Methods inherited from interface com.sun.appserv.management.config.ClusterRefConfigCR

createClusterRefConfig, createClusterRefConfig, removeClusterRefConfig

Methods inherited from interface com.sun.appserv.management.config.ConfigRemover

removeConfig

Methods inherited from interface com.sun.appserv.management.base.Container

getByNameContaineeSet, getContainee, getContainee, getContaineeJ2EETypes, getContaineeMap, getContaineeSet, getContaineeSet, getContaineeSet, getMultiContaineeMap

Field Detail

J2EE_TYPE

static final String J2EE_TYPE

The j2eeType as returned by AMX.getJ2EEType().

See Also:

Constant Field Values

Method Detail

getResponseTimeoutInSeconds

String getResponseTimeoutInSeconds()

Returns the period, in seconds, within which a server must return a response or otherwise it will be considered unhealthy. Must be greater than or equal to 0.

setResponseTimeoutInSeconds

void setResponseTimeoutInSeconds(String responseTimeoutInSeconds)

Set the period, in seconds, 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.

getHttpsRouting

boolean getHttpsRouting()

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

setHttpsRouting

void setHttpsRouting(boolean value)

Set the 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);

getReloadPollIntervalInSeconds

String getReloadPollIntervalInSeconds()

Returns the 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.

setReloadPollIntervalInSeconds

void setReloadPollIntervalInSeconds(String reloadPollIntervalInSeconds)

Set the 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 seconds)

getMonitoringEnabled

boolean getMonitoringEnabled()

Returns the boolean flag that determines whether monitoring is switched on or not. Default is that monitoring is switched off (false)

setMonitoringEnabled

void setMonitoringEnabled(boolean value)

Set the boolean flag that determines whether monitoring is switched on or not. Default is that monitoring is switched off (false)

getRouteCookieEnabled

boolean getRouteCookieEnabled()

Returns the boolean flag that determines whether a route cookie is or is not enabled.

setRouteCookieEnabled

void setRouteCookieEnabled(boolean value)

Set the boolean flag that determines whether a route cookie is or is not enabled. Default is enabled (true).

getClusterRefConfigMap

Map<String,ClusterRefConfig> getClusterRefConfigMap()

Calls Container.getContaineeMap(XTypes.CLUSTER_REF_CONFIG ).

Returns:

Map of ClusterRefConfig MBean proxies, keyed by name.

See Also:

Container.getContaineeMap(java.lang.String)

getServerRefConfigMap

Map<String,ServerRefConfig> getServerRefConfigMap()

Calls Container.getContaineeMap(XTypes.SERVER_REF_CONFIG ).

Returns:

Map of ServerRefConfig MBean proxies, keyed by name.

See Also:

Container.getContaineeMap(java.lang.String)