Cache configurations for EJB3 stateful beans

[jaikiran]

While updating the reference docs for EJB3, i found this information for JBossAS-4.x related to Stateful bean caching:

Stateful beans are stored in a cache. This cache is responsible for passivated stateful sessions when the cache becomes too full or a bean is too old. You may want to set things like the max size of this cache, and when beans should become idle. Configuration is different depending on whether you are clustered or not.

Non-Clustered:
For non clustered stateful beans, the @org.jboss.annotation.ejb.cache.simple.CacheConfig annotation is
responsible for configuring the cache.
Clustered:

For non clustered stateful beans, the @org.jboss.annotation.ejb.cache.tree.CacheConfig annotation is
responsible for configuring the cache.
No Passivation:

Sometimes it is useful to turn off passivation entirely. This can be done by plugging in the caching implementation using the @org.jboss.annotation.ejb.cache.Cache (org.jboss.ejb3.cache.NoPassivationCache.class) annotation.

The annotations have been now moved to a different location. And based on what i see in the definition of org.jboss.ejb3.annotation.CacheConfig:

@Retention(RetentionPolicy.RUNTIME)
@Target(
{ElementType.TYPE})
public @interface CacheConfig {

 // Class Members

 public static final String DEFAULT_CLUSTERED_OBJECT_NAME = "jboss.cache:service=EJB3SFSBClusteredCache";

 public static final int DEFAULT_NONCLUSTERED_MAX_SIZE = 100000;

 public static final int DEFAULT_CLUSTERED_MAX_SIZE = 10000;

 public static final long DEFAULT_IDLE_TIMEOUT_SECONDS = 300;

 public static final long DEFAULT_REMOVAL_TIMEOUT_SECONDS = 0;

 public static final boolean DEFAULT_REPL_IS_PASV = true;

 // Instance Members

 String name() default "";

 int maxSize() default CacheConfig.DEFAULT_NONCLUSTERED_MAX_SIZE;

 long idleTimeoutSeconds() default CacheConfig.DEFAULT_IDLE_TIMEOUT_SECONDS;

 boolean replicationIsPassivation() default CacheConfig.DEFAULT_REPL_IS_PASV;

 long removalTimeoutSeconds() default CacheConfig.DEFAULT_REMOVAL_TIMEOUT_SECONDS;
}

Am i right in saying:

1) For Non-Clustered: The @org.jboss.ejb3.annotation.CacheConfig is required to be used on the bean as follows:

@Stateful
@CacheConfig(maxSize = 1000, idleTimeoutSeconds = 1)
public class SimpleStatefulBean implements java.io.Serializable, SimpleStatefulRemote, SimpleStatefulLocal

2) For Clustered:

@Stateful
@CacheConfig(name=CacheConfig.DEFAULT_CLUSTERED_OBJECT_NAME, maxSize = 1000, idleTimeoutSeconds = 1)
@Clustered
public class SimpleStatefulBean implements java.io.Serializable, SimpleStatefulRemote, SimpleStatefulLocal

3) For no passivation:

@Stateful
@Cache(value="org.jboss.ejb3.cache.NoPassivationCache")
public class SimpleStatefulBean implements java.io.Serializable, SimpleStatefulRemote, SimpleStatefulLocal

[brian.stansberry]

For Clustered:

1) Setting the name=CacheConfig.DEFAULT_CLUSTERED_OBJECT_NAME attribute isn't necessary. If you leave the default "" value, StatefulTreeCache will use CacheConfig.DEFAULT_CLUSTERED_OBJECT_NAME.

2) For more on the meaning of the "name" attribute when used with StatefulTreeCache, see "Usage with EJB3 SFSB Clustering" section of http://www.jboss.org/community/docs/DOC-13185 .

3) maxSize=0 and idleTimeoutSeconds=0 will disable passivation for a bean that uses StatefulTreeCache.

Paul Ferraro is updating the EJB3 section of the AS Clustering Guide; suggest you ping him in case he has other comments.

[jaikiran]

Thanks Brian. Will get in touch with Paul.

[llsilva.carlos]

When I use

@Cache(value="org.jboss.ejb3.cache.NoPassivationCache")

The following occurs erros

Cache Factory with name org.jboss.ejb3.cache.NoPassivationCache is not registered.

[llsilva.carlos]

Hello, Sr.

There is an errata where the name passed is not the full class but only the simple name

http://www.manning.com/jamae/excerpt_updates_errata.html

transk

[]'s