org.jboss.weld.jsf

Class ConversationAwareViewHandler

java.lang.Object

ViewHandlerWrapper

org.jboss.weld.jsf.ConversationAwareViewHandler

public class ConversationAwareViewHandler
extends ViewHandlerWrapper

A forwarding JSF ViewHandler implementation that produces URLs containing the conversation id query string parameter. All methods except those which produce a URL that need to be enhanced are forwarded to the ViewHandler delegate.

A request parameter was chosen to propagate the conversation because it's the most technology agnostic approach for passing data between requests and allows for the ensuing request to use whatever means necessary (a servlet filter, phase listener, etc) to capture the conversation id and restore the long-running conversation.

Author:

Dan Allen, Pete Muir, Ales Justin, Marko Luksa

Constructor Summary

Constructors

Constructor and Description
ConversationAwareViewHandler(ViewHandler delegate)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getActionURL(FacesContext facesContext, java.lang.String viewId) Allow the delegate to produce the action URL.
java.lang.String	getBookmarkableURL(FacesContext context, java.lang.String viewId, java.util.Map<java.lang.String,java.util.List<java.lang.String>> parameters, boolean includeViewParams)
java.lang.String	getRedirectURL(FacesContext context, java.lang.String viewId, java.util.Map<java.lang.String,java.util.List<java.lang.String>> parameters, boolean includeViewParams)
java.lang.String	getResourceURL(FacesContext context, java.lang.String path)
ViewHandler	getWrapped()

Methods inherited from class java.lang.Object

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

Constructor Detail

ConversationAwareViewHandler

public ConversationAwareViewHandler(ViewHandler delegate)

Method Detail

getActionURL

public java.lang.String getActionURL(FacesContext facesContext,
                                     java.lang.String viewId)

Allow the delegate to produce the action URL. If the conversation is long-running, append the conversation id request parameter to the query string part of the URL, but only if the request parameter is not already present.

This covers form actions Ajax calls, and redirect URLs (which we want) and link hrefs (which we don't)

See Also:

ViewHandler#getActionURL(FacesContext, String)}

getBookmarkableURL

public java.lang.String getBookmarkableURL(FacesContext context,
                                           java.lang.String viewId,
                                           java.util.Map<java.lang.String,java.util.List<java.lang.String>> parameters,
                                           boolean includeViewParams)

getRedirectURL

public java.lang.String getRedirectURL(FacesContext context,
                                       java.lang.String viewId,
                                       java.util.Map<java.lang.String,java.util.List<java.lang.String>> parameters,
                                       boolean includeViewParams)

getResourceURL

public java.lang.String getResourceURL(FacesContext context,
                                       java.lang.String path)

getWrapped

public ViewHandler getWrapped()