FileDocCategorySizeDatePackage
AvailabilityServiceConfig.javaAPI DocGlassfish v2 API9943Fri May 04 22:30:32 BST 2007com.sun.appserv.management.config

AvailabilityServiceConfig

public interface AvailabilityServiceConfig implements com.sun.appserv.management.base.Container, ConfigElement, PropertiesAccess
Configuration for the <availability-service> element.

Fields Summary
public static final String
J2EE_TYPE
The j2eeType as returned by {@link com.sun.appserv.management.base.AMX#getJ2EEType}.
Constructors Summary
Methods Summary
public EJBContainerAvailabilityConfigcreateEJBContainerAvailabilityConfig(java.util.Map params)
Creates an ejb-container-availability element.

param
params
return
Returns a proxy to the EJBContainerAvailabilityConfig MBean
see
com.sun.appserv.management.config.EJBContainerAvailabilityConfigKeys

public voidcreateJMSAvailabilityConfig(boolean availabilityEnabled, java.lang.String mqStorePoolName)

public WebContainerAvailabilityConfigcreateWebContainerAvailabilityConfig(java.util.Map params)
Creates a web-container-availability element

param
params
return
Returns a proxy to the WebContainerAvailabilityConfig MBean
see
com.sun.appserv.management.config.WebContainerAvailabilityConfigKeys

public booleangetAutoManageHAStore()
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.

return
the value of auto-manage-ha-store
since
AppServer 9.0

public booleangetAvailabilityEnabled()

public EJBContainerAvailabilityConfiggetEJBContainerAvailabilityConfig()
Get the EJBContainerAvailabilityConfig MBean.

public java.lang.StringgetHAAgentHosts()
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

return
the stored hostnames or IP addresses
since
AppServer 9.0

public java.lang.StringgetHAAgentPassword()

since
AppServer 9.0

public java.lang.StringgetHAAgentPort()
port number where highly available store management agents can be contacted. The default for HADB is 1862

return
the port number
since
AppServer 9.0

public booleangetHAStoreHealthcheckEnabled()
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.

return
the value of the flag
since
AppServer 9.0

public java.lang.StringgetHAStoreHealthcheckIntervalSeconds()
The periodicity at which store health is checked.

return
the interval time in seconds
since
AppServer 9.0

public java.lang.StringgetHAStoreName()
Name of the session store. In HADB this corresponds to the name of the HADB instance. The default is the cluster-name.

return
the store name
since
AppServer 9.0

public JMSAvailabilityConfiggetJMSAvailabilityConfig()

public java.lang.StringgetStorePoolName()
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.

return
the jndi-name
since
AppServer 9.0

public WebContainerAvailabilityConfiggetWebContainerAvailabilityConfig()
Get the WebContainerAvailabilityConfig MBean.

public voidremoveEJBContainerAvailabilityConfig()
Removes ejb-container-availability element from the config.

public voidremoveJMSAvailabilityConfig()

public voidremoveWebContainerAvailabilityConfig()
Removes web-container-availability element from the config.

public voidsetAutoManageHAStore(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.

param
enabled sets the value of auto-manage-ha-store
since
AppServer 9.0

public voidsetAvailabilityEnabled(boolean enabled)

public voidsetHAAgentHosts(java.lang.String value)
comma-delimited list of server host names or IP addresses where high availability store management agents are running.

param
value the stored hostnames or IP addresses
since
AppServer 9.0

public voidsetHAAgentPassword(java.lang.String password)

since
AppServer 9.0

public voidsetHAAgentPort(java.lang.String value)
port number where highly available store management agents can be contacted. The default for HADB is 1862

param
value the port number
since
AppServer 9.0

public voidsetHAStoreHealthcheckEnabled(boolean value)

public voidsetHAStoreHealthcheckIntervalSeconds(java.lang.String value)
The periodicity at which store health is checked.

param
value the interval time in seconds
since
AppServer 9.0

public voidsetHAStoreName(java.lang.String value)
Name of the session store. In HADB this corresponds to the name of the HADB instance. The default is the cluster-name.

param
value the new store name
since
AppServer 9.0

public voidsetStorePoolName(java.lang.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.

param
storePoolName the jndi-name
since
AppServer 9.0