View Javadoc

1   /*
2    * $Id: StrutsConstants.java 540141 2007-05-21 13:46:48Z mrdon $
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  package org.apache.struts2;
22  
23  import org.apache.struts2.dispatcher.mapper.CompositeActionMapper;
24  
25  /***
26   * This class provides a central location for framework configuration keys
27   * used to retrieve and store Struts configuration settings.
28   */
29  public final class StrutsConstants {
30  
31      /*** Whether Struts is in development mode or not */
32      public static final String STRUTS_DEVMODE = "struts.devMode";
33  
34      /*** Whether the localization messages should automatically be reloaded */
35      public static final String STRUTS_I18N_RELOAD = "struts.i18n.reload";
36  
37      /*** The encoding to use for localization messages */
38      public static final String STRUTS_I18N_ENCODING = "struts.i18n.encoding";
39  
40      /*** Whether to reload the XML configuration or not */
41      public static final String STRUTS_CONFIGURATION_XML_RELOAD = "struts.configuration.xml.reload";
42  
43      /*** The URL extension to use to determine if the request is meant for a Struts action */
44      public static final String STRUTS_ACTION_EXTENSION = "struts.action.extension";
45  
46      /*** Whether to use the alterative syntax for the tags or not */
47      public static final String STRUTS_TAG_ALTSYNTAX = "struts.tag.altSyntax";
48  
49      /*** The HTTP port used by Struts URLs */
50      public static final String STRUTS_URL_HTTP_PORT = "struts.url.http.port";
51  
52      /*** The HTTPS port used by Struts URLs */
53      public static final String STRUTS_URL_HTTPS_PORT = "struts.url.https.port";
54  
55      /*** The default includeParams method to generate Struts URLs */
56      public static final String STRUTS_URL_INCLUDEPARAMS = "struts.url.includeParams";
57  
58      /*** The com.opensymphony.xwork2.ObjectFactory implementation class */
59      public static final String STRUTS_OBJECTFACTORY = "struts.objectFactory";
60  
61      /*** The com.opensymphony.xwork2.util.ObjectTypeDeterminer implementation class */
62      public static final String STRUTS_OBJECTTYPEDETERMINER = "struts.objectTypeDeterminer";
63  
64      /*** The package containing actions that use Rife continuations */
65      public static final String STRUTS_CONTINUATIONS_PACKAGE = "struts.continuations.package";
66  
67      /*** The org.apache.struts2.config.Configuration implementation class */
68      public static final String STRUTS_CONFIGURATION = "struts.configuration";
69  
70      /*** The default locale for the Struts application */
71      public static final String STRUTS_LOCALE = "struts.locale";
72  
73      /*** Whether to use a Servlet request parameter workaround necessary for some versions of WebLogic */
74      public static final String STRUTS_DISPATCHER_PARAMETERSWORKAROUND = "struts.dispatcher.parametersWorkaround";
75  
76      /*** The org.apache.struts2.views.freemarker.FreemarkerManager implementation class */
77      public static final String STRUTS_FREEMARKER_MANAGER_CLASSNAME = "struts.freemarker.manager.classname";
78  
79      /*** org.apache.struts2.views.velocity.VelocityManager implementation class */
80      public static final String STRUTS_VELOCITY_MANAGER_CLASSNAME = "struts.velocity.manager.classname";
81  
82      /*** The Velocity configuration file path */
83      public static final String STRUTS_VELOCITY_CONFIGFILE = "struts.velocity.configfile";
84  
85      /*** The location of the Velocity toolbox */
86      public static final String STRUTS_VELOCITY_TOOLBOXLOCATION = "struts.velocity.toolboxlocation";
87  
88      /*** List of Velocity context names */
89      public static final String STRUTS_VELOCITY_CONTEXTS = "struts.velocity.contexts";
90  
91      /*** The directory containing UI templates */
92      public static final String STRUTS_UI_TEMPLATEDIR = "struts.ui.templateDir";
93  
94      /*** The default UI template theme */
95      public static final String STRUTS_UI_THEME = "struts.ui.theme";
96  
97      /*** The maximize size of a multipart request (file upload) */
98      public static final String STRUTS_MULTIPART_MAXSIZE = "struts.multipart.maxSize";
99  
100     /*** The directory to use for storing uploaded files */
101     public static final String STRUTS_MULTIPART_SAVEDIR = "struts.multipart.saveDir";
102 
103     /***
104      * The org.apache.struts2.dispatcher.multipart.MultiPartRequest parser implementation
105      * for a multipart request (file upload)
106      */
107     public static final String STRUTS_MULTIPART_PARSER = "struts.multipart.parser";
108 
109     /*** Whether Spring should autoWire or not */
110     public static final String STRUTS_OBJECTFACTORY_SPRING_AUTOWIRE = "struts.objectFactory.spring.autoWire";
111 
112     /*** Whether Spring should use its class cache or not */
113     public static final String STRUTS_OBJECTFACTORY_SPRING_USE_CLASS_CACHE = "struts.objectFactory.spring.useClassCache";
114 
115     /*** Whether or not XSLT templates should not be cached */
116     public static final String STRUTS_XSLT_NOCACHE = "struts.xslt.nocache";
117 
118     /*** Location of additional configuration properties files to load */
119     public static final String STRUTS_CUSTOM_PROPERTIES = "struts.custom.properties";
120 
121     /*** Location of additional localization properties files to load */
122     public static final String STRUTS_CUSTOM_I18N_RESOURCES = "struts.custom.i18n.resources";
123 
124     /*** The org.apache.struts2.dispatcher.mapper.ActionMapper implementation class */
125     public static final String STRUTS_MAPPER_CLASS = "struts.mapper.class";
126 
127     /*** Whether the Struts filter should serve static content or not */
128     public static final String STRUTS_SERVE_STATIC_CONTENT = "struts.serve.static";
129 
130     /*** If static content served by the Struts filter should set browser caching header properties or not */
131     public static final String STRUTS_SERVE_STATIC_BROWSER_CACHE = "struts.serve.static.browserCache";
132 
133     /*** Allows one to disable dynamic method invocation from the URL */
134     public static final String STRUTS_ENABLE_DYNAMIC_METHOD_INVOCATION = "struts.enable.DynamicMethodInvocation";
135 
136     /*** Whether slashes in action names are allowed or not */
137     public static final String STRUTS_ENABLE_SLASHES_IN_ACTION_NAMES = "struts.enable.SlashesInActionNames";
138 
139     /*** Prefix used by {@link CompositeActionMapper} to identify its containing {@link org.apache.struts2.dispatcher.mapper.ActionMapper} class. */
140     public static final String STRUTS_MAPPER_COMPOSITE = "struts.mapper.composite";
141 
142     public static final String STRUTS_ACTIONPROXYFACTORY = "struts.actionProxyFactory";
143 
144     public static final String STRUTS_FREEMARKER_WRAPPER_ALT_MAP = "struts.freemarker.wrapper.altMap";
145 
146     /*** The name of the xwork converter implementation */
147     public static final String STRUTS_XWORKCONVERTER = "struts.xworkConverter";
148 
149     public static final String STRUTS_ALWAYS_SELECT_FULL_NAMESPACE = "struts.mapper.alwaysSelectFullNamespace";
150 
151     /*** XWork default text provider */
152     public static final String STRUTS_XWORKTEXTPROVIDER = "struts.xworkTextProvider";
153 
154     /*** The name of the parameter to create when mapping an id (used by some action mappers) */
155 	public static final String STRUTS_ID_PARAMETER_NAME = "struts.mapper.idParameterName";
156 
157 }