Class SymbolConstants

    • Field Detail

      • EXECUTION_MODE

        public static final String EXECUTION_MODE
        A comma separated list of execution modes used to control how the application is initialized. Each modes can contribute a list (comma separated) of Module classes to be loaded during startup, the order in which they appear is preserved. The default value is: production. This is an alias for TapestryHttpSymbolConstants.EXECUTION_MODE.
        See Also:
        Constant Field Values
      • PRODUCTION_MODE

        public static final String PRODUCTION_MODE
        Indicates whether Tapestry is running in production mode or developer mode. This affects a large number of Tapestry behaviors related to performance and security, including how exceptions are reported, whether far-future expire headers are emitted, whether JavaScript files may be combined, whether JSON is compressed, whether component field and parameter values are shadowed to instance variables (to assist with debugging), and more. This is an alias to TapestryHttpSymbolConstants.PRODUCTION_MODE.
        See Also:
        Constant Field Values
      • SUPPORTED_LOCALES

        public static final String SUPPORTED_LOCALES
        The list of locales supported by the application; locales identified in the incoming request are "narrowed" to one of these values. The first locale name in the list is the default locale used when no proper match can be found.
        See Also:
        Constant Field Values
      • COMPRESS_WHITESPACE

        public static final String COMPRESS_WHITESPACE
        Controls whether whitespace is compressed by default in templates, or left as is. The factory default is to compress whitespace. (This can also be overridden using the xml:space attribute inside template elements.)
        See Also:
        Constant Field Values
      • FILE_CHECK_INTERVAL

        public static final String FILE_CHECK_INTERVAL
        Time interval defining how often Tapestry will check for updates to local files (including classes). Starting with 5.3, this is only used when not running in production mode. The default is "1 s" (one second), which is appropriate for development. With Tapestry 5.2 and earlier this number should be raised in a production environment.
        See Also:
        Constant Field Values
      • FILE_CHECK_UPDATE_TIMEOUT

        public static final String FILE_CHECK_UPDATE_TIMEOUT
        Time interval that sets how long Tapestry will wait to obtain the exclusive lock needed to check local files. The default is "50 ms". Starting with 5.3, this is only used when not running in production mode.
        See Also:
        Constant Field Values
      • TAPESTRY_VERSION

        public static final String TAPESTRY_VERSION
        The version number of the core Tapestry framework, or UNKNOWN if the version number is not available (which should only occur when developing Tapestry).
        See Also:
        Constant Field Values
      • APPLICATION_CATALOG

        public static final String APPLICATION_CATALOG
        The location of the application-wide component messages catalog, relative to the web application context. This will normally be WEB-INF/app.properties.
        See Also:
        Constant Field Values
      • FORM_CLIENT_LOGIC_ENABLED

        public static final String FORM_CLIENT_LOGIC_ENABLED
        Used as the default for the Form's autofocus and clientValidation parameters. If overridden to "false", then Forms will not (unless explicitly specified) use client validation or autofocus, which in turn, means that most pages with Forms will not make use of the Tapestry JavaScript stack.
        See Also:
        Constant Field Values
      • OMIT_GENERATOR_META

        public static final String OMIT_GENERATOR_META
        Used to omit the normal Tapestry framework generator meta tag. The meta tag is rendered by default, but clients who do not wish to advertise their use of Tapestry may set this symbol to "true".
        Since:
        5.1.0.0
        See Also:
        Constant Field Values
      • SECURE_ENABLED

        public static final String SECURE_ENABLED
        If "true" (which itself defaults to production mode), then the Secure annotation will be honored. If "false" (i.e., development mode), then the annotation and related HTTP/HTTPS logic is ignored.
        Since:
        5.1.0.1
        See Also:
        Constant Field Values
      • COOKIE_MAX_AGE

        public static final String COOKIE_MAX_AGE
        The default time interval that cookies created by Tapestry will be kept in the client web browser. The default is "7 d" (that is, seven days).
        Since:
        5.2.0
        See Also:
        Constant Field Values
      • COMPACT_JSON

        public static final String COMPACT_JSON
        If "true", then JSON page initialization content is compressed; if "false" then extra white space is added (pretty printing). Defaults to "true" in production mode.
        Since:
        5.2.0
        See Also:
        Constant Field Values
      • HOSTNAME

        public static final String HOSTNAME
        The hostname that application should use when constructing an absolute URL. The default is "", i.e. an empty string, in which case system will use request.getServerName(). Not the same as environment variable HOSTNAME, but you can also contribute "$HOSTNAME" as the value to make it the same as the environment variable HOSTNAME. This is an alias to TapestryHttpSymbolConstants.HOSTNAME.
        Since:
        5.3
        See Also:
        Constant Field Values
      • MINIFICATION_ENABLED

        public static final String MINIFICATION_ENABLED
        If "true", then resources (individually or when aggregated into stacks) will be minimized via the ResourceMinimizer service. If "false", then minification is disabled. Tracks production mode (minification is normally disabled in development mode). Note that Tapestry's default implementation of ResourceMinimizer does nothing; minification is provided by add-on libraries.
        Since:
        5.3
        See Also:
        Constant Field Values
      • CLUSTERED_SESSIONS

        public static final String CLUSTERED_SESSIONS
        If "true" then at the end of each request the SessionPersistedObjectAnalyzer will be called on each session persisted object that was accessed during the request. This is provided as a performance enhancement for servers that do not use clustered sessions. The default is true, to preserve 5.2 behavior. For non-clustered applications (the majority), this value should be overridden to false. A future release of Tapestry may change the default. This is an alias to TapestryHttpSymbolConstants.CLUSTERED_SESSIONS.
        Since:
        5.3
        See Also:
        Constant Field Values
      • APPLICATION_FOLDER

        public static final String APPLICATION_FOLDER
        The name of a folder in which the Tapestry application executes. Prior to 5.3, a Tapestry application always responded to all 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 match a corresponding entry in the web.xml configuration file. This is useful when running multiple servlets within the same web application (such as when migrating from Tapestry 4 or some other framework, to Tapestry 5). Effectively, if this symbol is set to a value, that folder name will be placed after the context path (typically "/") and before the locale, page name, or other prefix. For example, if this symbol is set to "app", the web.xml <url-pattern> should be set to /app/*, and Tapestry will only be in invoked by the servlet container for requests inside the virtual app folder. 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. The default value is the empty string, which preserves Tapestry 5.2 behavior (and continues to be appropriate for most applications). Note that while Tapestry is case-insensitive, the servlet container is not, so the configured value must exactly match the folder name inside the <url-parameter> value, including case.
        Since:
        5.3
        See Also:
        Constant Field Values
      • ASSET_PATH_PREFIX

        public static final String ASSET_PATH_PREFIX
        Prefix to be used for all resource paths, used to recognize which requests are for assets. This value is appended to the context path and the (optional application folder. It may contain slashes, but should not begin or end with one. The default is "assets".
        See Also:
        Constant Field Values
      • MODULE_PATH_PREFIX

        public static final String MODULE_PATH_PREFIX
        Prefix used for all module resources. This may contain slashes, but should not being or end with one. Tapestry will create two Dispatchers from this: one for normal modules, the other for GZip compressed modules (by appending ".gz" to this value). The default is "modules".
        Since:
        5.4
        See Also:
        Constant Field Values
      • HMAC_PASSPHRASE

        public static final String HMAC_PASSPHRASE
        A passphrase used as the basis of hash-based message authentication (HMAC) for any object stream data stored on the client. The default phrase is the empty string, which will result in a logged runtime error. You should configure this to a reasonable value (longer is better) and ensure that all servers in your cluster share the same value (configuring this in code, rather than the command line, is preferred).
        Since:
        5.3.6
        See Also:
        ClientDataEncoder, Constant Field Values
      • BOOTSTRAP_ROOT

        public static final String BOOTSTRAP_ROOT
        The root asset path for Twitter Bootstrap; if your application uses a modified version of Bootstrap, you can override this symbol to have Tapestry automatically use your version. The value should be a path to a folder (under "classpath:" or "context:") and should not include a trailing slash.
        Since:
        5.4
        See Also:
        Constant Field Values
      • FONT_AWESOME_ROOT

        public static final String FONT_AWESOME_ROOT
        The root asset path for Font Awesome; if your application uses a modified version of it, you can override this symbol to have Tapestry automatically use your version. The value should be a path to a folder (under "classpath:" or "context:") and should not include a trailing slash.
        Since:
        5.5
        See Also:
        Constant Field Values
      • JAVASCRIPT_INFRASTRUCTURE_PROVIDER

        public static final String JAVASCRIPT_INFRASTRUCTURE_PROVIDER
        Tapestry relies on an underlying client-side JavaScript infrastructure framework to handle DOM manipulation, event handling, and Ajax requests. Through Tapestry 5.3, the foundation was Prototype. In 5.4, support for jQuery has been added, and it is possible to add others. This symbol defines a value that is used to select a resource that is provided to the ModuleManager service as a JavaScriptModuleConfiguration to provide a specific implementation of the t5/core/dom module. Tapestry 5.4 directly supports "prototype" or "jquery". To support other foundation frameworks, override this symbol value and supply your own module configuration. In Tapestry 5.4, this defaults to "prototype" for compatibility with 5.3. This will likely change in 5.5 to default to "jquery". At some point in the future, Prototype support will no longer be present.
        Since:
        5.4
        See Also:
        Constant Field Values
      • SESSION_LOCKING_ENABLED

        public static final String SESSION_LOCKING_ENABLED
        If true (the default), then Tapestry will apply locking semantics around access to the HttpSession. Reading attribute names occurs with a shared read lock; getting or setting an attribute upgrades to an exclusive write lock. This can tend to serialize threads when a number of simultaneous (Ajax) requests from the client arrive ... however, many implementations of HttpSession are not thread safe, and often mutable objects are stored in the session and shared between threads. Leaving this on the default will yield a more robust application; setting it to false may speed up processing for more Ajax intensive applications (but care should then be given to ensuring that objects shared inside the session are themselves immutable or thread-safe). This is an alias to TapestryHttpSymbolConstants.SESSION_LOCKING_ENABLED.
        Since:
        5.4
        See Also:
        Constant Field Values
      • ERROR_CSS_CLASS

        public static final String ERROR_CSS_CLASS
        Defines the CSS class that will be given to the HTML element generated by Error. If the value isn't help-block, the class attribute will be help-block [symbol value] The default value is help-block.
        Since:
        5.5
        See Also:
        Constant Field Values
      • ERRORS_BASE_CSS_CLASS

        public static final String ERRORS_BASE_CSS_CLASS
        Defines the prefix of the CSS class that will be given to the outer <div> element generated by Errors. The value of Errors's class parameter appended after the prefix and a space character. The default value is alert-dismissable.
        Since:
        5.5
        See Also:
        Constant Field Values
      • OMIT_EXPIRATION_CACHE_CONTROL_HEADER

        public static final String OMIT_EXPIRATION_CACHE_CONTROL_HEADER
        When an asset (typically, a JavaScript module) is streamed without an explicit expiration header, then this value is sent as the Cache-Control header; the default is "max-age=60, must-revalidate". Setting max-age to a value above zero significantly reduces the number of client requests for module content, as client browsers will then cache previously downloaded versions. For normal assets, which are immutable, and fingerprinted with a content hash, there is no need to set max age, and instead, a far-future expiration date is provided.
        Since:
        5.4
        See Also:
        Constant Field Values
      • RESTRICTIVE_ENVIRONMENT

        public static final String RESTRICTIVE_ENVIRONMENT
        A general switch for restrictive environments, such as Google App Engine, which forbid some useful operations, such as creating files or directories. Defaults to false.
        Since:
        5.4
        See Also:
        Constant Field Values
      • ENABLE_PAGELOADING_MASK

        public static final String ENABLE_PAGELOADING_MASK
        If true, then when a page includes any JavaScript, a script block is added to insert a pageloader mask into the page; the pageloader mask ensure that the user can't interact with the page until after the page is fully initialized.
        Since:
        5.4
        See Also:
        Constant Field Values