com.sun.enterprise.config.serverbeans

Interface AvailabilityService

All Superinterfaces:

org.jvnet.hk2.config.ConfigBeanProxy, org.jvnet.hk2.config.types.PropertyBag

public interface AvailabilityService
extends org.jvnet.hk2.config.ConfigBeanProxy, org.jvnet.hk2.config.types.PropertyBag

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AvailabilityService.Duck

Method Summary

Methods

Modifier and Type	Method and Description
String	getAutoManageHaStore() Deprecated.
String	getAvailabilityEnabled() Gets the value of the availabilityEnabled property.
<T extends AvailabilityServiceExtension> T	getExtensionByType(Class<T> type)
List<AvailabilityServiceExtension>	getExtensions()
String	getHaAgentHosts() Deprecated.
String	getHaAgentPassword() Deprecated.
String	getHaAgentPort() Deprecated.
String	getHaStoreHealthcheckEnabled() Deprecated.
String	getHaStoreHealthcheckIntervalInSeconds() Deprecated.
String	getHaStoreName() Deprecated.
List<org.jvnet.hk2.config.types.Property>	getProperty() Properties as per PropertyBag
String	getStorePoolName() Deprecated.
void	setAutoManageHaStore(String value) Sets the value of the autoManageHaStore property.
void	setAvailabilityEnabled(String value) Sets the value of the availabilityEnabled property.
void	setHaAgentHosts(String value) Sets the value of the haAgentHosts property.
void	setHaAgentPassword(String value) Sets the value of the haAgentPassword property.
void	setHaAgentPort(String value) Sets the value of the haAgentPort property.
void	setHaStoreHealthcheckEnabled(String value) Sets the value of the haStoreHealthcheckEnabled property.
void	setHaStoreHealthcheckIntervalInSeconds(String value) Sets the value of the haStoreHealthcheckIntervalInSeconds property.
void	setHaStoreName(String value) Sets the value of the haStoreName property.
void	setStorePoolName(String value) Sets the value of the storePoolName property.

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

createChild, deepCopy, getParent, getParent

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

getProperty, getPropertyValue, getPropertyValue

Method Detail

getAvailabilityEnabled

String getAvailabilityEnabled()

Gets the value of the availabilityEnabled property. This boolean flag controls whether availability is enabled for HTTP session persistence. If this is "false", then session persistence is disabled for all web modules in j2ee apps and stand-alone web modules. If it is "true" (and providing that the global availability-enabled in availability-service is also "true", then j2ee apps and stand-alone web modules may be ha enabled. Finer-grained control exists at lower levels. If this attribute is missing, it "inherits" the value of the global availability-enabled under availability-service.

Returns:

possible object is String

setAvailabilityEnabled

void setAvailabilityEnabled(String value)
                            throws PropertyVetoException

Sets the value of the availabilityEnabled property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getHaAgentHosts

@Deprecated
String getHaAgentHosts()

Deprecated.

Gets the value of the haAgentHosts property. Comma-delimited list of server host names or IP addresses where high availability store management agents are running.

Returns:

possible object is String

setHaAgentHosts

void setHaAgentHosts(String value)
                     throws PropertyVetoException

Sets the value of the haAgentHosts property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getHaAgentPort

@Max(value=65535L)
@Min(value=1L)
@Deprecated
String getHaAgentPort()

Deprecated.

Gets the value of the haAgentPort property. Port number where highly available store management agents can be contacted

Returns:

possible object is String

setHaAgentPort

void setHaAgentPort(String value)
                    throws PropertyVetoException

Sets the value of the haAgentPort property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getHaAgentPassword

@Deprecated
String getHaAgentPassword()

Deprecated.

Gets the value of the haAgentPassword property. password needed to contact highly available store management agents

Returns:

possible object is String

setHaAgentPassword

void setHaAgentPassword(String value)
                        throws PropertyVetoException

Sets the value of the haAgentPassword property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getHaStoreName

@Deprecated
String getHaStoreName()

Deprecated.

Gets the value of the haStoreName property. Name of the session store

Returns:

possible object is String

setHaStoreName

void setHaStoreName(String value)
                    throws PropertyVetoException

Sets the value of the haStoreName property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getAutoManageHaStore

@Deprecated
String getAutoManageHaStore()

Deprecated.

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

possible object is String

setAutoManageHaStore

void setAutoManageHaStore(String value)
                          throws PropertyVetoException

Sets the value of the autoManageHaStore property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getStorePoolName

@Deprecated
String getStorePoolName()

Deprecated.

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

possible object is String

setStorePoolName

void setStorePoolName(String value)
                      throws PropertyVetoException

Sets the value of the storePoolName property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getHaStoreHealthcheckEnabled

@Deprecated
String getHaStoreHealthcheckEnabled()

Deprecated.

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

Returns:

possible object is String

setHaStoreHealthcheckEnabled

void setHaStoreHealthcheckEnabled(String value)
                                  throws PropertyVetoException

Sets the value of the haStoreHealthcheckEnabled property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getHaStoreHealthcheckIntervalInSeconds

@Min(value=1L)
@Deprecated
String getHaStoreHealthcheckIntervalInSeconds()

Deprecated.

Gets the value of the haStoreHealthcheckIntervalInSeconds property. The periodicity at which store health is checked.

Returns:

possible object is String

setHaStoreHealthcheckIntervalInSeconds

void setHaStoreHealthcheckIntervalInSeconds(String value)
                                            throws PropertyVetoException

Sets the value of the haStoreHealthcheckIntervalInSeconds property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getExtensions

List<AvailabilityServiceExtension> getExtensions()

getExtensionByType

@DuckTyped
<T extends AvailabilityServiceExtension> T getExtensionByType(Class<T> type)

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