View Javadoc

1   /*
2    * $Id: StrutsConstants.java 651946 2008-04-27 13:41:38Z apetrelli $
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      /*** Whether to use the alterative syntax for the tags or not */
48      public static final String STRUTS_TAG_ALTSYNTAX = "struts.tag.altSyntax";
49  
50      /*** The HTTP port used by Struts URLs */
51      public static final String STRUTS_URL_HTTP_PORT = "struts.url.http.port";
52  
53      /*** The HTTPS port used by Struts URLs */
54      public static final String STRUTS_URL_HTTPS_PORT = "struts.url.https.port";
55  
56      /*** The default includeParams method to generate Struts URLs */
57      public static final String STRUTS_URL_INCLUDEPARAMS = "struts.url.includeParams";
58  
59  	public static final String STRUTS_URL_RENDERER = "struts.urlRenderer";
60  
61      /*** The com.opensymphony.xwork2.ObjectFactory implementation class */
62      public static final String STRUTS_OBJECTFACTORY = "struts.objectFactory";
63  
64      /*** The com.opensymphony.xwork2.util.ObjectTypeDeterminer implementation class */
65      public static final String STRUTS_OBJECTTYPEDETERMINER = "struts.objectTypeDeterminer";
66  
67      /*** The package containing actions that use Rife continuations */
68      public static final String STRUTS_CONTINUATIONS_PACKAGE = "struts.continuations.package";
69  
70      /*** The org.apache.struts2.config.Configuration implementation class */
71      public static final String STRUTS_CONFIGURATION = "struts.configuration";
72  
73      /*** The default locale for the Struts application */
74      public static final String STRUTS_LOCALE = "struts.locale";
75  
76      /*** Whether to use a Servlet request parameter workaround necessary for some versions of WebLogic */
77      public static final String STRUTS_DISPATCHER_PARAMETERSWORKAROUND = "struts.dispatcher.parametersWorkaround";
78  
79      /*** The org.apache.struts2.views.freemarker.FreemarkerManager implementation class */
80      public static final String STRUTS_FREEMARKER_MANAGER_CLASSNAME = "struts.freemarker.manager.classname";
81      
82      /*** Cache Freemarker templates */
83      public static final String STRUTS_FREEMARKER_TEMPLATES_CACHE = "struts.freemarker.templatesCache";
84      
85      /*** Cache model instances at BeanWrapper level */
86      public static final String STRUTS_FREEMARKER_BEANWRAPPER_CACHE = "struts.freemarker.beanwrapperCache";
87      
88      /*** Maximum strong sizing for MruCacheStorage for freemarker */
89      public static final String STRUTS_FREEMARKER_MRU_MAX_STRONG_SIZE = "struts.freemarker.mru.max.strong.size";
90      
91      /*** org.apache.struts2.views.velocity.VelocityManager implementation class */
92      public static final String STRUTS_VELOCITY_MANAGER_CLASSNAME = "struts.velocity.manager.classname";
93  
94      /*** The Velocity configuration file path */
95      public static final String STRUTS_VELOCITY_CONFIGFILE = "struts.velocity.configfile";
96  
97      /*** The location of the Velocity toolbox */
98      public static final String STRUTS_VELOCITY_TOOLBOXLOCATION = "struts.velocity.toolboxlocation";
99  
100     /*** List of Velocity context names */
101     public static final String STRUTS_VELOCITY_CONTEXTS = "struts.velocity.contexts";
102 
103     /*** The directory containing UI templates.  All templates must reside in this directory. */
104     public static final String STRUTS_UI_TEMPLATEDIR = "struts.ui.templateDir";
105 
106     /*** The default UI template theme */
107     public static final String STRUTS_UI_THEME = "struts.ui.theme";
108 
109     /*** The maximize size of a multipart request (file upload) */
110     public static final String STRUTS_MULTIPART_MAXSIZE = "struts.multipart.maxSize";
111 
112     /*** The directory to use for storing uploaded files */
113     public static final String STRUTS_MULTIPART_SAVEDIR = "struts.multipart.saveDir";
114 
115     /***
116      * The org.apache.struts2.dispatcher.multipart.MultiPartRequest parser implementation
117      * for a multipart request (file upload)
118      */
119     public static final String STRUTS_MULTIPART_PARSER = "struts.multipart.parser";
120 
121     /*** Whether Spring should autoWire or not */
122     public static final String STRUTS_OBJECTFACTORY_SPRING_AUTOWIRE = "struts.objectFactory.spring.autoWire";
123 
124     /*** Whether Spring should use its class cache or not */
125     public static final String STRUTS_OBJECTFACTORY_SPRING_USE_CLASS_CACHE = "struts.objectFactory.spring.useClassCache";
126 
127     /*** Whether or not XSLT templates should not be cached */
128     public static final String STRUTS_XSLT_NOCACHE = "struts.xslt.nocache";
129 
130     /*** Location of additional configuration properties files to load */
131     public static final String STRUTS_CUSTOM_PROPERTIES = "struts.custom.properties";
132 
133     /*** Location of additional localization properties files to load */
134     public static final String STRUTS_CUSTOM_I18N_RESOURCES = "struts.custom.i18n.resources";
135 
136     /*** The org.apache.struts2.dispatcher.mapper.ActionMapper implementation class */
137     public static final String STRUTS_MAPPER_CLASS = "struts.mapper.class";
138 
139     /*** Whether the Struts filter should serve static content or not */
140     public static final String STRUTS_SERVE_STATIC_CONTENT = "struts.serve.static";
141 
142     /*** If static content served by the Struts filter should set browser caching header properties or not */
143     public static final String STRUTS_SERVE_STATIC_BROWSER_CACHE = "struts.serve.static.browserCache";
144 
145     /*** Allows one to disable dynamic method invocation from the URL */
146     public static final String STRUTS_ENABLE_DYNAMIC_METHOD_INVOCATION = "struts.enable.DynamicMethodInvocation";
147 
148     /*** Whether slashes in action names are allowed or not */
149     public static final String STRUTS_ENABLE_SLASHES_IN_ACTION_NAMES = "struts.enable.SlashesInActionNames";
150 
151     /*** Prefix used by {@link CompositeActionMapper} to identify its containing {@link org.apache.struts2.dispatcher.mapper.ActionMapper} class. */
152     public static final String STRUTS_MAPPER_COMPOSITE = "struts.mapper.composite";
153 
154     public static final String STRUTS_ACTIONPROXYFACTORY = "struts.actionProxyFactory";
155 
156     public static final String STRUTS_FREEMARKER_WRAPPER_ALT_MAP = "struts.freemarker.wrapper.altMap";
157 
158     /*** The name of the xwork converter implementation */
159     public static final String STRUTS_XWORKCONVERTER = "struts.xworkConverter";
160 
161     public static final String STRUTS_ALWAYS_SELECT_FULL_NAMESPACE = "struts.mapper.alwaysSelectFullNamespace";
162 
163     /*** XWork default text provider */
164     public static final String STRUTS_XWORKTEXTPROVIDER = "struts.xworkTextProvider";
165 
166     /*** The name of the parameter to create when mapping an id (used by some action mappers) */
167 	public static final String STRUTS_ID_PARAMETER_NAME = "struts.mapper.idParameterName";
168 	
169 	/*** The name of the parameter to determine whether static method access will be allowed in OGNL expressions or not */
170 	public static final String STRUTS_ALLOW_STATIC_METHOD_ACCESS = "struts.ognl.allowStaticMethodAccess";
171 
172 	/*** The com.opensymphony.xwork2.validator.ActionValidatorManager implementation class */
173     public static final String STRUTS_ACTIONVALIDATORMANAGER = "struts.actionValidatorManager";
174 
175     /*** The {@link com.opensymphony.xwork2.util.ValueStackFactory} implementation class */
176     public static final String STRUTS_VALUESTACKFACTORY = "struts.valueStackFactory";
177 
178     /*** The {@link com.opensymphony.xwork2.util.reflection.ReflectionProvider} implementation class */
179     public static final String STRUTS_REFLECTIONPROVIDER = "struts.reflectionProvider";
180 
181     /*** The {@link com.opensymphony.xwork2.util.reflection.ReflectionContextFactory} implementation class */
182     public static final String STRUTS_REFLECTIONCONTEXTFACTORY = "struts.reflectionContextFactory";
183     
184     /*** The {@link com.opensymphony.xwork2.util.PatternMatcher} implementation class */
185     public static final String STRUTS_PATTERNMATCHER = "struts.patternMatcher";
186 
187 }