EjbContainer (Payara Project 5.193.1 API)

All Superinterfaces:

ConfigBeanProxy, ConfigExtension, Container, PropertyBag
```
public interface EjbContainer
extends ConfigBeanProxy, PropertyBag, ConfigExtension
```
Configuration of EJB Container

Nested Class Summary
- Nested classes/interfaces inherited from interface org.jvnet.hk2.config.types.PropertyBag
  PropertyBag.Duck

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`DEFAULT_ALLOW_CORE_THREAD_TIMEOUT`
`static boolean`	`DEFAULT_PRESTART_ALL_CORE_THREADS`
`static int`	`DEFAULT_THREAD_CORE_POOL_SIZE`
`static long`	`DEFAULT_THREAD_KEEP_ALIVE_SECONDS`
`static int`	`DEFAULT_THREAD_MAX_POOL_SIZE`
`static int`	`DEFAULT_THREAD_QUEUE_CAPACITY`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`@Min(value=0L) String`	`getCacheIdleTimeoutInSeconds()` Gets the value of the cacheIdleTimeoutInSeconds property.
`@Min(value=1L) String`	`getCacheResizeQuantity()` Gets the value of the cacheResizeQuantity property.
`@Pattern(regexp="B\|C") String`	`getCommitOption()` Gets the value of the commitOption property.
`@NotNull EjbTimerService`	`getEjbTimerService()` Gets the value of the ejbTimerService property.
`String`	`getLimitInstancesEnabled()` Gets the value of the limitInstancesEnabled property.
`@Min(value=0L) String`	`getMaxCacheSize()` Gets the value of the maxCacheSize property.
`@Min(value=0L) String`	`getMaxPoolSize()` Gets the value of the maxPoolSize property.
`@Min(value=0L) @Max(value=30000L) String`	`getMaxWaitTimeInMillis()` Gets the value of the maxWaitTimeInMillis property.
`@Min(value=0L) String`	`getPoolIdleTimeoutInSeconds()` Gets the value of the poolIdleTimeoutInSeconds property.
`@Min(value=0L) String`	`getPoolResizeQuantity()` Gets the value of the poolResizeQuantity property.
`List<Property>`	`getProperty()` Properties as per `PropertyBag`
`@Min(value=0L) String`	`getRemovalTimeoutInSeconds()` Gets the value of the removalTimeoutInSeconds property.
`String`	`getSessionStore()` Gets the value of the sessionStore property.
`@Min(value=0L) String`	`getSteadyPoolSize()` Gets the value of the steadyPoolSize property.
`@Pattern(regexp="(nru\|fifo\|lru)") String`	`getVictimSelectionPolicy()` Gets the value of the victimSelectionPolicy property.
`void`	`setCacheIdleTimeoutInSeconds(String value)` Sets the value of the cacheIdleTimeoutInSeconds property.
`void`	`setCacheResizeQuantity(String value)` Sets the value of the cacheResizeQuantity property.
`void`	`setCommitOption(String value)` Sets the value of the commitOption property.
`void`	`setEjbTimerService(EjbTimerService value)` Sets the value of the ejbTimerService property.
`void`	`setLimitInstancesEnabled(String value)` Sets the value of the limitInstancesEnabled property.
`void`	`setMaxCacheSize(String value)` Sets the value of the maxCacheSize property.
`void`	`setMaxPoolSize(String value)` Sets the value of the maxPoolSize property.
`void`	`setMaxWaitTimeInMillis(String value)` Sets the value of the maxWaitTimeInMillis property.
`void`	`setPoolIdleTimeoutInSeconds(String value)` Sets the value of the poolIdleTimeoutInSeconds property.
`void`	`setPoolResizeQuantity(String value)` Sets the value of the poolResizeQuantity property.
`void`	`setRemovalTimeoutInSeconds(String value)` Sets the value of the removalTimeoutInSeconds property.
`void`	`setSessionStore(String value)` Sets the value of the sessionStore property.
`void`	`setSteadyPoolSize(String value)` Sets the value of the steadyPoolSize property
`void`	`setVictimSelectionPolicy(String value)` Sets the value of the victimSelectionPolicy property.

Methods inherited from interface org.jvnet.hk2.config.types.PropertyBag
addProperty, getProperty, getPropertyValue, getPropertyValue, lookupProperty, removeProperty, removeProperty

Methods inherited from interface org.jvnet.hk2.config.ConfigBeanProxy
createChild, deepCopy, getParent, getParent

- Field Detail
  - DEFAULT_THREAD_CORE_POOL_SIZE
