PageFlowConstants


1   /*
2    * Copyright 2004 The Apache Software Foundation.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   *
16   * $Header:$
17   */
18  package org.apache.beehive.netui.pageflow;
19  
20  import org.apache.beehive.netui.pageflow.internal.InternalConstants;
21  
22  /**
23   * Constants related to Page Flow.
24   */ 
25  public interface PageFlowConstants
26  {
27      /**
28       * The name of the special action in a user-defined {@link PageFlowController} (.jpf) that is
29       * processed when the URI for the .jpf is accessed.
30       */ 
31      public static final String   BEGIN_ACTION_NAME = "begin";
32      
33      /**
34       * The extension used for hitting a {@link PageFlowController} through its URI.
35       */ 
36      public static final String   PAGEFLOW_EXTENSION = ".jpf";
37      
38      /**
39       * The extension used for hitting a {@link PageFlowController} through its URI.
40       * @deprecated Use {@link #PAGEFLOW_EXTENSION} instead.
41       */ 
42      public static final String   JPF_EXTENSION = PAGEFLOW_EXTENSION;
43      
44      /**
45       * The extension for Struts action URIs used with page flows.
46       */ 
47      public static final String   ACTION_EXTENSION = ".do";
48      
49      /**
50       * The name of the {@link GlobalApp} class defined by the user for a web application.
51       * 
52       * @deprecated This constant will be removed with no replacement.
53       */ 
54      public static final String   GLOBALAPP_CLASSNAME = "global.Global";
55      
56      /**
57       * The name of the source file for the {@link GlobalApp} class defined by the user for a
58       * web application.
59       * 
60       * @deprecated This constant will be removed with no replacement.
61       */ 
62      public static final String   GLOBALAPP_SOURCEFILE_NAME = "Global.app";
63      
64      /**
65       * The filename prefix for Struts module configuration files generated from page flow source files.
66       */ 
67      public static final String   PAGEFLOW_MODULE_CONFIG_PREFIX = "jpf-struts-config";
68      
69      /**
70       * The filename prefix for Struts module configuration files generated from page flow source files.
71       * @deprecated Use {@link #PAGEFLOW_MODULE_CONFIG_PREFIX} instead.
72       */ 
73      public static final String   JPF_MODULE_CONFIG_PREFIX = PAGEFLOW_MODULE_CONFIG_PREFIX;
74  
75      /**
76       * The file extensioni for Struts configuration files generated by the Page Flow compiler.
77       */ 
78      public static final String   PAGEFLOW_MODULE_CONFIG_EXTENSION = ".xml";
79      
80      /**
81       * The file extensioni for Struts configuration files generated by the Page Flow compiler.
82       * @deprecated Use {@link #PAGEFLOW_MODULE_CONFIG_EXTENSION} instead.
83       */ 
84      public static final String   JPF_MODULE_CONFIG_EXTENSION = PAGEFLOW_MODULE_CONFIG_EXTENSION;
85  
86      /**
87       * The prefix for a button or imageButton that has an action.
88       * @deprecated This is an internal constant that will be removed without replacement.
89       */
90      public static final String   ACTION_OVERRIDE = InternalConstants.ACTION_OVERRIDE_PREFIX;
91  
92      /**
93       * Servlet context-param that configures the maximum number of consecutive server forwards before error.
94       * 
95       * @deprecated Instead of this context-param, use the <code>max-forwards-per-request</code> element within
96       *             <code>pageflow-config</code> in /WEB-INF/netui-config.xml.
97       */ 
98      public static final String   FORWARD_OVERFLOW_COUNT_PARAM = "jpf-forward-overflow-count";
99      
100     /**
101      * Servlet context-param that configures the maximum depth of the Page Flow nesting stack.
102      * 
103      * @deprecated Instead of this context-param, use the <code>max-nesting-stack-depth</code> element within
104      *             <code>pageflow-config</code> in /WEB-INF/netui-config.xml.
105      */ 
106     public static final String   NESTING_OVERFLOW_COUNT_PARAM = "jpf-nesting-overflow-count";
107     
108     /**
109      * Default value for the maximum number of consecutive server forwards before error.
110      * 
111      * @deprecated This constant will be removed without replacement in a future release.  The value is read from
112      *     netui-config.xsd (the schema for netui-config.xml).
113      */ 
114     public static final int DEFAULT_FORWARD_OVERFLOW_COUNT = 50;
115     
116     /**
117      * Default value for the maximum depth of the Page Flow nesting stack.
118      * 
119      * @deprecated This constant will be removed without replacement in a future release.  The value is read from
120      *     netui-config.xsd (the schema for netui-config.xml).
121      */ 
122     public static final int DEFAULT_NESTING_OVERFLOW_COUNT = 25;
123 
124      
125     /**
126      * Servlet context-param that configures whether to apply security constraints on server forwards to page
127      * flow actions.  Normally, security constraints are not applied on server forwards.
128      * 
129      * @deprecated Instead of this context-param, use the <code>ensure-secure-forwards</code> element within
130      *             <code>pageflow-config</code> in /WEB-INF/netui-config.xml.
131      */ 
132     public static final String   SECURE_FORWARDS_PARAM = "jpf-secure-forwards";
133     
134     /**
135      * The default webapp-relative directory for Struts module configuration files generated by the Page Flow compiler.
136      */ 
137     public static final String   PAGEFLOW_MODULE_CONFIG_GEN_DIR = InternalConstants.WEBINF_DIR + "/.pageflow-struts-generated";
138     
139     /**
140      * The default webapp-relative directory for Struts module configuration files generated by the Page Flow compiler.
141      * @deprecated Use {@link #PAGEFLOW_MODULE_CONFIG_GEN_DIR} instead.
142      */ 
143     public static final String   JPF_MODULE_CONFIG_GEN_DIR = PAGEFLOW_MODULE_CONFIG_GEN_DIR;
144     
145     /**
146      * The name of an automatically-generated Forward that can be used from <i>any</i> Page Flow action, in situations
147      * where the framework can handle the response itself.  Currently, this happens when a nested page flow returns
148      * after being shown in a popup window.  In the calling page flow, the handler for the return action would return
149      * something like <code>new Forward("_auto")</code>, and the framework would write out the correct javascript to
150      * close the popup window.
151      */ 
152     public static final String   AUTO_VIEW_RENDER_FORWARD_NAME = "_auto";
153 }
154
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Free Books Free Magazines
Popular Tags