Package org.glassfish.web.config.serverbeans

Interface WebContainerAvailability

All Superinterfaces:

AvailabilityServiceExtension, ConfigBeanProxy, PropertyBag

public interface WebContainerAvailability
extends ConfigBeanProxy, PropertyBag, AvailabilityServiceExtension

web-container-availability SE/EE only

Nested Class Summary

Nested classes/interfaces inherited from interface org.jvnet.hk2.config.ConfigBeanProxy

ConfigBeanProxy.Duck

Nested classes/interfaces inherited from interface org.jvnet.hk2.config.types.PropertyBag

PropertyBag.Duck

Method Summary

Modifier and Type	Method	Description
String	getAvailabilityEnabled()	Gets the value of the availabilityEnabled property.
String	getDisableJreplica()	Gets thevalue of disableJreplica property.
String	getHttpSessionStorePoolName()	Deprecated.
String	getPersistenceFrequency()	Gets the value of the persistenceFrequency property.
String	getPersistenceScope()	Gets the value of the persistenceScope property.
String	getPersistenceStoreHealthCheckEnabled()	Deprecated.
String	getPersistenceType()	Gets the value of the persistenceType property.
List<Property>	getProperty()	Properties as per PropertyBag
String	getSsoFailoverEnabled()	Gets the value of the ssoFailoverEnabled property.
void	setAvailabilityEnabled(String value)	Sets the value of the availabilityEnabled property.
void	setDisableJreplica(String value)	Sets the disableJreplica property
void	setHttpSessionStorePoolName(String value)	Sets the value of the httpSessionStorePoolName property.
void	setPersistenceFrequency(String value)	Sets the value of the persistenceFrequency property.
void	setPersistenceScope(String value)	Sets the value of the persistenceScope property.
void	setPersistenceStoreHealthCheckEnabled(String value)	Sets the value of the persistenceStoreHealthCheckEnabled property.
void	setPersistenceType(String value)	Sets the value of the persistenceType property.
void	setSsoFailoverEnabled(String value)	Sets the value of the ssoFailoverEnabled property.

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

createChild, deepCopy, getParent, getParent

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

addProperty, getProperty, getPropertyValue, getPropertyValue, lookupProperty, removeProperty, removeProperty

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. Default is "true".

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

getPersistenceType

String getPersistenceType()

Gets the value of the persistenceType property. Specifies the session persistence mechanism for web applications that have availability enabled. Default is "replicated".

Returns:

possible object is String

setPersistenceType

void setPersistenceType(String value)
                 throws PropertyVetoException

Sets the value of the persistenceType property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getPersistenceFrequency

String getPersistenceFrequency()

Gets the value of the persistenceFrequency property. The persistence frequency used by the session persistence framework, when persistence-type = "ha". Values may be "time-based" or "web-event" If it is missing, then the persistence-type will revert to "memory".

Returns:

possible object is String

setPersistenceFrequency

void setPersistenceFrequency(String value)
                      throws PropertyVetoException

Sets the value of the persistenceFrequency property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getPersistenceScope

String getPersistenceScope()

Gets the value of the persistenceScope property. The persistence scope used by the session persistence framework, when persistence-type = "ha". Values may be "session", "modified-session", "modified-attribute". If it is missing, then the persistence-type will revert to "memory".

Returns:

possible object is String

setPersistenceScope

void setPersistenceScope(String value)
                  throws PropertyVetoException

Sets the value of the persistenceScope property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getPersistenceStoreHealthCheckEnabled

@Deprecated
String getPersistenceStoreHealthCheckEnabled()

Deprecated.

Gets the value of the persistenceStoreHealthCheckEnabled property. Deprecated. This attribute has no effect. If you wish to control enabling/disabling HADB health check, refer to store-healthcheck-enabled attribute in the availability-service element.

Returns:

possible object is String

setPersistenceStoreHealthCheckEnabled

void setPersistenceStoreHealthCheckEnabled(String value)
                                    throws PropertyVetoException

Sets the value of the persistenceStoreHealthCheckEnabled property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getSsoFailoverEnabled

String getSsoFailoverEnabled()

Gets the value of the ssoFailoverEnabled property. Controls whether Single-Sign-On state will be made available for failover

Returns:

possible object is String

setSsoFailoverEnabled

void setSsoFailoverEnabled(String value)
                    throws PropertyVetoException

Sets the value of the ssoFailoverEnabled property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getHttpSessionStorePoolName

@Deprecated
String getHttpSessionStorePoolName()

Deprecated.

Gets the value of the httpSessionStorePoolName property. This is the jndi-name for the JDBC Connection Pool used by the HTTP Session Persistence Framework. If missing, internal code will default it to value of store-pool-name under availability-service (ultimately "jdbc/hastore").

Returns:

possible object is String

setHttpSessionStorePoolName

void setHttpSessionStorePoolName(String value)
                          throws PropertyVetoException

Sets the value of the httpSessionStorePoolName property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getDisableJreplica

String getDisableJreplica()

Gets thevalue of disableJreplica property. This is the property used to disable setting the JREPLICA cookie

Returns:

returns the string representation of the boolean value

setDisableJreplica

void setDisableJreplica(String value)
                 throws PropertyVetoException

Sets the disableJreplica property

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getProperty

@ToDo(priority=IMPORTANT,
      details="Provide PropertyDesc for legal props")
@PropertiesDesc(props={})
List<Property> getProperty()

Properties as per PropertyBag

Specified by:

getProperty in interface PropertyBag

Returns:

the property list