Project Documentation


Tag name: <s:ensureConversation>
UIComponent class: org.apache.myfaces.custom.conversation.UIEnsureConversation
Tag class: org.apache.myfaces.custom.conversation.EnsureConversationTag
Component type: org.apache.myfaces.EnsureConversation
Component family: javax.faces.Component
Renderer type: javax.faces.Button

Ensures a named conversation is running

check if a conversation is active.

The way this is done here is sub-optimal, once we are on jsf 1.2 it should be possible to check this before ANY rendering - and maybe to invoke a navigation then


Name Type Supports EL? Description
action javax.faces.el.MethodBinding Yes the action which should be called in case of a not running conversation
actionListener javax.faces.el.MethodBinding Only EL A method binding EL expression that identifies an action listener method to be invoked if this component is activated by the user. An action listener method accepts a parameter of type javax.faces.event.ActionEvent and returns void. The phase that this event is fired in can be controlled via the immediate attribute.
binding String Only EL Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.
id String Yes An identifier for this particular component instance within a component view.

The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view

This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted.

immediate boolean Yes A boolean value that identifies the phase during which action events should fire. During normal event processing, action methods and action listener methods are fired during the "invoke application" phase of request processing. If this attribute is set to "true", these methods are fired instead at the end of the "apply request values" phase.
name String Yes the name of the conversation. Notice: required if tag not as child of startConversation tag.
preCheck Boolean Yes Delegate the check to the action method at all. The user has to check if a conversation is running. A action method is mandatory.
redirectTo String Yes redirect to the given view if the conversation is not running
rendered boolean Yes A boolean value that indicates whether this component should be rendered. Default value: true.
value Object Yes The initial value of this component.