com.sun.appserv.management.config
Interface AvailabilityServiceConfig

All Superinterfaces:

AMX, AMXConfig, AMXMBeanLogging, ConfigElement, Container, NotificationBroadcaster, NotificationEmitter, PropertiesAccess

public interface AvailabilityServiceConfig
extends ConfigElement, PropertiesAccess, Container

Configuration for the <availability-service> element.

Field Summary

static String

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

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

CONFIG_CREATED_NOTIFICATION_TYPE, CONFIG_OBJECT_NAME_KEY, CONFIG_REMOVED_NOTIFICATION_TYPE

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

FULL_TYPE_DELIM, GROUP_CONFIGURATION, GROUP_JSR77, GROUP_MONITORING, GROUP_OTHER, GROUP_UTILITY, J2EE_TYPE_KEY, JMX_DOMAIN, NAME_KEY, NO_NAME, NOTIFICATION_PREFIX, NULL_NAME

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

PROPERTY_PREFIX

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

ATTR_CONTAINEE_J2EE_TYPES

Method Summary

EJBContainerAvailabilityConfig	createEJBContainerAvailabilityConfig(Map<String,String> params) Creates an ejb-container-availability element.
void	createJMSAvailabilityConfig(boolean availabilityEnabled, String mqStorePoolName)
WebContainerAvailabilityConfig	createWebContainerAvailabilityConfig(Map<String,String> params) Creates a web-container-availability element
boolean	getAutoManageHAStore() If set to true, the lifecycle of the highly available store is matched with the lifecycle of the highly available cluster.
boolean	getAvailabilityEnabled()
EJBContainerAvailabilityConfig	getEJBContainerAvailabilityConfig() Get the EJBContainerAvailabilityConfig MBean.
String	getHAAgentHosts() comma-delimited list of server host names or IP addresses where high availability store management agents are running.
String	getHAAgentPassword()
String	getHAAgentPort() port number where highly available store management agents can be contacted.
boolean	getHAStoreHealthcheckEnabled() Application server stops saving session state when the store service does not function properly or is is not accessible for any reason.
String	getHAStoreHealthcheckIntervalSeconds() The periodicity at which store health is checked.
String	getHAStoreName() Name of the session store.
JMSAvailabilityConfig	getJMSAvailabilityConfig()
String	getStorePoolName() This is the jndi-name for the JDBC Connection Pool used potentially by both the Web Container and the EJB Stateful Session Bean Container for use in checkpointing/passivation when persistence-type = "ha".
WebContainerAvailabilityConfig	getWebContainerAvailabilityConfig() Get the WebContainerAvailabilityConfig MBean.
void	removeEJBContainerAvailabilityConfig() Removes ejb-container-availability element from the config.
void	removeJMSAvailabilityConfig()
void	removeWebContainerAvailabilityConfig() Removes web-container-availability element from the config.
void	setAutoManageHAStore(boolean enabled) If set to true, the lifecycle of the highly available store is matched with the lifecycle of the highly available cluster.
void	setAvailabilityEnabled(boolean enabled)
void	setHAAgentHosts(String value) comma-delimited list of server host names or IP addresses where high availability store management agents are running.
void	setHAAgentPassword(String password)
void	setHAAgentPort(String value) port number where highly available store management agents can be contacted.
void	setHAStoreHealthcheckEnabled(boolean value)
void	setHAStoreHealthcheckIntervalSeconds(String value) The periodicity at which store health is checked.
void	setHAStoreName(String value) Name of the session store.
void	setStorePoolName(String storePoolName) This is the jndi-name for the JDBC Connection Pool used potentially by both the Web Container and the EJB Stateful Session Bean Container for use in checkpointing/passivation when persistence-type = "ha".

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

getContainer, getDomainRoot, getFullType, getGroup, getJ2EEType, getName, isDAS

Methods inherited from interface javax.management.NotificationEmitter

removeNotificationListener

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

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

getMBeanLoggerName, getMBeanLogLevel, setMBeanLogLevel

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

createEJBContainerAvailabilityConfig

EJBContainerAvailabilityConfig createEJBContainerAvailabilityConfig(Map<String,String> params)

Creates an ejb-container-availability element.

Parameters:

params -

Returns:

Returns a proxy to the EJBContainerAvailabilityConfig MBean

See Also:

EJBContainerAvailabilityConfigKeys

removeEJBContainerAvailabilityConfig

void removeEJBContainerAvailabilityConfig()

Removes ejb-container-availability element from the config.

createWebContainerAvailabilityConfig

WebContainerAvailabilityConfig createWebContainerAvailabilityConfig(Map<String,String> params)

Creates a web-container-availability element

Parameters:

params -

Returns:

Returns a proxy to the WebContainerAvailabilityConfig MBean

See Also:

WebContainerAvailabilityConfigKeys

removeWebContainerAvailabilityConfig

void removeWebContainerAvailabilityConfig()

Removes web-container-availability element from the config.

getEJBContainerAvailabilityConfig

EJBContainerAvailabilityConfig getEJBContainerAvailabilityConfig()

Get the EJBContainerAvailabilityConfig MBean.

getWebContainerAvailabilityConfig

WebContainerAvailabilityConfig getWebContainerAvailabilityConfig()

