Package org.glassfish.ejb.config

Interface EjbContainerAvailability

All Superinterfaces:

AvailabilityServiceExtension, ConfigBeanProxy, PropertyBag

public interface EjbContainerAvailability
extends ConfigBeanProxy, PropertyBag, AvailabilityServiceExtension

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.
List<Property>	getProperty()	Properties as per PropertyBag
String	getSfsbCheckpointEnabled()	Gets the value of the sfsbCheckpointEnabled property.
String	getSfsbHaPersistenceType()	Gets the value of the sfsbHaPersistenceType property.
String	getSfsbPersistenceType()	Gets the value of the sfsbPersistenceType property.
String	getSfsbQuickCheckpointEnabled()	Gets the value of the sfsbQuickCheckpointEnabled property.
String	getSfsbStorePoolName()	Gets the value of the sfsbStorePoolName property.
void	setAvailabilityEnabled(String value)	Sets the value of the availabilityEnabled property.
void	setSfsbCheckpointEnabled(String value)	Sets the value of the sfsbCheckpointEnabled property.
void	setSfsbHaPersistenceType(String value)	Sets the value of the sfsbHaPersistenceType property.
void	setSfsbPersistenceType(String value)	Sets the value of the sfsbPersistenceType property.
void	setSfsbQuickCheckpointEnabled(String value)	Sets the value of the sfsbQuickCheckpointEnabled property.
void	setSfsbStorePoolName(String value)	Sets the value of the sfsbStorePoolName 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 SFSB checkpointing (and potentially passivation). If this is "false", then all SFSB checkpointing is disabled for all j2ee apps and ejb modules If it is "true" (and providing that the global availability-enabled in availability-service is also "true", then j2ee apps and stand-alone ejb 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

getSfsbHaPersistenceType

String getSfsbHaPersistenceType()

Gets the value of the sfsbHaPersistenceType property. The persistence type used by the EJB Stateful Session Bean Container for checkpointing and passivating availability-enabled beans' state. Default is "ha".

Returns:

possible object is String

setSfsbHaPersistenceType

void setSfsbHaPersistenceType(String value)
                       throws PropertyVetoException

Sets the value of the sfsbHaPersistenceType property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getSfsbPersistenceType

String getSfsbPersistenceType()

Gets the value of the sfsbPersistenceType property. Specifies the passivation mechanism for stateful session beans that do not have availability enabled. Default is "file".

Returns:

possible object is String

setSfsbPersistenceType

void setSfsbPersistenceType(String value)
                     throws PropertyVetoException

Sets the value of the sfsbPersistenceType property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getSfsbCheckpointEnabled

String getSfsbCheckpointEnabled()

Gets the value of the sfsbCheckpointEnabled property. This attribute is deprecated, replaced by availability-enabled and will be ignored if present.

Returns:

possible object is String

setSfsbCheckpointEnabled

void setSfsbCheckpointEnabled(String value)
                       throws PropertyVetoException

Sets the value of the sfsbCheckpointEnabled property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getSfsbQuickCheckpointEnabled

String getSfsbQuickCheckpointEnabled()

Gets the value of the sfsbQuickCheckpointEnabled property. This attribute is deprecated and will be ignored if present.

Returns:

possible object is String

setSfsbQuickCheckpointEnabled

void setSfsbQuickCheckpointEnabled(String value)
                            throws PropertyVetoException

Sets the value of the sfsbQuickCheckpointEnabled property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getSfsbStorePoolName

String getSfsbStorePoolName()

Gets the value of the sfsbStorePoolName property. This is the jndi-name for the JDBC Connection Pool used by 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 value of store-pool-name under availability-service (ultimately "jdbc/hastore").

Returns:

possible object is String

setSfsbStorePoolName

void setSfsbStorePoolName(String value)
                   throws PropertyVetoException

Sets the value of the sfsbStorePoolName 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