```
static final int DEFAULT_THREAD_CORE_POOL_SIZE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_THREAD_MAX_POOL_SIZE
```
static final int DEFAULT_THREAD_MAX_POOL_SIZE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_THREAD_KEEP_ALIVE_SECONDS
```
static final long DEFAULT_THREAD_KEEP_ALIVE_SECONDS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_THREAD_QUEUE_CAPACITY
```
static final int DEFAULT_THREAD_QUEUE_CAPACITY
```
    See Also:
    
    Constant Field Values
  - DEFAULT_ALLOW_CORE_THREAD_TIMEOUT
```
static final boolean DEFAULT_ALLOW_CORE_THREAD_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_PRESTART_ALL_CORE_THREADS
```
static final boolean DEFAULT_PRESTART_ALL_CORE_THREADS
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getSteadyPoolSize
```
@Min(value=0L)
@Min(value=0L) String getSteadyPoolSize()
```
    Gets the value of the steadyPoolSize property. (slsb,eb) number of bean instances normally maintained in pool. When a pool is first created, it will be populated with size equal to steady-pool-size. When an instance is removed from the pool, it is replenished asynchronously, so that the pool size is at or above the steady-pool-size. This addition will be in multiples of pool-resize-quantity. When a bean is disassociated from a method invocation, it is put back in the pool, subject to max-pool-size limit. If the max pool size is exceeded the bean id destroyed immediately. A pool cleaning thread, executes at an interval defined by pool-idle-timeout-in-seconds. This thread reduces the pool size to steady-pool-size, in steps defined by pool-resize-quantity. If the pool is empty, the required object will be created and returned immediately. This prevents threads from blocking till the pool is replenished by the background thread. steady-pool-size must be greater than 1 and at most equal to the max-pool-size.
    
    Returns:
    
    possible object is String
  - setSteadyPoolSize
```
void setSteadyPoolSize(String value)
                throws PropertyVetoException
```
    Sets the value of the steadyPoolSize property
    
    Parameters:
    
    value - allowed object is String
    
    Throws:
    
    PropertyVetoException
  - getPoolResizeQuantity
```
@Min(value=0L)
@Min(value=0L) String getPoolResizeQuantity()
```
    Gets the value of the poolResizeQuantity property. (slsb,eb) size of bean pool grows (shrinks) in steps specified by pool-resize-quantity, subject to max-pool-size (steady-pool-size) limit.
    
    Returns:
    
    possible object is String
  - setPoolResizeQuantity
```
void setPoolResizeQuantity(String value)
                    throws PropertyVetoException
```
    Sets the value of the poolResizeQuantity property.
    
    Parameters:
    
    value - allowed object is String
    
    Throws:
    
    PropertyVetoException
  - getMaxPoolSize
```
@Min(value=0L)
@Min(value=0L) String getMaxPoolSize()
```
    Gets the value of the maxPoolSize property. (slsb,eb) maximum size, a pool can grow to. A value of 0 implies an unbounded pool. Unbounded pools eventually shrink to the steady-pool-size, in steps defined by pool-resize-quantity.
    
    Returns:
    
    possible object is String
  - setMaxPoolSize
```
void setMaxPoolSize(String value)
             throws PropertyVetoException
```
    Sets the value of the maxPoolSize property.
    
    Parameters:
    
    value - allowed object is String
    
    Throws:
    
    PropertyVetoException
  - getCacheResizeQuantity
```
@Min(value=1L)
@Min(value=1L) String getCacheResizeQuantity()
```
    Gets the value of the cacheResizeQuantity property. (eb,sfsb) Cache elements have identity, hence growth is in unit steps and created on demand. Shrinking of cache happens when cache-idle-timeout-in-seconds timer expires and a cleaner thread passivates beans which have been idle for longer than cache-idle-timeout-in-seconds. All idle instances are passivated at once. cache-resize-quantity does not apply in this case. When max cache size is reached, an asynchronous task is created to bring the size back under the max-cache-size limit. This task removes cache-resize-quantity elements, consulting the victim-selection-policy. Must be greater than 1 and less than max-cache-size.
    
    Returns:
    
    possible object is String
  - setCacheResizeQuantity
```
void setCacheResizeQuantity(String value)
                     throws PropertyVetoException
