org.apache.beehive.netui.pageflow
Interface PageFlowConstants

All Known Implementing Classes:
FlowController, GlobalApp, PageFlowController, PageFlowRequestProcessor, PageFlowUtils, SharedFlowController

public interface PageFlowConstants

Constants related to Page Flow.


Field Summary
static String ACTION_EXTENSION
          The extension for Struts action URIs used with page flows.
static String ACTION_OVERRIDE
          Deprecated. This is an internal constant that will be removed without replacement.
static String AUTO_VIEW_RENDER_FORWARD_NAME
          The name of an automatically-generated Forward that can be used from any Page Flow action, in situations where a framework servlet can handle the response itself.
static String BEGIN_ACTION_NAME
          The name of the special action in a user-defined PageFlowController (.jpf) that is processed when the URI for the .jpf is accessed.
static int DEFAULT_FORWARD_OVERFLOW_COUNT
          Deprecated. This constant will be removed without replacement in a future release. The value is read from netui-config.xsd (the schema for netui-config.xml).
static int DEFAULT_NESTING_OVERFLOW_COUNT
          Deprecated. This constant will be removed without replacement in a future release. The value is read from netui-config.xsd (the schema for netui-config.xml).
static String DEFAULT_VIEW_RENDERING_EXTENSION
          The default value of the extension used in the servlet path of the URI for a Forward to the framework servlet rendering the response.
static String FORWARD_OVERFLOW_COUNT_PARAM
          Deprecated. Instead of this context-param, use the max-forwards-per-request element within pageflow-config in /WEB-INF/netui-config.xml.
static String GLOBALAPP_CLASSNAME
          Deprecated. This constant will be removed with no replacement.
static String GLOBALAPP_SOURCEFILE_NAME
          Deprecated. This constant will be removed with no replacement.
static String JPF_EXTENSION
          Deprecated. Use PAGEFLOW_EXTENSION instead.
static String JPF_MODULE_CONFIG_EXTENSION
          Deprecated. Use PAGEFLOW_MODULE_CONFIG_EXTENSION instead.
static String JPF_MODULE_CONFIG_GEN_DIR
          Deprecated. Use PAGEFLOW_MODULE_CONFIG_GEN_DIR instead.
static String JPF_MODULE_CONFIG_PREFIX
          Deprecated. Use PAGEFLOW_MODULE_CONFIG_PREFIX instead.
static String NESTING_OVERFLOW_COUNT_PARAM
          Deprecated. Instead of this context-param, use the max-nesting-stack-depth element within pageflow-config in /WEB-INF/netui-config.xml.
static String PAGEFLOW_EXTENSION
          The extension used for hitting a PageFlowController through its URI.
static String PAGEFLOW_MODULE_CONFIG_EXTENSION
          The file extensioni for Struts configuration files generated by the Page Flow compiler.
static String PAGEFLOW_MODULE_CONFIG_GEN_DIR
          The default classloader-relative directory for Struts module configuration files generated by the Page Flow compiler.
static String PAGEFLOW_MODULE_CONFIG_PREFIX
          The filename prefix for Struts module configuration files generated from page flow source files.
static String SECURE_FORWARDS_PARAM
          Deprecated. Instead of this context-param, use the ensure-secure-forwards element within pageflow-config in /WEB-INF/beehive-netui-config.xml.
static String VIEW_RENDERER_ATTRIBUTE_NAME
          The request attribute name for the view renderer object used by a framework servlet to render the response.
static String VIEW_RENDERER_URI_COMMAND
          A string used in the path of the URI that identifies the command for the framework servlet to render a ViewRenderer (an attribute on the request) in the response.
static String VIEW_RENDERING_EXTENSION_PARAM
          The <param-name> of a web-app <context-param> used to configure the extension used in the servlet path of the URI for a Forward to the framework servlet rendering the response.
 

Field Detail

BEGIN_ACTION_NAME

static final String BEGIN_ACTION_NAME
The name of the special action in a user-defined PageFlowController (.jpf) that is processed when the URI for the .jpf is accessed.

See Also:
Constant Field Values

PAGEFLOW_EXTENSION

static final String PAGEFLOW_EXTENSION
The extension used for hitting a PageFlowController through its URI.

See Also:
Constant Field Values

JPF_EXTENSION

static final String JPF_EXTENSION
Deprecated. Use PAGEFLOW_EXTENSION instead.
The extension used for hitting a PageFlowController through its URI.

See Also:
Constant Field Values

ACTION_EXTENSION

static final String ACTION_EXTENSION
The extension for Struts action URIs used with page flows.

See Also:
Constant Field Values

GLOBALAPP_CLASSNAME

static final String GLOBALAPP_CLASSNAME
Deprecated. This constant will be removed with no replacement.
The name of the GlobalApp class defined by the user for a web application.

See Also:
Constant Field Values

GLOBALAPP_SOURCEFILE_NAME

static final String GLOBALAPP_SOURCEFILE_NAME
Deprecated. This constant will be removed with no replacement.
The name of the source file for the GlobalApp class defined by the user for a web application.

See Also:
Constant Field Values

PAGEFLOW_MODULE_CONFIG_PREFIX

static final String PAGEFLOW_MODULE_CONFIG_PREFIX
The filename prefix for Struts module configuration files generated from page flow source files.

See Also:
Constant Field Values

JPF_MODULE_CONFIG_PREFIX

