Saturday, September 15, 2012

Configure timeout for CDI conversations

CDI conversation scope is a nice feature when developing JSF applications. Imagine you have large data tables which take a long time to be loaded. You normally don't want to place the loaded data in session scoped beans by reason of high memory consumption. And you can't place the loaded data in view scoped beans because you wouldn't like always to reload data again if user leave and enter the same view. It would be nice only to keep data if user enters the same page within a certain time interval and reload them again if the bean was not accessed within this time interval. This can be achieved by conversation scoped bean with timeout. We will deal with MyFaces CODI (CDI Extensions) and see how to set a custom timeout for beans annotated with @ConversationScoped. The default timeout is 30 min. what is too long for our example. We will configure it for 1 min. The first step is to extend CODI's ConversationConfig and overwrite the method getConversationTimeoutInMinutes(). Let's write a class AlternativeConversationConfig.
package controller.cdi;

import javax.enterprise.context.ApplicationScoped;
import javax.enterprise.inject.Alternative;
import javax.enterprise.inject.Specializes;
import org.apache.myfaces.extensions.cdi.core.api.config.ConfigEntry;
import org.apache.myfaces.extensions.cdi.core.api.scope.conversation.config.ConversationConfig;

@ApplicationScoped
@Alternative
@Specializes
public class AlternativeConversationConfig extends ConversationConfig {

    @ConfigEntry
    public int getConversationTimeoutInMinutes() {
        return 1;
    }
}
The important thing is the annotation @Specializes which allows to inject AlternativeConversationConfig instead of ConversationConfig at every existing places. The second step is a proper entry in beans.xml to use (activate) our class on all injection points for ConversationConfig.
<alternatives>
    <class>controller.cdi.AlternativeConversationConfig</class>
</alternatives>
Server's log output during startup contains these lines now
config implementation:
controller.cdi.AlternativeConversationConfig$Proxy$_$$_WeldClientProxy
config implementation: controller.cdi.AlternativeConversationConfig
   method: getConversationTimeoutInMinutes
   value: 1
To check if everything is ok, we can write a conversation scoped bean and use it in facelets.
import java.io.Serializable;
import javax.faces.event.ActionEvent;
import javax.inject.Named;
import org.apache.myfaces.extensions.cdi.core.api.scope.conversation.ConversationScoped;

@Named
@ConversationScoped
public class CdiBeanConversationScoped implements Serializable {
 
    private int counter;
 
    public int getCounter() {
        return counter;
    }
 
    public void increment(ActionEvent e) {
        counter++;
    }
}
<h:outputText id="counter" value="Conversation scoped counter: #{cdiBeanConversationScoped.counter}"/>
   
<p:commandButton value="Increment counter" process="@this" update="counter"
                                         actionListener="#{cdiBeanConversationScoped.increment}"/>
The counter will expire after 1 min. if no access to the bean happens within this time interval. Simple push the button to increment the counter, wait longer than 1 min. and increment it again. You will see that counter was reseted.

5 comments:

  1. Looking for "timeout" on Codi ConversationScope I found your article. My first impression was: I can't imagine that overriding this with my own class and using CDI to introduce this as an alternative is the right way to do this.

    But according to a comment in the original ConversationConfig class from codi this is the way the author intended this to happen.

    Just wanted to mention this.
    Thanks for sharing your solution.

    ReplyDelete
  2. Why all this extra stuff if you can use Conversation.setTimeout()?

    ReplyDelete
  3. I think Conversation.setTimeout() is valid only per Conversation and for all CDI beans (global).

    ReplyDelete
  4. Hi Oleg,
    I'm trying to implement your solution. I'm running on jboss AS 7.1.
    When I try to deploy my application, I'm facing with an exception below:

    WELD-001408 Unsatisfied dependencies for type [ConversationConfig] with qualifiers [@Default] at injection point
    [[parameter 2] of [constructor]
    @Inject public org.apache.myfaces.extensions.cdi.jsf.impl.scope.conversation.EditableWindowContextManagerProxy
    (WindowContextConfig, ConversationConfig, BeanManager)]
    at org.jboss.weld.bootstrap.Validator.validateInjectionPoint(Validator.java:275)

    Does it speaks to you?
    Thank you in advance
    Massai

    ReplyDelete