```
    Sets the value of the cacheResizeQuantity property.
    
    Parameters:
    
    value - allowed object is String
    
    Throws:
    
    PropertyVetoException
  - getMaxCacheSize
```
@Min(value=0L)
@Min(value=0L) String getMaxCacheSize()
```
    Gets the value of the maxCacheSize property. (sfsb,eb) specifies the maximum number of instances that can be cached. For entity beans, internally two caches are maintained for higher concurrency: (i) Ready (R$) (ii) Active in an Incomplete Transaction(TX$) The TX$ is populated with instances from R$ or from the Pool directly. When an instance in TX$ completes the transaction, it is placed back in R$ (or in pool, in case an instance with same identity already is in R$). max-cache-size only specifies the upper limit for R$. The container computes an appropriate size for TX$. For SFSBs, after the max-cache-size is reached, beans(as determined by victim-selection-policy) get passivated.
    
    Returns:
    
    possible object is String
  - setMaxCacheSize
```
void setMaxCacheSize(String value)
              throws PropertyVetoException
```
    Sets the value of the maxCacheSize property.
    
    Parameters:
    
    value - allowed object is String
    
    Throws:
    
    PropertyVetoException
  - getPoolIdleTimeoutInSeconds
```
@Min(value=0L)
@Min(value=0L) String getPoolIdleTimeoutInSeconds()
```
    Gets the value of the poolIdleTimeoutInSeconds property. (slsb,eb) defines the rate at which the pool cleaning thread is executed. This thread checks if current size is greater than steady pool size, it removes pool-resize-quantity elements. If the current size is less than steady-pool-size it is increased by pool-resize-quantity, with a ceiling of min (current-pool-size + pool-resize-quantity, max-pool-size) Only objects that have not been accessed for more than pool-idle-timeout-in-seconds are candidates for removal.
    
    Returns:
    
    possible object is String
  - setPoolIdleTimeoutInSeconds
```
void setPoolIdleTimeoutInSeconds(String value)
                          throws PropertyVetoException
```
    Sets the value of the poolIdleTimeoutInSeconds property.
    
    Parameters:
    
    value - allowed object is String
    
    Throws:
    
    PropertyVetoException
  - getMaxWaitTimeInMillis
```
@Min(value=0L)
 @Max(value=30000L)
@Min(value=0L) @Max(value=30000L) String getMaxWaitTimeInMillis()
```
    Gets the value of the maxWaitTimeInMillis property.
    
    Returns:
    
    possible object is Integer
  - setMaxWaitTimeInMillis
```
void setMaxWaitTimeInMillis(String value)
                     throws PropertyVetoException
```
    Sets the value of the maxWaitTimeInMillis property.
    
    Parameters:
    
    value - allowed object is Integer
    
    Throws:
    
    PropertyVetoException
  - getLimitInstancesEnabled
```
String getLimitInstancesEnabled()
```
    Gets the value of the limitInstancesEnabled property.
    
    Returns:
    
    possible object is Boolean
  - setLimitInstancesEnabled
```
void setLimitInstancesEnabled(String value)
                       throws PropertyVetoException
```
    Sets the value of the limitInstancesEnabled property.
    
    Parameters:
    
    value - allowed object is Boolean
    
    Throws:
    
    PropertyVetoException
  - getCacheIdleTimeoutInSeconds
```
@Min(value=0L)
@Min(value=0L) String getCacheIdleTimeoutInSeconds()
```
    Gets the value of the cacheIdleTimeoutInSeconds property. (eb, sfsb) specifies the rate at which the cache cleaner thread is scheduled. All idle instances are passivated at once.
    
    Returns:
    
    possible object is String
  - setCacheIdleTimeoutInSeconds
```
void setCacheIdleTimeoutInSeconds(String value)
                           throws PropertyVetoException
```
    Sets the value of the cacheIdleTimeoutInSeconds property.
    
    Parameters:
    
    value - allowed object is String
    
    Throws:
    
    PropertyVetoException
  - getRemovalTimeoutInSeconds
```
@Min(value=0L)
@Min(value=0L) String getRemovalTimeoutInSeconds()
```
    Gets the value of the removalTimeoutInSeconds property. (sfsb) Instance is removed from cache or passivation store, if it is not accesed within this time. All instances that can be removed, will be removed.
    
    Returns:
    
    possible object is String
  - setRemovalTimeoutInSeconds
```
void setRemovalTimeoutInSeconds(String value)
                         throws PropertyVetoException
