001// Licensed under the Apache License, Version 2.0 (the "License"); 002// you may not use this file except in compliance with the License. 003// You may obtain a copy of the License at 004// 005// http://www.apache.org/licenses/LICENSE-2.0 006// 007// Unless required by applicable law or agreed to in writing, software 008// distributed under the License is distributed on an "AS IS" BASIS, 009// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 010// See the License for the specific language governing permissions and 011// limitations under the License. 012 013package org.apache.tapestry5; 014 015import org.apache.tapestry5.corelib.base.AbstractField; 016import org.apache.tapestry5.corelib.components.AjaxFormLoop; 017import org.apache.tapestry5.corelib.components.BeanDisplay; 018import org.apache.tapestry5.corelib.components.BeanEditForm; 019import org.apache.tapestry5.corelib.components.BeanEditor; 020import org.apache.tapestry5.corelib.components.Errors; 021import org.apache.tapestry5.corelib.mixins.FormGroup; 022import org.apache.tapestry5.http.TapestryHttpConstants; 023import org.apache.tapestry5.http.TapestryHttpSymbolConstants; 024import org.apache.tapestry5.http.services.BaseURLSource; 025import org.apache.tapestry5.http.services.CorsHandler; 026import org.apache.tapestry5.http.services.CorsHandlerHelper; 027import org.apache.tapestry5.http.services.CorsHttpServletRequestFilter; 028import org.apache.tapestry5.internal.services.AssetDispatcher; 029import org.apache.tapestry5.internal.services.rest.DefaultOpenApiDescriptionGenerator; 030import org.apache.tapestry5.modules.NoBootstrapModule; 031import org.apache.tapestry5.services.Html5Support; 032import org.apache.tapestry5.services.assets.AssetPathConstructor; 033import org.apache.tapestry5.services.assets.ResourceMinimizer; 034import org.apache.tapestry5.services.compatibility.Trait; 035import org.apache.tapestry5.services.javascript.JavaScriptStack; 036import org.apache.tapestry5.services.rest.OpenApiDescriptionGenerator; 037 038/** 039 * Defines the names of symbols used to configure Tapestry. 040 * 041 * @see org.apache.tapestry5.ioc.services.SymbolSource 042 */ 043public class SymbolConstants 044{ 045 /** 046 * A comma separated list of execution modes used to control how the application is initialized. 047 * Each modes can contribute a list (comma separated) of Module classes to be loaded during startup, 048 * the order in which they appear is preserved. 049 * The default value is: <code>production</code>. 050 * This is an alias for {@link TapestryHttpSymbolConstants#EXECUTION_MODE}. 051 */ 052 public static final String EXECUTION_MODE = TapestryHttpSymbolConstants.EXECUTION_MODE; 053 /** 054 * Indicates whether Tapestry is running in production mode or developer mode. This affects a large 055 * number of Tapestry behaviors related to performance and security, including how exceptions are 056 * reported, whether far-future expire headers are emitted, whether JavaScript files may be combined, 057 * whether JSON is compressed, whether component field and parameter values are shadowed to instance 058 * variables (to assist with debugging), and more. 059 * 060 * This is an alias to {@link TapestryHttpSymbolConstants#PRODUCTION_MODE}. 061 */ 062 public static final String PRODUCTION_MODE = TapestryHttpSymbolConstants.PRODUCTION_MODE; 063 064 /** 065 * A version of {@link TapestryHttpSymbolConstants#PRODUCTION_MODE} as a symbol reference. This can be used as the default value 066 * of other symbols, to indicate that their default matches whatever PRODUCTION_MODE is set to, which is quite 067 * common. 068 * 069 * @since 5.2.0 070 */ 071 public static final String PRODUCTION_MODE_VALUE = String.format("${%s}", TapestryHttpSymbolConstants.PRODUCTION_MODE); 072 073 /** 074 * The list of locales supported by the application; locales identified in the incoming request are "narrowed" to 075 * one of these values. The first locale name in the list is the default locale used when no proper match can be 076 * found. 077 */ 078 public static final String SUPPORTED_LOCALES = "tapestry.supported-locales"; 079 080 /** 081 * Controls whether whitespace is compressed by default in templates, or left as is. The factory default is to 082 * compress whitespace. (This can also be overridden using the xml:space attribute inside template elements.) 083 */ 084 public static final String COMPRESS_WHITESPACE = "tapestry.compress-whitespace"; 085 086 /** 087 * Time interval defining how often Tapestry will check for updates to local files (including classes). 088 * Starting with 5.3, this is only used when not running in production mode. The default is "1 s" 089 * (one second), which is appropriate for development. With Tapestry 5.2 and earlier this number 090 * should be raised in a production environment. 091 */ 092 public static final String FILE_CHECK_INTERVAL = "tapestry.file-check-interval"; 093 094 /** 095 * Time interval that sets how long Tapestry will wait to obtain the exclusive lock needed to check local files. The 096 * default is "50 ms". Starting with 5.3, this is only used when not running in production mode. 097 */ 098 public static final String FILE_CHECK_UPDATE_TIMEOUT = "tapestry.file-check-update-timeout"; 099 100 /** 101 * The version number of the core Tapestry framework, or UNKNOWN if the version number is not available (which 102 * should only occur when developing Tapestry). 103 * This is an alias for {@link TapestryHttpSymbolConstants#TAPESTRY_VERSION}. 104 */ 105 public static final String TAPESTRY_VERSION = TapestryHttpSymbolConstants.TAPESTRY_VERSION; 106 107 /** 108 * The location of the application-wide component messages catalog, relative to the web application context. This 109 * will normally be <code>WEB-INF/app.properties</code>. 110 */ 111 public static final String APPLICATION_CATALOG = "tapestry.app-catalog"; 112 113 /** 114 * The charset used when rendering page markup; the charset is also used as the request encoding when handling 115 * incoming requests. The default is "UTF-8". 116 * This is an alias for {@link TapestryHttpSymbolConstants#CHARSET}. 117 */ 118 public static final String CHARSET = TapestryHttpSymbolConstants.CHARSET; 119 120 /** 121 * Used as the default for the Form's autofocus and clientValidation parameters. If overridden to "false", then 122 * Forms will not (unless explicitly specified) use client validation or autofocus, which in turn, means that most 123 * pages with Forms will not make use of the Tapestry JavaScript stack. 124 */ 125 public static final String FORM_CLIENT_LOGIC_ENABLED = "tapestry.form-client-logic-enabled"; 126 127 /** 128 * Name of page used to report exceptions; the page must implement 129 * {@link org.apache.tapestry5.services.ExceptionReporter}. 130 * This is used by the default exception report handler service. 131 */ 132 public static final String EXCEPTION_REPORT_PAGE = "tapestry.exception-report-page"; 133 134 /** 135 * Identifies the default persistence strategy for all pages that do not provide an override (using this value as 136 * {@link org.apache.tapestry5.annotations.Meta key}). 137 * 138 * @since 5.1.0.0 139 */ 140 public static final String PERSISTENCE_STRATEGY = "tapestry.persistence-strategy"; 141 142 /** 143 * Minimum output stream size, in bytes, before output is compressed using GZIP. Shorter streams are not compressed. 144 * Tapestry buffers this amount and switches to a GZIP output stream as needed. The default is "100". 145 * This is an alias to {@link TapestryHttpSymbolConstants#MIN_GZIP_SIZE}. 146 * 147 * @see TapestryHttpSymbolConstants#GZIP_COMPRESSION_ENABLED 148 * @since 5.1.0.0 149 */ 150 public static final String MIN_GZIP_SIZE = TapestryHttpSymbolConstants.MIN_GZIP_SIZE; 151 152 /** 153 * Version number of the application. Prior to 5.4, this version number was integrated into asset URLs. Starting 154 * with 5.4, a checksum of the individual asset's content is used instead, and this version number is only used 155 * for documentation purposes; it appears in the default exception report page, for example. 156 * 157 * The default value is "0.0.1". In 5.3 and earlier, the default value was a random hexadecimal string. 158 * 159 * This is an alias to {@link TapestryHttpSymbolConstants#APPLICATION_VERSION}. 160 * 161 * @see AssetDispatcher 162 * @see AssetPathConstructor 163 * @since 5.1.0.0 164 */ 165 public static final String APPLICATION_VERSION = TapestryHttpSymbolConstants.APPLICATION_VERSION; 166 167 /** 168 * Used to omit the normal Tapestry framework generator meta tag. The meta tag is rendered by default, but clients 169 * who do not wish to advertise their use of Tapestry may set this symbol to "true". 170 * 171 * @since 5.1.0.0 172 */ 173 public static final String OMIT_GENERATOR_META = "tapestry.omit-generator-meta"; 174 175 /** 176 * If "true" (the default) then GZip compression is enabled for dynamic requests and for static assets. If you are 177 * using a server that handles GZip compression for you, or you don't want to use the extra processing power 178 * necessary to GZIP requests, then override this to "false". 179 * This is an alias to {@link TapestryHttpSymbolConstants#GZIP_COMPRESSION_ENABLED}. 180 * 181 * @see TapestryHttpSymbolConstants#MIN_GZIP_SIZE 182 * @see org.apache.tapestry5.http.services.ResponseCompressionAnalyzer 183 * @see org.apache.tapestry5.http.services.CompressionAnalyzer 184 * @since 5.1.0.0 185 */ 186 public static final String GZIP_COMPRESSION_ENABLED = TapestryHttpSymbolConstants.GZIP_COMPRESSION_ENABLED; 187 188 /** 189 * If "true" (which itself defaults to production mode), then the {@link org.apache.tapestry5.annotations.Secure} 190 * annotation will be honored. If "false" (i.e., development mode), then the annotation and related HTTP/HTTPS 191 * logic is ignored. 192 * 193 * @since 5.1.0.1 194 */ 195 public static final String SECURE_ENABLED = "tapestry.secure-enabled"; 196 197 /** 198 * If "true" (the default), then the {@link org.apache.tapestry5.services.PersistentLocale} will be encoded into the 199 * {@link org.apache.tapestry5.http.Link} path by the {@link org.apache.tapestry5.services.ComponentEventLinkEncoder} 200 * service. If overridden to "false" this does not occur, but you should provide a 201 * {@link org.apache.tapestry5.services.LinkCreationListener2} (registered with the 202 * {@link org.apache.tapestry5.services.LinkCreationHub}) in order to add the locale as a query parameter (or 203 * provide some alternate means of persisting the locale between requests). 204 * 205 * @since 5.1.0.1 206 */ 207 public static final String ENCODE_LOCALE_INTO_PATH = "tapestry.encode-locale-into-path"; 208 209 /** 210 * If "true" then JavaScript files in a {@link JavaScriptStack} will be combined into a single virtual JavaScript 211 * file. Defaults to "true" in production mode. 212 * 213 * @since 5.1.0.2 214 */ 215 public static final String COMBINE_SCRIPTS = "tapestry.combine-scripts"; 216 217 218 /** 219 * The default time interval that cookies created by Tapestry will be kept in the client web browser. The default is 220 * "7 d" (that is, seven days). 221 * 222 * @since 5.2.0 223 */ 224 public static final String COOKIE_MAX_AGE = "tapestry.default-cookie-max-age"; 225 226 /** 227 * The logical name of the start page, the page that is rendered for the root URL. 228 * 229 * @since 5.2.0 230 */ 231 public static final String START_PAGE_NAME = "tapestry.start-page-name"; 232 233 /** 234 * The default stylesheet automatically inserted into every rendered HTML page when 235 * no Bootstrap version is enabled (i.e both {@link Trait#BOOTSTRAP_3} and {@link Trait#BOOTSTRAP_4} 236 * traits are disabled, something done by {@linkplain NoBootstrapModule}). 237 * 238 * It was deprecated in 5.4 with no replacement (the stylesheet is now associated with the core {@link JavaScriptStack}.), 239 * but undeprecated in 5.5.0 with the caveat described above. 240 * 241 * @see NoBootstrapModule 242 * @since 5.2.0 243 */ 244 public static final String DEFAULT_STYLESHEET = "tapestry.default-stylesheet"; 245 246 /** 247 * The Asset path to the embedded copy of script.aculo.us packaged with Tapestry. 248 * 249 * @since 5.2.0 250 */ 251 public static final String SCRIPTACULOUS = "tapestry.scriptaculous"; 252 253 /** 254 * The Asset path to the embedded datepicker. 255 * 256 * @since 5.2.0 257 */ 258 public static final String DATEPICKER = "tapestry.datepicker"; 259 260 /** 261 * If "true", then JSON page initialization content is compressed; if "false" 262 * then extra white space is added (pretty printing). Defaults to "true" in production mode. 263 * 264 * @since 5.2.0 265 */ 266 public static final String COMPACT_JSON = "tapestry.compact-json"; 267 268 /** 269 * If "true" and {@link TapestryHttpSymbolConstants#PRODUCTION_MODE} is off, comments will be rendered before and after the rendering of any 270 * component 271 * allowing more visibility into which components rendered which markup. Defaults to "false". Component render 272 * tracing may be 273 * enabled per-request by the presence of a request parameter "t:component-trace" with a value of "true". 274 * 275 * @since 5.2.5 276 */ 277 public static final String COMPONENT_RENDER_TRACING_ENABLED = "tapestry.component-render-tracing-enabled"; 278 279 /** 280 * The hostname that application should use when constructing an absolute URL. The default is "", i.e. an empty 281 * string, 282 * in which case system will use request.getServerName(). Not the same as environment variable HOSTNAME, but you can 283 * also 284 * contribute "$HOSTNAME" as the value to make it the same as the environment variable HOSTNAME. 285 * This is an alias to {@link TapestryHttpSymbolConstants#HOSTNAME}. 286 * 287 * @since 5.3 288 */ 289 public static final String HOSTNAME = TapestryHttpSymbolConstants.HOSTNAME; 290 291 /** 292 * The hostport that application should use when constructing an absolute URL. The default is "0", i.e. use the port 293 * value from 294 * the request. This is an alias to {@link TapestryHttpSymbolConstants#HOSTPORT}. 295 * 296 * @since 5.3 297 */ 298 public static final String HOSTPORT = TapestryHttpSymbolConstants.HOSTPORT; 299 300 /** 301 * The secure (https) hostport that application should use when constructing an absolute URL. The default is "0", 302 * i.e. use 303 * the value from the request. 304 * This is an alias to {@link TapestryHttpSymbolConstants#HOSTPORT_SECURE}. 305 * 306 * @since 5.3 307 */ 308 public static final String HOSTPORT_SECURE = TapestryHttpSymbolConstants.HOSTPORT_SECURE; 309 310 /** 311 * If "true", then resources (individually or when aggregated into stacks) will be minimized via the 312 * {@link ResourceMinimizer} service. If "false", then minification is disabled. Tracks production mode 313 * (minification is normally disabled in development mode). 314 * 315 * Note that Tapestry's default implementation of {@link ResourceMinimizer} does nothing; minification is provided 316 * by add-on libraries. 317 * 318 * @since 5.3 319 */ 320 public static final String MINIFICATION_ENABLED = "tapestry.enable-minification"; 321 322 /** 323 * If "true" then at the end of each request the 324 * {@link org.apache.tapestry5.http.services.SessionPersistedObjectAnalyzer} will be called on each session persisted 325 * object that was accessed during the request. 326 * 327 * This is provided as a performance enhancement for servers that do not use clustered sessions. 328 * 329 * The default is {@code true}, to preserve 5.2 behavior. For non-clustered applications (the majority), this value should be 330 * overridden to {@code false}. A future release of Tapestry may change the default. 331 * 332 * This is an alias to {@link TapestryHttpSymbolConstants#CLUSTERED_SESSIONS}. 333 * 334 * @since 5.3 335 */ 336 public static final String CLUSTERED_SESSIONS = TapestryHttpSymbolConstants.CLUSTERED_SESSIONS; 337 338 /** 339 * The name of a folder in which the Tapestry application executes. Prior to 5.3, a Tapestry application always responded to all 340 * URLs in the context under the context root; by setting this to the name of a folder, the T5 URLs will be inside that folder only, and should 341 * match a corresponding entry in the {@code web.xml} configuration file. This is useful when running multiple servlets within the same web application (such as when migrating 342 * from Tapestry 4 or some other framework, to Tapestry 5). 343 * Effectively, if this symbol is set to a value, that folder name will be placed after the context path 344 * (typically "/") and before the locale, page name, or other prefix. For example, if this symbol is set to "app", the {@code web.xml <url-pattern>} should be set to {@code /app/*}, and Tapestry will 345 * only be in invoked by the servlet container for requests inside the virtual {@code app} folder. 346 * 347 * This also affects the search for page templates (which are allowed within the web context). When set to a non-blank value, page templates are searched for in the folder, rather than in the root context. 348 * 349 * The default value is the empty string, which preserves Tapestry 5.2 behavior (and continues to be appropriate for most applications). 350 * 351 * Note that while Tapestry is case-insensitive, the servlet container is not, so the configured value must exactly match 352 * the folder name inside the {@code <url-parameter>} value, including case. 353 * 354 * @since 5.3 355 */ 356 public static final String APPLICATION_FOLDER = "tapestry.application-folder"; 357 358 /** 359 * Boolean value to indicate if every {@link org.apache.tapestry5.Asset} should be fully qualified or not. 360 * Default to <code>false</code> meaning no Asset URL will be fully qualified. 361 * 362 * @since 5.3 363 */ 364 public static final String ASSET_URL_FULL_QUALIFIED = "tapestry.asset-url-fully-qualified"; 365 366 /** 367 * Prefix to be used for all resource paths, used to recognize which requests are for assets. This value 368 * is appended to the context path and the (optional {@linkplain #APPLICATION_FOLDER application folder}. 369 * It may contain slashes, but should not begin or end with one. 370 * 371 * The default is "assets". 372 */ 373 public static final String ASSET_PATH_PREFIX = "tapestry.asset-path-prefix"; 374 375 376 /** 377 * Prefix used for all module resources. This may contain slashes, but should not being or end with one. 378 * Tapestry will create two {@link org.apache.tapestry5.http.services.Dispatcher}s from this: one for normal 379 * modules, the other for GZip compressed modules (by appending ".gz" to this value). 380 * 381 * The default is "modules". 382 * 383 * @since 5.4 384 */ 385 public static final String MODULE_PATH_PREFIX = "tapestry.module-path-prefix"; 386 387 /** 388 * Identifies the context path of the application, as determined from {@link javax.servlet.ServletContext#getContextPath()}. 389 * This is either a blank string or a string that starts with a slash but does not end with one. 390 * This is an alias to {@link TapestryHttpSymbolConstants#CONTEXT_PATH}. 391 * 392 * @since 5.4 393 */ 394 public static final String CONTEXT_PATH = TapestryHttpSymbolConstants.CONTEXT_PATH; 395 396 /** 397 * A passphrase used as the basis of hash-based message authentication (HMAC) for any object stream data stored on 398 * the client. The default phrase is the empty string, which will result in a logged runtime <em>error</em>. 399 * You should configure this to a reasonable value (longer is better) and ensure that all servers in your cluster 400 * share the same value (configuring this in code, rather than the command line, is preferred). 401 * 402 * @see org.apache.tapestry5.services.ClientDataEncoder 403 * @since 5.3.6 404 */ 405 public static final String HMAC_PASSPHRASE = "tapestry.hmac-passphrase"; 406 407 /** 408 * The root asset path for Twitter Bootstrap; if your application uses a modified version of Bootstrap, 409 * you can override this symbol to have Tapestry automatically use your version. The value should be a path 410 * to a folder (under "classpath:" or "context:") and should not include a trailing slash. 411 * 412 * @since 5.4 413 */ 414 public static final String BOOTSTRAP_ROOT = "tapestry.bootstrap-root"; 415 416 /** 417 * The root asset path for Font Awesome; if your application uses a modified version of it, 418 * you can override this symbol to have Tapestry automatically use your version. The value should be a path 419 * to a folder (under "classpath:" or "context:") and should not include a trailing slash. 420 * 421 * @since 5.5 422 */ 423 public static final String FONT_AWESOME_ROOT = "tapestry.font-awesome-root"; 424 425 /** 426 * Tapestry relies on an underlying client-side JavaScript infrastructure framework to handle DOM manipulation, 427 * event handling, and Ajax requests. Through Tapestry 5.3, the foundation was 428 * <a href="http://http://prototypejs.org/">Prototype</a>. In 5.4, support for 429 * <a href="http://jquery.org/">jQuery</a> has been added, and it is possible to add others. This symbol defines a value that is used to select 430 * a resource that is provided to the {@link org.apache.tapestry5.services.javascript.ModuleManager} service 431 * as a {@link org.apache.tapestry5.services.javascript.JavaScriptModuleConfiguration} to provide a specific implementation 432 * of the {@code t5/core/dom} module. Tapestry 5.4 directly supports "prototype" or "jquery". To support 433 * other foundation frameworks, override this symbol value and supply your own module configuration. 434 * 435 * In Tapestry 5.4, this defaults to "prototype" for compatibility with 5.3. This will likely change in 436 * 5.5 to default to "jquery". At some point in the future, Prototype support will no longer be present. 437 * 438 * @since 5.4 439 */ 440 public static final String JAVASCRIPT_INFRASTRUCTURE_PROVIDER = "tapestry.javascript-infrastructure-provider"; 441 442 /** 443 * If true (the default), then Tapestry will apply locking semantics around access to the {@link javax.servlet.http.HttpSession}. 444 * Reading attribute names occurs with a shared read lock; getting or setting an attribute upgrades to an exclusive write lock. 445 * This can tend to serialize threads when a number of simultaneous (Ajax) requests from the client arrive ... however, 446 * many implementations of HttpSession are not thread safe, and often mutable objects are stored in the session and shared 447 * between threads. Leaving this on the default will yield a more robust application; setting it to false may speed 448 * up processing for more Ajax intensive applications (but care should then be given to ensuring that objects shared inside 449 * the session are themselves immutable or thread-safe). 450 * 451 * This is an alias to {@link TapestryHttpSymbolConstants#SESSION_LOCKING_ENABLED}. 452 * 453 * @since 5.4 454 */ 455 public static final String SESSION_LOCKING_ENABLED = TapestryHttpSymbolConstants.SESSION_LOCKING_ENABLED; 456 457 /** 458 * If true (the default), then Tapestry will automatically include the "core" stack in all 459 * pages. 460 * 461 * @see <a href="https://issues.apache.org/jira/browse/TAP5-2169">TAP5-2169</a> 462 * @since 5.4 463 */ 464 public static final String INCLUDE_CORE_STACK = "tapestry.include-core-stack"; 465 466 /** 467 * Defines the CSS class that will be given to HTML element (usually a div) <div> generated by 468 * the {@linkplain FormGroup} mixin and the 469 * {@linkplain BeanEditForm} and {@linkplain BeanEditor} 470 * components surrounding the label and the field. If the value isn't 471 * {@code form-group}, the div will have {@code class="form-group [value]}. 472 * The default value is <code>form-group</code>. 473 * 474 * @see <a href="https://issues.apache.org/jira/browse/TAP5-2182">TAP5-2182</a> 475 * @since 5.4 476 */ 477 public static final String FORM_GROUP_WRAPPER_CSS_CLASS = "tapestry.form-group-wrapper-css-class"; 478 479 /** 480 * Defines the name of the HTML element that will surround the HTML form field generated by 481 * the {@linkplain FormGroup} mixin and the {@linkplain BeanEditForm} and {@linkplain BeanEditor}. 482 * If this symbol is null or an empty string, no element will be generated surrouding the 483 * form field. The default value is the empty string (no wrapping). 484 * 485 * @see <a href="https://issues.apache.org/jira/browse/TAP5-2182">TAP5-2182</a> 486 * @see #FORM_GROUP_FORM_FIELD_WRAPPER_ELEMENT_CSS_CLASS 487 * @since 5.4 488 */ 489 public static final String FORM_GROUP_FORM_FIELD_WRAPPER_ELEMENT_NAME = "tapestry.form-group-form-field-wrapper-element-name"; 490 491 /** 492 * Defines the CSS class of the HTML element generated by 493 * the {@linkplain FormGroup} mixin and the {@linkplain BeanEditForm} and {@linkplain BeanEditor}. 494 * when {@linkplain #FORM_GROUP_FORM_FIELD_WRAPPER_ELEMENT_NAME} is not set to null or the empty string. 495 * The default value is the empty string (no CSS class added). 496 * 497 * @see <a href="https://issues.apache.org/jira/browse/TAP5-2182">TAP5-2182</a> 498 * @since 5.4 499 */ 500 public static final String FORM_GROUP_FORM_FIELD_WRAPPER_ELEMENT_CSS_CLASS = "tapestry.form-group-form-field-wrapper-element-css-class"; 501 502 /** 503 * Defines the CSS class that will be given to <label> element generated by 504 * the {@linkplain FormGroup} mixin and the 505 * {@linkplain BeanEditForm} and {@linkplain BeanEditor} 506 * components. The default value is <code>control-label</code>. 507 * 508 * @see <a href="https://issues.apache.org/jira/browse/TAP5-2182">TAP5-2182</a> 509 * @since 5.4 510 */ 511 public static final String FORM_GROUP_LABEL_CSS_CLASS = "tapestry.form-group-label-css-class"; 512 513 /** 514 * Defines the CSS class that will be given to form field components which are 515 * {@linkplain AbstractField} subclasses. The default value is <code>form-control</code>. 516 * 517 * @see <a href="https://issues.apache.org/jira/browse/TAP5-2182">TAP5-2182</a> 518 * @since 5.4 519 */ 520 public static final String FORM_FIELD_CSS_CLASS = "tapestry.form-field-css-class"; 521 522 /** 523 * Defines the CSS class that will be given to the <dl> HTML element generated by 524 * {@linkplain BeanDisplay}. The default value is <code>well dl-horizontal</code>. 525 * 526 * @since 5.5 527 */ 528 public static final String BEAN_DISPLAY_CSS_CLASS = "tapestry.bean-display-css-class"; 529 530 /** 531 * Defines the CSS class that will be given to the <div> HTML element generated by 532 * {@linkplain BeanEditor}/{@linkplain BeanEditForm} for boolean properties. 533 * The default value is <code>input-group</code>. 534 * 535 * @since 5.5 536 */ 537 public static final String BEAN_EDITOR_BOOLEAN_PROPERTY_DIV_CSS_CLASS = "tapestry.bean-editor-boolean-property-div-css-class"; 538 539 /** 540 * Defines the CSS class that will be given to the HTML element generated by 541 * {@linkplain Error}. If the value isn't <code>help-block</code>, the class attribute 542 * will be <code>help-block [symbol value]</code> 543 * The default value is <code>help-block</code>. 544 * 545 * @since 5.5 546 */ 547 public static final String ERROR_CSS_CLASS = "tapestry.error-css-class"; 548 549 /** 550 * Defines the CSS class that will be given to the add row link generated by 551 * {@linkplain AjaxFormLoop}. The default value is <code>btn btn-default btn-sm</code>. 552 * 553 * @since 5.5 554 */ 555 public static final String AJAX_FORM_LOOP_ADD_ROW_LINK_CSS_CLASS = "tapestry.ajax-form-loop-add-row-link-css-class"; 556 557 /** 558 * Defines the prefix of the CSS class that will be given to the outer <div> element generated by 559 * {@linkplain Errors}. The value of {@linkplain Errors}'s <code>class</code> parameter appended 560 * after the prefix and a space character. The default value is <code>alert-dismissable</code>. 561 * 562 * @since 5.5 563 */ 564 public static final String ERRORS_BASE_CSS_CLASS = "tapestry.errors-base-css-class"; 565 566 /** 567 * Defines the default value of the {@linkplain Errors}'s <code>class</code> parameter. 568 * The default value for this symbol is <code>alert alert-danger</code>. 569 * 570 * @since 5.5 571 */ 572 public static final String ERRORS_DEFAULT_CLASS_PARAMETER_VALUE = "tapestry.errors-default-class-parameter-value"; 573 574 /** 575 * Defines the CSS class that will be given to the close <button> generated by 576 * {@linkplain Errors}. The default value is <code>close</code>. 577 * 578 * @since 5.5 579 */ 580 public static final String ERRORS_CLOSE_BUTTON_CSS_CLASS = "tapestry.errors-close-button-css-class"; 581 582 /** 583 * Defines whether {@link java.text.DateFormat} instances created by Tapestry should be 584 * lenient or not by default. The default value is <code>false</code>. 585 * 586 * @since 5.4 587 */ 588 public static final String LENIENT_DATE_FORMAT = "tapestry.lenient-date-format"; 589 590 /** 591 * The directory to which exception report files should be written. The default is appropriate 592 * for development: {@code build/exceptions}, and should be changed for production. 593 * 594 * @see org.apache.tapestry5.services.ExceptionReporter 595 * @since 5.4 596 */ 597 598 public static final String EXCEPTION_REPORTS_DIR = "tapestry.exception-reports-dir"; 599 600 /** 601 * Defines whether {@link org.apache.tapestry5.internal.services.assets.CSSURLRewriter} will throw an exception when a CSS file 602 * references an URL which doesn't exist. The default value is <code>false</code>. 603 * 604 * @since 5.4 605 */ 606 public static final String STRICT_CSS_URL_REWRITING = "tapestry.strict-css-url-rewriting"; 607 608 /** 609 * When an asset (typically, a JavaScript module) is streamed without an explicit expiration header, then 610 * this value is sent as the {@code Cache-Control} header; the default is "max-age=60, must-revalidate". Setting 611 * max-age to a value above zero significantly reduces the number of client requests for module content, as client 612 * browsers will then cache previously downloaded versions. For normal assets, which are immutable, and fingerprinted with 613 * a content hash, there is no need to set max age, and instead, a far-future expiration date is provided. 614 * 615 * @since 5.4 616 */ 617 public static final String OMIT_EXPIRATION_CACHE_CONTROL_HEADER = "tapestry.omit-expiration-cache-control-header"; 618 619 /** 620 * Defines whether HTML5 features should be used. Value used in the default implementation of 621 * {@link Html5Support#isHtml5SupportEnabled()}. Default value: <code>false</code>. 622 * 623 * @see Html5Support#isHtml5SupportEnabled() 624 * @since 5.4 625 */ 626 public static final String ENABLE_HTML5_SUPPORT = "tapestry.enable-html5-support"; 627 628 /** 629 * A general switch for restrictive environments, such as Google App Engine, which forbid some useful operations, 630 * such as creating files or directories. Defaults to false. 631 * 632 * @since 5.4 633 */ 634 public static final String RESTRICTIVE_ENVIRONMENT = "tapestry.restrictive-environment"; 635 636 /** 637 * If true, then when a page includes any JavaScript, a {@code script} block is added to insert 638 * a pageloader mask into the page; the pageloader mask ensure that the user can't interact with the page 639 * until after the page is fully initialized. 640 * 641 * @since 5.4 642 */ 643 public static final String ENABLE_PAGELOADING_MASK = "tapestry.enable-pageloading-mask"; 644 645 /** 646 * Controls in what environment page preloading should occur. By default, preloading only occurs 647 * in production. 648 * 649 * @see org.apache.tapestry5.services.pageload.PagePreloader 650 * @see org.apache.tapestry5.services.pageload.PreloaderMode 651 * @since 5.4 652 */ 653 public static final String PRELOADER_MODE = "tapestry.page-preload-mode"; 654 655 /** 656 * Defines the OpenAPI version to be used in the generated OpenAPI description. 657 * Default value is <code>3.0.0</code>. 658 * @see DefaultOpenApiDescriptionGenerator 659 * @see OpenApiDescriptionGenerator 660 * @since 5.8.0 661 */ 662 public static final String OPENAPI_VERSION = "tapestry.openapi-version"; 663 664 /** 665 * Defines the title of this application in the generated OpenAPI description. No default value is provided. 666 * @see DefaultOpenApiDescriptionGenerator 667 * @see OpenApiDescriptionGenerator 668 * @since 5.8.0 669 */ 670 public static final String OPENAPI_TITLE = "tapestry.openapi-title"; 671 672 /** 673 * Defines the description of this application in the generated OpenAPI description. 674 * No default value is provided. 675 * @see DefaultOpenApiDescriptionGenerator 676 * @see OpenApiDescriptionGenerator 677 * @since 5.8.0 678 */ 679 public static final String OPENAPI_DESCRIPTION = "tapestry.openapi-description"; 680 681 /** 682 * Defines the version of this application in the generated OpenAPI description (i.e. info/version). 683 * No default value is provided. 684 * @see DefaultOpenApiDescriptionGenerator 685 * @see OpenApiDescriptionGenerator 686 * @since 5.8.0 687 */ 688 public static final String OPENAPI_APPLICATION_VERSION = "tapestry.openapi-application-version"; 689 690 /** 691 * Defines whether the OpenAPI description file of this application's REST endpoints should be 692 * published or not. The default value is <code>false</code>. 693 * @see OpenApiDescriptionGenerator 694 * @see #OPENAPI_DESCRIPTION_PATH 695 * @since 5.8.0 696 */ 697 public static final String PUBLISH_OPENAPI_DEFINITON = "tapestry.publish-openapi-description"; 698 699 /** 700 * Defines the path the OpenAPI description file of this application's REST endpoints will be 701 * published. It should start with a slash. Default value is <code>/openapi.json</code>. 702 * The description will only be published if {{@link #PUBLISH_OPENAPI_DEFINITON} is set to 703 * <code>true</code>. 704 * @see OpenApiDescriptionGenerator 705 * @since 5.8.0 706 */ 707 public static final String OPENAPI_DESCRIPTION_PATH = "tapestry.openapi-description-path"; 708 709 /** 710 * Defines a base path to the generated OpenAPI description relative to the application 711 * URL as defined by {@link BaseURLSource#getBaseURL(boolean)}. It should be either 712 * the empty string, meaning there's no base path, or a string starting and ending 713 * with a slash. Default value is "/" (without the quotes) 714 * @see OpenApiDescriptionGenerator 715 * @since 5.8.0 716 */ 717 public static final String OPENAPI_BASE_PATH = "tapestry.openapi-base-path"; 718 719 /** 720 * Defines whether the CORS (Cross-Origing Resource Sharing) support 721 * should be enabled or not. Default value is "false". If you set this to "true", 722 * you should also set {@link #CORS_ALLOWED_ORIGINS}. 723 * This is an alias for {@link TapestryHttpSymbolConstants#CORS_ENABLED}. 724 * @see CorsHandler 725 * @see CorsHttpServletRequestFilter 726 * @since 5.8.2 727 */ 728 public static final String CORS_ENABLED = TapestryHttpSymbolConstants.CORS_ENABLED; 729 730 /** 731 * Comma-delimited of origins allowed for CORS. The special value "*" means allowing all origins. 732 * This is used by the default implementation of {@link CorsHandlerHelper#getAllowedOrigin(javax.servlet.http.HttpServletRequest)}. 733 * Default value is the empty string (i.e. no origins allowed and CORS actually disabled). 734 * This is an alias for {@link TapestryHttpSymbolConstants#CORS_ALLOWED_ORIGINS}. 735 * @since 5.8.2 736 */ 737 public static final String CORS_ALLOWED_ORIGINS = TapestryHttpSymbolConstants.CORS_ALLOWED_ORIGINS; 738 739 /** 740 * Boolean value defining whether the Access-Control-Allow-Credentials HTTP header 741 * should be set automatically in the response for CORS requests. Default value is 742 * <code>false</code>. This is used by the default implementation of {@link CorsHandlerHelper#configureCredentials(javax.servlet.http.HttpServletResponse)}. 743 * This is an alias for {@link TapestryHttpSymbolConstants#CORS_ALLOW_CREDENTIALS}. 744 * @since 5.8.2 745 */ 746 public static final String CORS_ALLOW_CREDENTIALS = TapestryHttpSymbolConstants.CORS_ALLOW_CREDENTIALS; 747 748 /** 749 * Value to be used in the Access-Control-Allow-Methods in CORS preflight request responses. 750 * This is used by the default implementation of {@link CorsHandlerHelper#configureMethods(javax.servlet.http.HttpServletResponse)}. 751 * Default value is <code>GET,HEAD,PUT,PATCH,POST,DELETE</code>. 752 * This is an alias for {@link TapestryHttpSymbolConstants#CORS_ALLOW_METHODS}. 753 * @since 5.8.2 754 */ 755 public static final String CORS_ALLOW_METHODS = TapestryHttpSymbolConstants.CORS_ALLOW_METHODS; 756 757 /** 758 * Value to be used in the Access-Control-Allow-Headers in CORS preflight request responses. 759 * This is used by the default implementation of {@link CorsHandlerHelper#configureAllowedHeaders(javax.servlet.http.HttpServletResponse, javax.servlet.http.HttpServletRequest)}. 760 * Default value is the empty string. 761 * This is an alias for {@link TapestryHttpSymbolConstants#CORS_ALLOWED_HEADERS}. 762 * @since 5.8.2 763 */ 764 public static final String CORS_ALLOWED_HEADERS = TapestryHttpSymbolConstants.CORS_ALLOWED_HEADERS; 765 766 /** 767 * Value to be used in the Access-Control-Expose-Headers in CORS request responses. 768 * This is used by the default implementation of {@link CorsHandlerHelper#configureExposeHeaders(javax.servlet.http.HttpServletResponse)}. 769 * Default value is the empty string. 770 * This is an alias for {@link TapestryHttpSymbolConstants#CORS_EXPOSE_HEADERS}. 771 * @since 5.8.2 772 */ 773 public static final String CORS_EXPOSE_HEADERS = TapestryHttpSymbolConstants.CORS_EXPOSE_HEADERS; 774 775 /** 776 * Value to be used in the Access-Control-Max-Age in responses to preflight CORS requests. 777 * This is used by the default implementation of {@link CorsHandlerHelper#configureMaxAge(javax.servlet.http.HttpServletResponse)}. 778 * Default value is the empty string. 779 * This is an alias for {@link TapestryHttpSymbolConstants#CORS_MAX_AGE}. 780 * @since 5.8.2 781 */ 782 public static final String CORS_MAX_AGE = TapestryHttpSymbolConstants.CORS_MAX_AGE; 783 784}