static final String JPF_MODULE_CONFIG_PREFIX
Deprecated. Use PAGEFLOW_MODULE_CONFIG_PREFIX instead.
The filename prefix for Struts module configuration files generated from page flow source files.

See Also:
Constant Field Values

PAGEFLOW_MODULE_CONFIG_EXTENSION

static final String PAGEFLOW_MODULE_CONFIG_EXTENSION
The file extensioni for Struts configuration files generated by the Page Flow compiler.

See Also:
Constant Field Values

JPF_MODULE_CONFIG_EXTENSION

static final String JPF_MODULE_CONFIG_EXTENSION
Deprecated. Use PAGEFLOW_MODULE_CONFIG_EXTENSION instead.
The file extensioni for Struts configuration files generated by the Page Flow compiler.

See Also:
Constant Field Values

ACTION_OVERRIDE

static final String ACTION_OVERRIDE
Deprecated. This is an internal constant that will be removed without replacement.
The prefix for a button or imageButton that has an action.

See Also:
Constant Field Values

FORWARD_OVERFLOW_COUNT_PARAM

static final String FORWARD_OVERFLOW_COUNT_PARAM
Deprecated. Instead of this context-param, use the max-forwards-per-request element within pageflow-config in /WEB-INF/netui-config.xml.
Servlet context-param that configures the maximum number of consecutive server forwards before error.

See Also:
Constant Field Values

NESTING_OVERFLOW_COUNT_PARAM

static final String NESTING_OVERFLOW_COUNT_PARAM
Deprecated. Instead of this context-param, use the max-nesting-stack-depth element within pageflow-config in /WEB-INF/netui-config.xml.
Servlet context-param that configures the maximum depth of the Page Flow nesting stack.

See Also:
Constant Field Values

DEFAULT_FORWARD_OVERFLOW_COUNT

static final int DEFAULT_FORWARD_OVERFLOW_COUNT
Deprecated. This constant will be removed without replacement in a future release. The value is read from netui-config.xsd (the schema for netui-config.xml).
Default value for the maximum number of consecutive server forwards before error.

See Also:
Constant Field Values

DEFAULT_NESTING_OVERFLOW_COUNT

static final int DEFAULT_NESTING_OVERFLOW_COUNT
Deprecated. This constant will be removed without replacement in a future release. The value is read from netui-config.xsd (the schema for netui-config.xml).
Default value for the maximum depth of the Page Flow nesting stack.

See Also:
Constant Field Values

SECURE_FORWARDS_PARAM

static final String SECURE_FORWARDS_PARAM
Deprecated. Instead of this context-param, use the ensure-secure-forwards element within pageflow-config in /WEB-INF/beehive-netui-config.xml.
Servlet context-param that configures whether to apply security constraints on server forwards to page flow actions. Normally, security constraints are not applied on server forwards.

See Also:
Constant Field Values

PAGEFLOW_MODULE_CONFIG_GEN_DIR

static final String PAGEFLOW_MODULE_CONFIG_GEN_DIR
The default classloader-relative directory for Struts module configuration files generated by the Page Flow compiler.

See Also:
Constant Field Values

JPF_MODULE_CONFIG_GEN_DIR

static final String JPF_MODULE_CONFIG_GEN_DIR
Deprecated. Use PAGEFLOW_MODULE_CONFIG_GEN_DIR instead.
The default webapp-relative directory for Struts module configuration files generated by the Page Flow compiler.

See Also:
Constant Field Values

AUTO_VIEW_RENDER_FORWARD_NAME

static final String AUTO_VIEW_RENDER_FORWARD_NAME
The name of an automatically-generated Forward that can be used from any Page Flow action, in situations where a framework servlet can handle the response itself. Currently, this happens when a nested page flow returns after being shown in a popup window. In the calling page flow, the handler for the return action would return something like new Forward("_auto"), and the framework would write out the correct javascript to close the popup window.

See Also:
Constant Field Values

DEFAULT_VIEW_RENDERING_EXTENSION

static final String DEFAULT_VIEW_RENDERING_EXTENSION
The default value of the extension used in the servlet path of the URI for a Forward to the framework servlet rendering the response. (See AUTO_VIEW_RENDER_FORWARD_NAME) The extension is part of the <url-pattern> used to map a NetUI ViewRenderer Forward to the Servlet handling the rendering.

See Also:
Constant Field Values

VIEW_RENDERING_EXTENSION_PARAM

static final String VIEW_RENDERING_EXTENSION_PARAM
The <param-name> of a web-app <context-param> used to configure the extension used in the servlet path of the URI for a Forward to the framework servlet rendering the response. (See AUTO_VIEW_RENDER_FORWARD_NAME) The value for the extension should match the extension in the <url-pattern> used to map a NetUI ViewRenderer Forward to the Servlet handling the rendering. Setting the associated <param-value> overrides the default value of the "render" extension in the servlet-mapping, <url-pattern>*.render</url-pattern>.

See Also:
Constant Field Values

VIEW_RENDERER_ATTRIBUTE_NAME

static final String VIEW_RENDERER_ATTRIBUTE_NAME
The request attribute name for the view renderer object used by a framework servlet to render the response.

See Also:
Constant Field Values

VIEW_RENDERER_URI_COMMAND

static final String VIEW_RENDERER_URI_COMMAND
A string used in the path of the URI that identifies the command for the framework servlet to render a ViewRenderer (an attribute on the request) in the response.

See Also:
Constant Field Values