A C D E G I M O P R S V

A

addDialogAction(DialogMetadata.SCXMLAction) - Method in class org.apache.shale.dialog.scxml.config.DialogMetadata

Add this Commons SCXML custom action for this specific dialog.

C

CONFIGURATION - Static variable in class org.apache.shale.dialog.scxml.Globals

Context initialization paramater name under which a comma separated list of configuration resources to be parsed exists.

ConfigurationParser - Class in org.apache.shale.dialog.scxml.config

Configuration utility for parsing SCXML documents as resources for defining dialogs.

ConfigurationParser() - Constructor for class org.apache.shale.dialog.scxml.config.ConfigurationParser

contextDestroyed(ServletContextEvent) - Method in class org.apache.shale.dialog.scxml.SCXMLLifecycleListener

Process the application shutdown event, cleanup resources.

contextInitialized(ServletContextEvent) - Method in class org.apache.shale.dialog.scxml.SCXMLLifecycleListener

Process the application startup event, parse dialog configurations.

create(FacesContext, String) - Method in class org.apache.shale.dialog.scxml.SCXMLDialogManager

create(FacesContext, String, DialogContext) - Method in class org.apache.shale.dialog.scxml.SCXMLDialogManager

CUSTOM_SCXML_ACTIONS_URI - Static variable in class org.apache.shale.dialog.scxml.Globals

The namespace URI for the custom Commons SCXML actions defined by the Shale dialogs Commons SCXML implementation.

D

DefaultDialogStateMapper - Class in org.apache.shale.dialog.scxml.impl

Default DialogStateMapper implementation.

DefaultDialogStateMapper() - Constructor for class org.apache.shale.dialog.scxml.impl.DefaultDialogStateMapper

DIALOG_PROPERTIES - Static variable in class org.apache.shale.dialog.scxml.Globals

The key for saving dialog properties in the root context of the underlying Commons SCXML state machine.

DialogMetadata - Class in org.apache.shale.dialog.scxml.config

Bean encapsulating metadata for a Shale dialog when using Commons SCXML to drive the underlying state machine.

DialogMetadata() - Constructor for class org.apache.shale.dialog.scxml.config.DialogMetadata

Constructor.

DialogMetadata.SCXMLAction - Class in org.apache.shale.dialog.scxml.config

A POJO representing the bits of a custom Commons SCXML action used in a Shale dialog.

DialogMetadata.SCXMLAction() - Constructor for class org.apache.shale.dialog.scxml.config.DialogMetadata.SCXMLAction

Constructor.

DialogProperties - Class in org.apache.shale.dialog.scxml

Simple POJO properties class that gets stored in the root context of each state machine instance driving a Shale dialog.

DIALOGS - Static variable in class org.apache.shale.dialog.scxml.Globals

Application scope attribute under which a Map of dialog definitions (keyed by dialog name) is stored.

DialogStateMapper - Interface in org.apache.shale.dialog.scxml

DialogStateMapper is an interface describing a pluggable mechanism to map between the state ID within a SCXML dialog definition and the corresponding JavaServer Faces view identifier that should be rendered when the dialog state machine comes to rest in that state.

E

eval(Context, String) - Method in class org.apache.shale.dialog.scxml.ShaleDialogELEvaluator

Evaluate an expression.

execute(EventDispatcher, ErrorReporter, SCInstance, Log, Collection) - Method in class org.apache.shale.dialog.scxml.action.RedirectAction

Set redirection flag in dialog properties so the next rendered dialog view is issued as a redirect.

execute(EventDispatcher, ErrorReporter, SCInstance, Log, Collection) - Method in class org.apache.shale.dialog.scxml.action.ViewAction

Set nextViewId in dialog properties, which will be the next view rendered by this dialog.

G

get(String) - Method in class org.apache.shale.dialog.scxml.SCXMLDialogManager

getActionclassname() - Method in class org.apache.shale.dialog.scxml.config.DialogMetadata.SCXMLAction

Get the action class FQN.

getDataclassname() - Method in class org.apache.shale.dialog.scxml.config.DialogMetadata

Get the data class FQN.

getDialogActions() - Method in class org.apache.shale.dialog.scxml.config.DialogMetadata

Get the list of dialog actions defined for this specific dialog.

getDialogs() - Method in class org.apache.shale.dialog.scxml.config.ConfigurationParser

Return the Map of Dialog instances into which parsed information will be stored, keyed by dialog name.

getName() - Method in class org.apache.shale.dialog.scxml.config.DialogMetadata

Get the dialog name.

getName() - Method in class org.apache.shale.dialog.scxml.config.DialogMetadata.SCXMLAction

Get the action name.

getNextViewId() - Method in class org.apache.shale.dialog.scxml.DialogProperties

Get the JSF view identifier of the next view to be rendered in this dialog.

getResource() - Method in class org.apache.shale.dialog.scxml.config.ConfigurationParser

Return the URL of the configuration resource to be parsed.

getScxmlconfig() - Method in class org.apache.shale.dialog.scxml.config.DialogMetadata

Get the location where the SCXML document for this dialog resides.

getStateMachine() - Method in class org.apache.shale.dialog.scxml.config.DialogMetadata

Get the Commons SCXML object model describing the state machine for this dialog.

getUri() - Method in class org.apache.shale.dialog.scxml.config.DialogMetadata.SCXMLAction

Get the action URI.

getViewId() - Method in class org.apache.shale.dialog.scxml.action.ViewAction

Get the view identifier.

Globals - Class in org.apache.shale.dialog.scxml

Manifest constants and well known event names for the Jakarta Commons SCXML driven Shale dialog implementation.

