org.glassfish.ejb.config

Interface EjbTimerService

All Superinterfaces:

ConfigBeanProxy, PropertyBag

public interface EjbTimerService
extends ConfigBeanProxy, PropertyBag

Configuration for ejb timer service

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE_DATABASE
static String	TYPE_NONE

Method Summary

Modifier and Type	Method and Description
String	getClusterFiringMode() Sets the mode of firing for cluster deployed EJB Timers OnePerCluster timer is only active on 1 node in the cluster OnePerDeploymentGroup timer is only active on 1 node in a Deployment Group AllInstances timer is active on all instances where the application is deployed
String	getEjbTimerService() Gets the value of the EJB Timer Service property.
@Min(value=1L) String	getMaxRedeliveries() Gets the value of the maxRedeliveries property.
@Min(value=1L) String	getMinimumDeliveryIntervalInMillis() Gets the value of the minimumDeliveryIntervalInMillis property.
List<Property>	getProperty() Properties as per PropertyBag
@Min(value=1L) String	getRedeliveryIntervalInternalInMillis() Gets the value of the redeliveryIntervalInternalInMillis property.
String	getTimerDatasource() Gets the value of the timerDatasource property.
void	setClusterFiringMode(String value)
void	setEjbTimerService(String value) Sets the value of the EJB Timer type to be used.
void	setMaxRedeliveries(String value) Sets the value of the maxRedeliveries property.
void	setMinimumDeliveryIntervalInMillis(String value) Sets the value of the minimumDeliveryIntervalInMillis property.
void	setRedeliveryIntervalInternalInMillis(String value) Sets the value of the redeliveryIntervalInternalInMillis property.
void	setTimerDatasource(String value) Sets the value of the timerDatasource 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

Field Detail

TYPE_NONE

static final String TYPE_NONE

See Also:

Constant Field Values

TYPE_DATABASE

static final String TYPE_DATABASE

See Also:

Constant Field Values

Method Detail

getMinimumDeliveryIntervalInMillis

@Min(value=1L)
@Min(value=1L) String getMinimumDeliveryIntervalInMillis()

Gets the value of the minimumDeliveryIntervalInMillis property. It is the minimum number of milliseconds allowed before the next timer expiration for a particular timer can occur. It guards against extremely small timer increments that can overload the server.

Returns:

possible object is String

setMinimumDeliveryIntervalInMillis

void setMinimumDeliveryIntervalInMillis(String value)
                                 throws PropertyVetoException

Sets the value of the minimumDeliveryIntervalInMillis property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getMaxRedeliveries

@Min(value=1L)
@Min(value=1L) String getMaxRedeliveries()

Gets the value of the maxRedeliveries property. It is the maximum number of times the ejb timer service will attempt to redeliver a timer expiration due to exception or rollback. The minimum value is 1, per the ejb specification.

Returns:

possible object is String

setMaxRedeliveries

void setMaxRedeliveries(String value)
                 throws PropertyVetoException

Sets the value of the maxRedeliveries property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getTimerDatasource

String getTimerDatasource()

Gets the value of the timerDatasource property. overrides cmp-resource (jdbc/__TimerPool) specified in sun-ejb-jar.xml of (__ejb_container_timer_app) of the timer service system application. By default this is set to jdbc/__TimerPool, but can be overridden for the cluster or server instance, if they choose to.

Returns:

possible object is String

setTimerDatasource

void setTimerDatasource(String value)
                 throws PropertyVetoException

Sets the value of the timerDatasource property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getRedeliveryIntervalInternalInMillis

@Min(value=1L)
@Min(value=1L) String getRedeliveryIntervalInternalInMillis()

Gets the value of the redeliveryIntervalInternalInMillis property. It is the number of milliseconds the ejb timer service will wait after a failed ejbTimeout delivery before attempting a redelivery.

Returns:

possible object is String

setRedeliveryIntervalInternalInMillis

void setRedeliveryIntervalInternalInMillis(String value)
                                    throws PropertyVetoException

Sets the value of the redeliveryIntervalInternalInMillis property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getEjbTimerService

String getEjbTimerService()

Gets the value of the EJB Timer Service property. The EJB Timer Service type to use in Payara. Supported values:

• "Database" for database-backed persistence
• "DataGrid" for DataGrid-backed persistence
• "None" for non-persistent timer service

Returns:

One of the options above

setEjbTimerService

void setEjbTimerService(String value)
                 throws PropertyVetoException

Sets the value of the EJB Timer type to be used.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getClusterFiringMode

String getClusterFiringMode()

Sets the mode of firing for cluster deployed EJB Timers OnePerCluster timer is only active on 1 node in the cluster OnePerDeploymentGroup timer is only active on 1 node in a Deployment Group AllInstances timer is active on all instances where the application is deployed

Returns:

setClusterFiringMode

void setClusterFiringMode(String value)
                   throws PropertyVetoException

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