KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > struts > chain > Constants


1 /*
2  * Copyright 2003,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
17 package org.apache.struts.chain;
18
19
20 /**
21  * <p>Global constants for the Chain of Responsibility Library.</p>
22  */
23 public final class Constants {
24
25
26     // -------------------------------------------------- Context Attribute Keys
27
28
29     /**
30      * <p>The default context attribute under which the
31      * <code>Action</code> for the current request
32      * will be stored.</p>
33      */
34     public static final String JavaDoc ACTION_KEY = "action";
35
36
37     /**
38      * <p>The default context attribute under which the
39      * <code>ActionConfig</code> for the current request
40      * will be stored.</p>
41      */
42     public static final String JavaDoc ACTION_CONFIG_KEY = "actionConfig";
43
44
45     /**
46      * <p>The default context attribute under which the
47      * <code>ActionForm</code> for the current request
48      * will be stored.</p>
49      */
50     public static final String JavaDoc ACTION_FORM_KEY = "actionForm";
51
52
53     /**
54      * <p>The default context attribute under which the
55      * <code>ActionServet</code> for the current application
56      * will be stored.</p>
57      */
58     public static final String JavaDoc ACTION_SERVLET_KEY = "actionServlet";
59
60
61     /**
62      * <p>The default context attribute under which a
63      * boolean flag indicating whether this request has been
64      * cancelled will be stored.</p>
65      */
66     public static final String JavaDoc CANCEL_KEY = "cancel";
67
68
69     /**
70      * <p>The default context attribute under which an
71      * <code>Exception</code> will be stored before passing
72      * it to an exception handler chain.</p>
73      */
74     public static final String JavaDoc EXCEPTION_KEY = "exception";
75
76
77     /**
78      * <p>The default context attribute under which the
79      * <code>ForwardConfig</code> for the current request
80      * will be stored.</p>
81      */
82     public static final String JavaDoc FORWARD_CONFIG_KEY = "forwardConfig";
83     
84     /**
85      * <p>The default context attribute under which the
86      * include path for the current request
87      * will be stored.</p>
88      */
89     public static final String JavaDoc INCLUDE_KEY = "include";
90
91     /**
92      * <p>The default context attribute under which the
93      * <code>Locale</code> for the current request will be stored.</p>
94      */
95     public static final String JavaDoc LOCALE_KEY = "locale";
96
97
98     /**
99      * <p>The default context attribute under which the
100      * <code>MessageResources</code> for the current request
101      * will be stored.</p>
102      */
103     public static final String JavaDoc MESSAGE_RESOURCES_KEY = "messageResources";
104
105
106     /**
107      * <p>The default context attribute under which the
108      * <code>ModuleConfig</code> for the current request
109      * will be stored.</p>
110      */
111     public static final String JavaDoc MODULE_CONFIG_KEY = "moduleConfig";
112
113
114     /**
115      * <p>The default context attribute key under which a <code>Boolean</code>
116      * is stored, indicating the valid state of the current request. If not
117      * present, a value of <code>Boolean.FALSE</code> should be assumed.
118      */
119     public static final String JavaDoc VALID_KEY = "valid";
120
121
122     // --------------------------------------------------------- Other Constants
123
124
125     /**
126      * <p>The base part of the context attribute under which a Map containing
127      * the <code>Action</code> instances associated with this module are
128      * stored. This value must be suffixed with the module prefix in order
129      * to create a unique key per module.</p>
130      */
131     public static final String JavaDoc ACTIONS_KEY = "actions";
132
133
134     /**
135      * <p>The context attribute under which the <code>Catalog</code> containing
136      * our defined command chains has been stored.</p>
137      */
138     public static final String JavaDoc CATALOG_ATTR =
139         "org.apache.struts.chain.CATALOG";
140
141
142     /**
143      * <p>The request attribute under which the path information is stored for
144      * processing during a RequestDispatcher.include() call.</p>
145      */
146     public static final String JavaDoc INCLUDE_PATH_INFO =
147         "javax.servlet.include.path_info";
148
149
150     /**
151      * <p>The request attribute under which the servlet path is stored for
152      * processing during a RequestDispatcher.include() call.</p>
153      */
154     public static final String JavaDoc INCLUDE_SERVLET_PATH =
155         "javax.servlet.include.servlet_path";
156
157
158 }
159
Popular Tags