Globals() - Constructor for class org.apache.shale.dialog.scxml.Globals

I

isNextRedirect() - Method in class org.apache.shale.dialog.scxml.DialogProperties

Should next view rendered by this dialog be redirected.

isValidating() - Method in class org.apache.shale.dialog.scxml.config.ConfigurationParser

Return a flag indicating whether we will be doing a validating parse or not.

M

mapStateId(String, String, FacesContext) - Method in interface org.apache.shale.dialog.scxml.DialogStateMapper

Return the JavaServer Faces view identifier that corresponds to current dialog state.

mapStateId(String, String, FacesContext) - Method in class org.apache.shale.dialog.scxml.impl.DefaultDialogStateMapper

The default implementation is an identity transform which returns the dialog state ID as the next JavaServer Faces view identifier.

O

org.apache.shale.dialog.scxml - package org.apache.shale.dialog.scxml

The Commons SCXML implementation of the Shale dialog module.

org.apache.shale.dialog.scxml.action - package org.apache.shale.dialog.scxml.action

Custom Commons SCXML actions for the Shale dialogs domain.

org.apache.shale.dialog.scxml.config - package org.apache.shale.dialog.scxml.config

Classes that help in parsing the SCXML documents describing the Shale dialogs.

org.apache.shale.dialog.scxml.impl - package org.apache.shale.dialog.scxml.impl

Default implementations of interfaces in this module.

P

parse() - Method in class org.apache.shale.dialog.scxml.config.ConfigurationParser

Parse the configuration resource identified by the resource property, storing resulting information in the Map specified by the dialogs property.

POSTBACK_EVENT - Static variable in class org.apache.shale.dialog.scxml.Globals

The name of the postback event that the state machines should use to author transitions for, out of a "view" state.

POSTBACK_OUTCOME - Static variable in class org.apache.shale.dialog.scxml.Globals

The variable that holds the postback outcome in the root context of the state machine instance.

R

RedirectAction - Class in org.apache.shale.dialog.scxml.action

Custom Commons SCXML action to signal that the next rendered view in this dialog should use a redirect.

RedirectAction() - Constructor for class org.apache.shale.dialog.scxml.action.RedirectAction

remove(DialogContext) - Method in class org.apache.shale.dialog.scxml.SCXMLDialogManager

S

SCXMLDialogManager - Class in org.apache.shale.dialog.scxml

Implementation of DialogContextManager for integrating Commons SCXML into the Shale Dialog Manager.

SCXMLDialogManager() - Constructor for class org.apache.shale.dialog.scxml.SCXMLDialogManager

SCXMLLifecycleListener - Class in org.apache.shale.dialog.scxml

ServletContextListener that loads dialog configuration resources at application startup, and cleans up the libraries we depend on at application shutdown.

SCXMLLifecycleListener() - Constructor for class org.apache.shale.dialog.scxml.SCXMLLifecycleListener

setActionclassname(String) - Method in class org.apache.shale.dialog.scxml.config.DialogMetadata.SCXMLAction

Set the action class FQN.

setDataclassname(String) - Method in class org.apache.shale.dialog.scxml.config.DialogMetadata

Set the data class FQN.

setDialogs(Map) - Method in class org.apache.shale.dialog.scxml.config.ConfigurationParser

Set the Map of Dialog instances into which parsed information will be stored, keyed by dialog name.

setFacesContext(FacesContext) - Method in class org.apache.shale.dialog.scxml.ShaleDialogELEvaluator

Set per request context.

setName(String) - Method in class org.apache.shale.dialog.scxml.config.DialogMetadata.SCXMLAction

Set the action name.

setName(String) - Method in class org.apache.shale.dialog.scxml.config.DialogMetadata

Set the dialog name.

setNextRedirect(boolean) - Method in class org.apache.shale.dialog.scxml.DialogProperties

Set next view redirect property.

setNextViewId(String) - Method in class org.apache.shale.dialog.scxml.DialogProperties

Set the JSF view identifier of the next view to be rendered in this dialog.

setResource(URL) - Method in class org.apache.shale.dialog.scxml.config.ConfigurationParser

Set the URL of the configuration resource to be parsed.

setScxmlconfig(String) - Method in class org.apache.shale.dialog.scxml.config.DialogMetadata

Set the location where the SCXML document for this dialog resides.

setStateMachine(SCXML) - Method in class org.apache.shale.dialog.scxml.config.DialogMetadata

Set the Commons SCXML object model describing the state machine for this dialog.

setUri(String) - Method in class org.apache.shale.dialog.scxml.config.DialogMetadata.SCXMLAction

Set the action URI.

setValidating(boolean) - Method in class org.apache.shale.dialog.scxml.config.ConfigurationParser

Set a flag indicating whether we will be doing a validating parse or not.

setViewId(String) - Method in class org.apache.shale.dialog.scxml.action.ViewAction

Set the view identifier.

ShaleDialogELEvaluator - Class in org.apache.shale.dialog.scxml

EL evaluator, for evaluating the expressions in SCXML documents used to specify Shale dialogs.

ShaleDialogELEvaluator() - Constructor for class org.apache.shale.dialog.scxml.ShaleDialogELEvaluator

Constructor.

STATE_MAPPER - Static variable in class org.apache.shale.dialog.scxml.Globals

Application scope attribute under which the current DialogStateMapper implementation resides.

V

ViewAction - Class in org.apache.shale.dialog.scxml.action

Custom Commons SCXML action to set the JSF view identifier of the next view to be rendered by this dialog.

ViewAction() - Constructor for class org.apache.shale.dialog.scxml.action.ViewAction

A C D E G I M O P R S V