org.jboss.weld.jsf

Class WeldPhaseListener

java.lang.Object

org.jboss.weld.jsf.WeldPhaseListener

public class WeldPhaseListener
extends java.lang.Object

A JSF phase listener that initializes aspects of Weld in a more fine-grained, integrated manner than what is possible with a servlet filter. This phase listener works in conjunction with other hooks and callbacks registered with the JSF runtime to help manage the Weld lifecycle.

The phase listener restores the long-running conversation if the conversation id token is detected in the request, activates the conversation context in either case (long-running or transient), and finally passivates the conversation after the response has been committed.

Execute before every phase in the JSF life cycle. The order this phase listener executes in relation to other phase listeners is determined by the ordering of the faces-config.xml descriptors. This phase listener should take precedence over extensions.

Author:

Nicklas Karlsson, Dan Allen, Ales Justin, Lincoln Baxter, III

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NO_CID

Constructor Summary

Constructors

Constructor and Description
WeldPhaseListener()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPhase(PhaseEvent phaseEvent)
void	beforePhase(PhaseEvent phaseEvent)
static java.lang.String	getConversationId(FacesContext facesContext, ConversationContext conversationContext) Gets the propagated conversation id parameter from the request
PhaseId	getPhaseId() The phase id for which this phase listener is active.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NO_CID

public static final java.lang.String NO_CID

See Also:

Constant Field Values

Constructor Detail

WeldPhaseListener

public WeldPhaseListener()

Method Detail

beforePhase

public void beforePhase(PhaseEvent phaseEvent)

afterPhase

public void afterPhase(PhaseEvent phaseEvent)

getPhaseId

public PhaseId getPhaseId()

The phase id for which this phase listener is active. This phase listener observes all JSF life-cycle phases.

getConversationId

public static java.lang.String getConversationId(FacesContext facesContext,
                                 ConversationContext conversationContext)

Gets the propagated conversation id parameter from the request

Returns:

The conversation id (or null if not found)