```
    Sets the value of the removalTimeoutInSeconds property.
    
    Parameters:
    
    value - allowed object is String
    
    Throws:
    
    PropertyVetoException
  - getVictimSelectionPolicy
```
@Pattern(regexp="(nru|fifo|lru)")
@Pattern(regexp="(nru|fifo|lru)") String getVictimSelectionPolicy()
```
    Gets the value of the victimSelectionPolicy property. (sfsb) Victim selection policy when cache needs to shrink. Victims are passivated. Entity Bean Victims are selected always using fifo discipline Does not apply to slsb because it does not matter, which particular instances are removed. fifo method picks victims, oldest instance first. lru algorithm picks least recently accessed instances. nru policy tries to pick 'not recently used' instances and is a pseudo-random selection process.
    
    Returns:
    
    possible object is String
  - setVictimSelectionPolicy
```
void setVictimSelectionPolicy(String value)
                       throws PropertyVetoException
```
    Sets the value of the victimSelectionPolicy property.
    
    Parameters:
    
    value - allowed object is String
    
    Throws:
    
    PropertyVetoException
  - getCommitOption
```
@Pattern(regexp="B|C")
@Pattern(regexp="B|C") String getCommitOption()
```
    Gets the value of the commitOption property. (eb) Entity Beans caching is controlled by this setting. Commit Option C implies that no caching is performed in the container.
    
    Returns:
    
    possible object is String
  - setCommitOption
```
void setCommitOption(String value)
              throws PropertyVetoException
```
    Sets the value of the commitOption property.
    
    Parameters:
    
    value - allowed object is String
    
    Throws:
    
    PropertyVetoException
  - getSessionStore
```
String getSessionStore()
```
    Gets the value of the sessionStore property. specifies the directory where passivated beans & persisted HTTP sessions are stored on the file system. Defaults to $INSTANCE-ROOT/session-store
    
    Returns:
    
    possible object is String
  - setSessionStore
```
void setSessionStore(String value)
              throws PropertyVetoException
```
    Sets the value of the sessionStore property.
    
    Parameters:
    
    value - allowed object is String
    
    Throws:
    
    PropertyVetoException
  - getEjbTimerService
```
@NotNull
@NotNull EjbTimerService getEjbTimerService()
```
    Gets the value of the ejbTimerService property. Contains the configuration for the ejb timer service. There is at most one ejb timer service per server instance.
    
    Returns:
    
    possible object is EjbTimerService
  - setEjbTimerService
```
void setEjbTimerService(EjbTimerService value)
                 throws PropertyVetoException
```
    Sets the value of the ejbTimerService property.
    
    Parameters:
    
    value - allowed object is EjbTimerService
    
    Throws:
    
    PropertyVetoException
  - getProperty
```
@ToDo(priority=IMPORTANT,
      details="Provide PropertyDesc for legal props")
 @PropertyDesc(name="disable-nonportable-jndi-names",defaultValue="false",values={"true","false"}) @PropertyDesc(name="thread-core-pool-size") @PropertyDesc(name="thread-max-pool-size") @PropertyDesc(name="thread-keep-alive-seconds") @PropertyDesc(name="thread-queue-capacity") @PropertyDesc(name="allow-core-thread-timeout") @PropertyDesc(name="prestart-all-core-threads")
List<Property> getProperty()
```
    Properties as per PropertyBag
    
    Specified by:
    
    getProperty in interface PropertyBag
    
    Returns:
    
    the property list

Interface EjbContainer

Nested Class Summary

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

Field Summary

Method Summary

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

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

Field Detail

DEFAULT_THREAD_CORE_POOL_SIZE

DEFAULT_THREAD_MAX_POOL_SIZE

DEFAULT_THREAD_KEEP_ALIVE_SECONDS

DEFAULT_THREAD_QUEUE_CAPACITY

DEFAULT_ALLOW_CORE_THREAD_TIMEOUT

DEFAULT_PRESTART_ALL_CORE_THREADS

Method Detail

getSteadyPoolSize

setSteadyPoolSize

getPoolResizeQuantity

setPoolResizeQuantity

getMaxPoolSize

setMaxPoolSize

getCacheResizeQuantity

setCacheResizeQuantity

getMaxCacheSize

setMaxCacheSize

getPoolIdleTimeoutInSeconds

setPoolIdleTimeoutInSeconds

getMaxWaitTimeInMillis

setMaxWaitTimeInMillis

getLimitInstancesEnabled

setLimitInstancesEnabled

getCacheIdleTimeoutInSeconds

setCacheIdleTimeoutInSeconds

getRemovalTimeoutInSeconds

setRemovalTimeoutInSeconds

getVictimSelectionPolicy

setVictimSelectionPolicy

getCommitOption

setCommitOption

getSessionStore

setSessionStore

getEjbTimerService

setEjbTimerService

getProperty