View Javadoc

1   /*
2    * $Id: StrutsConstants.java 789432 2009-06-29 20:15:24Z musachy $
3    *
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *  http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  package org.apache.struts2;
23  
24  import org.apache.struts2.dispatcher.mapper.CompositeActionMapper;
25  
26  /***
27   * This class provides a central location for framework configuration keys
28   * used to retrieve and store Struts configuration settings.
29   */
30  public final class StrutsConstants {
31  
32      /*** Whether Struts is in development mode or not */
33      public static final String STRUTS_DEVMODE = "struts.devMode";
34  
35      /*** Whether the localization messages should automatically be reloaded */
36      public static final String STRUTS_I18N_RELOAD = "struts.i18n.reload";
37  
38      /*** The encoding to use for localization messages */
39      public static final String STRUTS_I18N_ENCODING = "struts.i18n.encoding";
40  
41      /*** Whether to reload the XML configuration or not */
42      public static final String STRUTS_CONFIGURATION_XML_RELOAD = "struts.configuration.xml.reload";
43  
44      /*** The URL extension to use to determine if the request is meant for a Struts action */
45      public static final String STRUTS_ACTION_EXTENSION = "struts.action.extension";
46  
47  	/*** Comma separated list of patterns (java.util.regex.Pattern) to be excluded from Struts2-processing */
48  	public static final String STRUTS_ACTION_EXCLUDE_PATTERN = "struts.action.excludePattern";
49  
50      /*** Whether to use the alterative syntax for the tags or not */
51      public static final String STRUTS_TAG_ALTSYNTAX = "struts.tag.altSyntax";
52  
53      /*** The HTTP port used by Struts URLs */
54      public static final String STRUTS_URL_HTTP_PORT = "struts.url.http.port";
55  
56      /*** The HTTPS port used by Struts URLs */
57      public static final String STRUTS_URL_HTTPS_PORT = "struts.url.https.port";
58  
59      /*** The default includeParams method to generate Struts URLs */
60      public static final String STRUTS_URL_INCLUDEPARAMS = "struts.url.includeParams";
61  
62  	public static final String STRUTS_URL_RENDERER = "struts.urlRenderer";
63  
64      /*** The com.opensymphony.xwork2.ObjectFactory implementation class */
65      public static final String STRUTS_OBJECTFACTORY = "struts.objectFactory";
66  
67      /*** The com.opensymphony.xwork2.util.ObjectTypeDeterminer implementation class */
68      public static final String STRUTS_OBJECTTYPEDETERMINER = "struts.objectTypeDeterminer";
69  
70      /*** The package containing actions that use Rife continuations */
71      public static final String STRUTS_CONTINUATIONS_PACKAGE = "struts.continuations.package";
72  
73      /*** The org.apache.struts2.config.Configuration implementation class */
74      public static final String STRUTS_CONFIGURATION = "struts.configuration";
75  
76      /*** The default locale for the Struts application */
77      public static final String STRUTS_LOCALE = "struts.locale";
78  
79      /*** Whether to use a Servlet request parameter workaround necessary for some versions of WebLogic */
80      public static final String STRUTS_DISPATCHER_PARAMETERSWORKAROUND = "struts.dispatcher.parametersWorkaround";
81  
82      /*** The org.apache.struts2.views.freemarker.FreemarkerManager implementation class */
83      public static final String STRUTS_FREEMARKER_MANAGER_CLASSNAME = "struts.freemarker.manager.classname";
84      
85      /*** Cache Freemarker templates */
86      public static final String STRUTS_FREEMARKER_TEMPLATES_CACHE = "struts.freemarker.templatesCache";
87      
88      /*** Cache model instances at BeanWrapper level */
89      public static final String STRUTS_FREEMARKER_BEANWRAPPER_CACHE = "struts.freemarker.beanwrapperCache";
90      
91      /*** Maximum strong sizing for MruCacheStorage for freemarker */
92      public static final String STRUTS_FREEMARKER_MRU_MAX_STRONG_SIZE = "struts.freemarker.mru.max.strong.size";
93      
94      /*** org.apache.struts2.views.velocity.VelocityManager implementation class */
95      public static final String STRUTS_VELOCITY_MANAGER_CLASSNAME = "struts.velocity.manager.classname";
96  
97      /*** The Velocity configuration file path */
98      public static final String STRUTS_VELOCITY_CONFIGFILE = "struts.velocity.configfile";
99  
100     /*** The location of the Velocity toolbox */
101     public static final String STRUTS_VELOCITY_TOOLBOXLOCATION = "struts.velocity.toolboxlocation";
102 
103     /*** List of Velocity context names */
104     public static final String STRUTS_VELOCITY_CONTEXTS = "struts.velocity.contexts";
105 
106     /*** The directory containing UI templates.  All templates must reside in this directory. */
107     public static final String STRUTS_UI_TEMPLATEDIR = "struts.ui.templateDir";
108 
109     /*** The default UI template theme */
110     public static final String STRUTS_UI_THEME = "struts.ui.theme";
111 
112     /*** The maximize size of a multipart request (file upload) */
113     public static final String STRUTS_MULTIPART_MAXSIZE = "struts.multipart.maxSize";
114 
115     /*** The directory to use for storing uploaded files */
116     public static final String STRUTS_MULTIPART_SAVEDIR = "struts.multipart.saveDir";
117 
118     /***
119      * The name of the bean that will handle multipart requests
120      */
121     public static final String STRUTS_MULTIPART_HANDLER = "struts.multipart.handler";
122 
123     /***
124      * The org.apache.struts2.dispatcher.multipart.MultiPartRequest parser implementation
125      * for a multipart request (file upload)
126      */
127     public static final String STRUTS_MULTIPART_PARSER = "struts.multipart.parser";
128 
129     /*** How Spring should autowire.  Valid values are 'name', 'type', 'auto', and 'constructor' */
130     public static final String STRUTS_OBJECTFACTORY_SPRING_AUTOWIRE = "struts.objectFactory.spring.autoWire";
131 
132     /*** Whether the autowire strategy chosen by STRUTS_OBJECTFACTORY_SPRING_AUTOWIRE is always respected.  Defaults
133      * to false, which is the legacy behavior that tries to determine the best strategy for the situation.
134      * @since 2.1.3
135      */
136     public static final String STRUTS_OBJECTFACTORY_SPRING_AUTOWIRE_ALWAYS_RESPECT = "struts.objectFactory.spring.autoWire.alwaysRespect";
137 
138     /*** Whether Spring should use its class cache or not */
139     public static final String STRUTS_OBJECTFACTORY_SPRING_USE_CLASS_CACHE = "struts.objectFactory.spring.useClassCache";
140 
141     /*** Whether or not XSLT templates should not be cached */
142     public static final String STRUTS_XSLT_NOCACHE = "struts.xslt.nocache";
143 
144     /*** Location of additional configuration properties files to load */
145     public static final String STRUTS_CUSTOM_PROPERTIES = "struts.custom.properties";
146 
147     /*** Location of additional localization properties files to load */
148     public static final String STRUTS_CUSTOM_I18N_RESOURCES = "struts.custom.i18n.resources";
149 
150     /*** The org.apache.struts2.dispatcher.mapper.ActionMapper implementation class */
151     public static final String STRUTS_MAPPER_CLASS = "struts.mapper.class";
152 
153     /*** Whether the Struts filter should serve static content or not */
154     public static final String STRUTS_SERVE_STATIC_CONTENT = "struts.serve.static";
155 
156     /*** If static content served by the Struts filter should set browser caching header properties or not */
157     public static final String STRUTS_SERVE_STATIC_BROWSER_CACHE = "struts.serve.static.browserCache";
158 
159     /*** Allows one to disable dynamic method invocation from the URL */
160     public static final String STRUTS_ENABLE_DYNAMIC_METHOD_INVOCATION = "struts.enable.DynamicMethodInvocation";
161 
162     /*** Whether slashes in action names are allowed or not */
163     public static final String STRUTS_ENABLE_SLASHES_IN_ACTION_NAMES = "struts.enable.SlashesInActionNames";
164 
165     /*** Prefix used by {@link CompositeActionMapper} to identify its containing {@link org.apache.struts2.dispatcher.mapper.ActionMapper} class. */
166     public static final String STRUTS_MAPPER_COMPOSITE = "struts.mapper.composite";
167 
168     public static final String STRUTS_ACTIONPROXYFACTORY = "struts.actionProxyFactory";
169 
170     public static final String STRUTS_FREEMARKER_WRAPPER_ALT_MAP = "struts.freemarker.wrapper.altMap";
171 
172     /*** The name of the xwork converter implementation */
173     public static final String STRUTS_XWORKCONVERTER = "struts.xworkConverter";
174 
175     public static final String STRUTS_ALWAYS_SELECT_FULL_NAMESPACE = "struts.mapper.alwaysSelectFullNamespace";
176 
177     /*** XWork default text provider */
178     public static final String STRUTS_XWORKTEXTPROVIDER = "struts.xworkTextProvider";
179 
180     /*** The name of the parameter to create when mapping an id (used by some action mappers) */
181 	public static final String STRUTS_ID_PARAMETER_NAME = "struts.mapper.idParameterName";
182 	
183 	/*** The name of the parameter to determine whether static method access will be allowed in OGNL expressions or not */
184 	public static final String STRUTS_ALLOW_STATIC_METHOD_ACCESS = "struts.ognl.allowStaticMethodAccess";
185 
186 	/*** The com.opensymphony.xwork2.validator.ActionValidatorManager implementation class */
187     public static final String STRUTS_ACTIONVALIDATORMANAGER = "struts.actionValidatorManager";
188 
189     /*** The {@link com.opensymphony.xwork2.util.ValueStackFactory} implementation class */
190     public static final String STRUTS_VALUESTACKFACTORY = "struts.valueStackFactory";
191 
192     /*** The {@link com.opensymphony.xwork2.util.reflection.ReflectionProvider} implementation class */
193     public static final String STRUTS_REFLECTIONPROVIDER = "struts.reflectionProvider";
194 
195     /*** The {@link com.opensymphony.xwork2.util.reflection.ReflectionContextFactory} implementation class */
196     public static final String STRUTS_REFLECTIONCONTEXTFACTORY = "struts.reflectionContextFactory";
197     
198     /*** The {@link com.opensymphony.xwork2.util.PatternMatcher} implementation class */
199     public static final String STRUTS_PATTERNMATCHER = "struts.patternMatcher";
200 
201     /*** The {@link org.apache.struts2.dispatcher.StaticContentLoader} implementation class */
202     public static final String STRUTS_STATIC_CONTENT_LOADER = "struts.staticContentLoader";
203 
204     /*** The {@link com.opensymphony.xwork2.UnknownHandlerManager} implementation class */
205     public static final String STRUTS_UNKNOWN_HANDLER_MANAGER = "struts.unknownHandlerManager";
206 
207     /*** Throw RuntimeException when a property is not found, or the evaluation of the espression fails*/
208     public static final String STRUTS_EL_THROW_EXCEPTION = "struts.el.throwExceptionOnFailure";
209 
210     /*** Logs properties that are not found (very verbose) **/
211     public static final String STRUTS_LOG_MISSING_PROPERTIES = "struts.ognl.logMissingProperties";
212 
213     /*** Enables caching of parsed OGNL expressions **/
214     public static final String STRUTS_ENABLE_OGNL_EXPRESSION_CACHE = "struts.ognl.enableExpressionCache";
215 }