Get the WebContainerAvailabilityConfig MBean.

getAvailabilityEnabled

boolean getAvailabilityEnabled()

setAvailabilityEnabled

void setAvailabilityEnabled(boolean enabled)

getAutoManageHAStore

boolean getAutoManageHAStore()

If set to true, the lifecycle of the highly available store is matched with the lifecycle of the highly available cluster. The store is started or stopped with the cluster. It is removed when the cluster is deleted. When set to false, the store lifecycle would have to manually managed by the administrator.

Returns:

the value of auto-manage-ha-store

Since:

AppServer 9.0

setAutoManageHAStore

void setAutoManageHAStore(boolean enabled)

If set to true, the lifecycle of the highly available store is matched with the lifecycle of the highly available cluster. The store is started or stopped with the cluster. It is removed when the cluster is deleted. When set to false, the store lifecycle would have to manually managed by the administrator.

Parameters:

enabled - sets the value of auto-manage-ha-store

Since:

AppServer 9.0

getStorePoolName

String getStorePoolName()

This is the jndi-name for the JDBC Connection Pool used potentially by both the Web Container and the EJB Stateful Session Bean Container for use in checkpointing/passivation when persistence-type = "ha". See sfsb-ha-persistence-type and sfsb-persistence-type for more details. It will default to "jdbc/hastore". This attribute can be over-ridden in either web-container-availability (with http-session-store-pool-name) and/or in ejb-container-availability (with sfsb-store-pool-name). If store-pool-name is not over-ridden then both containers will share the same connection pool. If either container over-rides then it may have its own dedicated pool. In this case there must also be a new corresponding JDBC Resource and JDBC Connection Pool defined for this new pool name.

Returns:

the jndi-name

Since:

AppServer 9.0

setStorePoolName

void setStorePoolName(String storePoolName)

This is the jndi-name for the JDBC Connection Pool used potentially by both the Web Container and the EJB Stateful Session Bean Container for use in checkpointing/passivation when persistence-type = "ha". See sfsb-ha-persistence-type and sfsb-persistence-type for more details. It will default to "jdbc/hastore". This attribute can be over-ridden in either web-container-availability (with http-session-store-pool-name) and/or in ejb-container-availability (with sfsb-store-pool-name). If store-pool-name is not over-ridden then both containers will share the same connection pool. If either container over-rides then it may have its own dedicated pool. In this case there must also be a new corresponding JDBC Resource and JDBC Connection Pool defined for this new pool name.

Parameters:

storePoolName - the jndi-name

Since:

AppServer 9.0

getHAAgentHosts

String getHAAgentHosts()

comma-delimited list of server host names or IP addresses where high availability store management agents are running. For HADB the list must consist of an even number of hosts separated by commas. E.g. host1,host2,host2,host1

Returns:

the stored hostnames or IP addresses

Since:

AppServer 9.0

setHAAgentHosts

void setHAAgentHosts(String value)

comma-delimited list of server host names or IP addresses where high availability store management agents are running.

Parameters:

value - the stored hostnames or IP addresses

Since:

AppServer 9.0

getHAAgentPort

String getHAAgentPort()

port number where highly available store management agents can be contacted. The default for HADB is 1862

Returns:

the port number

Since:

AppServer 9.0

setHAAgentPort

void setHAAgentPort(String value)

port number where highly available store management agents can be contacted. The default for HADB is 1862

Parameters:

value - the port number

Since:

AppServer 9.0

getHAAgentPassword

String getHAAgentPassword()

Since:

AppServer 9.0

setHAAgentPassword

void setHAAgentPassword(String password)

Since:

AppServer 9.0

getHAStoreHealthcheckIntervalSeconds

String getHAStoreHealthcheckIntervalSeconds()

The periodicity at which store health is checked.

Returns:

the interval time in seconds

Since:

AppServer 9.0

setHAStoreHealthcheckIntervalSeconds

void setHAStoreHealthcheckIntervalSeconds(String value)

The periodicity at which store health is checked.

Parameters:

value - the interval time in seconds

Since:

AppServer 9.0

getHAStoreName

String getHAStoreName()

Name of the session store. In HADB this corresponds to the name of the HADB instance. The default is the cluster-name.

Returns:

the store name

Since:

AppServer 9.0

setHAStoreName

void setHAStoreName(String value)

Name of the session store. In HADB this corresponds to the name of the HADB instance. The default is the cluster-name.

Parameters:

value - the new store name

Since:

AppServer 9.0

getHAStoreHealthcheckEnabled

boolean getHAStoreHealthcheckEnabled()

Application server stops saving session state when the store service does not function properly or is is not accessible for any reason. When this attribute is set to true, periodic checking is done to detect if the store service has become available again. If healthcheck succeeds the session state saving is resumed. Defaults to false.

Returns:

the value of the flag

Since:

AppServer 9.0

setHAStoreHealthcheckEnabled

void setHAStoreHealthcheckEnabled(boolean value)

getJMSAvailabilityConfig

JMSAvailabilityConfig getJMSAvailabilityConfig()

createJMSAvailabilityConfig

void createJMSAvailabilityConfig(boolean availabilityEnabled,
                                 String mqStorePoolName)

removeJMSAvailabilityConfig

void removeJMSAvailabilityConfig()