You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tapestry.apache.org by bu...@apache.org on 2015/11/01 14:19:50 UTC
svn commit: r970982 - in /websites/production/tapestry/content:
cache/main.pageCache configuration.html
Author: buildbot
Date: Sun Nov 1 13:19:50 2015
New Revision: 970982
Log:
Production update by buildbot for tapestry
Modified:
websites/production/tapestry/content/cache/main.pageCache
websites/production/tapestry/content/configuration.html
Modified: websites/production/tapestry/content/cache/main.pageCache
==============================================================================
Binary files - no diff available.
Modified: websites/production/tapestry/content/configuration.html
==============================================================================
--- websites/production/tapestry/content/configuration.html (original)
+++ websites/production/tapestry/content/configuration.html Sun Nov 1 13:19:50 2015
@@ -134,11 +134,11 @@
</div>
</li></ul>
</div><h1 id="Configuration-ConfiguringTapestry">Configuring Tapestry</h1><p>This page discusses all the ways in which Tapestry can be configured. Tapestry applications are configured almost entirely using Java, with very little XML at all.</p><p><strong>Contents</strong></p><p><style type="text/css">/*<![CDATA[*/
-div.rbtoc1437941978046 {padding: 0px;}
-div.rbtoc1437941978046 ul {list-style: disc;margin-left: 0px;}
-div.rbtoc1437941978046 li {margin-left: 0px;padding-left: 0px;}
+div.rbtoc1446383974812 {padding: 0px;}
+div.rbtoc1446383974812 ul {list-style: disc;margin-left: 0px;}
+div.rbtoc1446383974812 li {margin-left: 0px;padding-left: 0px;}
-/*]]>*/</style></p><div class="toc-macro rbtoc1437941978046">
+/*]]>*/</style></p><div class="toc-macro rbtoc1446383974812">
<ul class="toc-indentation"><li><a shape="rect" href="#Configuration-XMLconfiguration(web.xml)">XML configuration (web.xml)</a></li><li><a shape="rect" href="#Configuration-YourApplication'sModuleClass">Your Application's Module Class</a></li><li><a shape="rect" href="#Configuration-ConfigurationSymbolNames">Configuration Symbol Names</a></li><li><a shape="rect" href="#Configuration-SettingComponentParameterDefaults">Setting Component Parameter Defaults</a></li><li><a shape="rect" href="#Configuration-ConfiguringIgnoredPaths">Configuring Ignored Paths</a></li><li><a shape="rect" href="#Configuration-ConfiguringContentTypeMapping">Configuring Content Type Mapping</a></li><li><a shape="rect" href="#Configuration-SettingExecutionModes">Setting Execution Modes</a></li></ul>
</div><h2 id="Configuration-XMLconfiguration(web.xml)">XML configuration (web.xml)</h2><p>Tapestry runs on top of the standard Java Servlet API. To the servlet container, such as Tomcat, Tapestry appears as a <em>servlet filter</em>. This gives Tapestry great flexibility in matching URLs without requiring lots of XML configuration.</p><p>Although most configuration is done with Java, a small but necessary amount of configuration occurs inside the servlet deployment descriptor, WEB-INF/web.xml. Most of the configuration is boilerplate, nearly the same for all applications.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>web.xml (partial)</b></div><div class="codeContent panelContent pdl">
<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;"><!DOCTYPE web-app
@@ -220,12 +220,12 @@ div.rbtoc1437941978046 li {margin-left:
<div class="confluence-information-macro confluence-information-macro-warning"><p class="title">Deprecated since 5.3</p><span class="aui-icon aui-icon-small aui-iconfont-error confluence-information-macro-icon"></span><div class="confluence-information-macro-body">
</div></div>
<div style="border-right: 20px solid #ffcccc;border-left: 20px solid #ffcccc;">
-<p> </p></div><p>When enabled, Tapestry will check that component ids referenced in event handler method names (or the @OnEvent annotation) match up against components in the container's template. The default is true, but applications upgraded form Tapestry 5.2 may want to set this to false, to keep pages from failing due to the presence of such dead code.</p><h3 id="Configuration-tapestry.component-render-tracing-enabled">tapestry.component-render-tracing-enabled</h3><p>Starting with version 5.3, if "true" then Tapestry will emit rendering comments for all requests; these are comments (such as <!--BEGIN Index:loop (context:Index.tml, line 15)-->) that can assist you in debugging markup output on the client-side. This will significantly increase the size of the rendered markup, but can be very helpful with complex layouts to determine which component was responsible for which portion of the rendered page. (To turn on rendering comments only for a particular request, add t
he query parameter t:component-trace=true to the URL.)</p><h3 id="Configuration-tapestry.compress-whitespace">tapestry.compress-whitespace</h3><p>A flag (true or false). When true (the default) whitespace in component templates is compressed by default (this can be fine-tuned using the standard xml:space attribute on an element in the template). When this flag is false, then whitespace is retained by default (but can still be overridden).</p><h3 id="Configuration-tapestry.compressed-asset-path-prefix">tapestry.compressed-asset-path-prefix</h3>
+<p> </p></div><p>When enabled, Tapestry will check that component ids referenced in event handler method names (or the @OnEvent annotation) match up against components in the container's template. The default is true, but applications upgraded form Tapestry 5.2 may want to set this to false, to keep pages from failing due to the presence of such dead code.</p><h3 id="Configuration-tapestry.component-render-tracing-enabled">tapestry.component-render-tracing-enabled</h3><p>Starting with version 5.3, if "true" then Tapestry will emit rendering comments for all requests; these are comments (such as <!--BEGIN Index:loop (context:Index.tml, line 15)-->) that can assist you in debugging markup output on the client-side. This will significantly increase the size of the rendered markup, but can be very helpful with complex layouts to determine which component was responsible for which portion of the rendered page. (To turn on rendering comments only for a particular request, add t
he query parameter t:component-trace=true to the URL.)</p><h3 id="Configuration-tapestry.compress-whitespace">tapestry.compress-whitespace</h3><p>A flag (true or false). When true (the default) whitespace in component templates is compressed by default (this can be fine-tuned using the standard xml:space attribute on an element in the template). When this flag is false, then whitespace is retained by default (but can still be overridden). See <a shape="rect" href="component-templates.html">Component Templates</a> for details.</p><h3 id="Configuration-tapestry.compressed-asset-path-prefix">tapestry.compressed-asset-path-prefix</h3>
<div class="confluence-information-macro confluence-information-macro-information"><p class="title">Added in 5.4</p><span class="aui-icon aui-icon-small aui-iconfont-info confluence-information-macro-icon"></span><div class="confluence-information-macro-body">
</div></div>
<div style="border-right: 20px solid #D8E4F1;border-left: 20px solid #D8E4F1;">
-<p> </p></div><p>As with <a shape="rect" href="configuration.html">tapestry.asset-path-prefix</a> but for compressed versions of assets. At render time, Tapestry determines whether each asset is compressable (for example, image file formats are not). A path for either tapestry.asset-path-prefix or this prefix is selected at render time. Defaults to the asset path prefix with ".gz" appended.</p><h3 id="Configuration-tapestry.context-path">tapestry.context-path</h3>
+<p> </p></div><p>As with <a shape="rect" href="configuration.html">tapestry.asset-path-prefix</a> but for compressed versions of assets. At render time, Tapestry determines whether each asset is compressable (for example, image file formats are not). A path for either tapestry.asset-path-prefix or this prefix is selected at render time. Defaults to the asset path prefix with ".gz" appended. See <a shape="rect" href="assets.html">Assets</a> for details.</p><h3 id="Configuration-tapestry.context-path">tapestry.context-path</h3>
<div class="confluence-information-macro confluence-information-macro-information"><p class="title">Added in 5.4</p><span class="aui-icon aui-icon-small aui-iconfont-info confluence-information-macro-icon"></span><div class="confluence-information-macro-body">
</div></div>
@@ -235,7 +235,7 @@ div.rbtoc1437941978046 li {margin-left:
<div class="confluence-information-macro confluence-information-macro-information"><p class="title">Added in 5.2</p><span class="aui-icon aui-icon-small aui-iconfont-info confluence-information-macro-icon"></span><div class="confluence-information-macro-body">
</div></div>
<div style="border-right: 20px solid #D8E4F1;border-left: 20px solid #D8E4F1;">
-<p> </p></div><p>The Asset path to the embedded datepicker</p><h3 id="Configuration-tapestry.default-cookie-max-age">tapestry.default-cookie-max-age</h3><p>The default time interval that cookies created by Tapestry will be kept in the client web browser. Primarily, this is used with a cookie that exists to track the preferred user locale. The default value is "7 d" (7 days; see <a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/util/TimeInterval.html">Time Interval Formats</a>).</p><h3 id="Configuration-tapestry.default-stylesheet">tapestry.default-stylesheet</h3>
+<p> </p></div><p>The path to the assets of the embedded DatePicker component</p><h3 id="Configuration-tapestry.default-cookie-max-age">tapestry.default-cookie-max-age</h3><p>The default time interval that cookies created by Tapestry will be kept in the client web browser. Primarily, this is used with a cookie that exists to track the preferred user locale. The default value is "7 d" (7 days; see <a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/util/TimeInterval.html">Time Interval Formats</a>).</p><h3 id="Configuration-tapestry.default-stylesheet">tapestry.default-stylesheet</h3>
<div class="confluence-information-macro confluence-information-macro-information"><p class="title">Added in 5.3.6</p><span class="aui-icon aui-icon-small aui-iconfont-info confluence-information-macro-icon"></span><div class="confluence-information-macro-body">
</div></div>
@@ -250,7 +250,7 @@ div.rbtoc1437941978046 li {margin-left:
<div class="confluence-information-macro confluence-information-macro-information"><p class="title">Added in 5.3.6</p><span class="aui-icon aui-icon-small aui-iconfont-info confluence-information-macro-icon"></span><div class="confluence-information-macro-body">
</div></div>
<div style="border-right: 20px solid #D8E4F1;border-left: 20px solid #D8E4F1;">
-<p> </p></div><p>If "true", then resources (individually or when aggregated into stacks) will be minimized via the ResourceMinimizer service. If "false", then minification is disabled. The default is "true" in production mode, "false" otherwise.</p><p>Note that Tapestry's default implementation of ResourceMinimizer does nothing; minification is provided by add-on libraries.</p><h3 id="Configuration-tapestry.encode-locale-into-path">tapestry.encode-locale-into-path</h3><p>If "true" (the default), then the <a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/services/PersistentLocale.html">PersistentLocale</a> will be encoded into URLs by the ComponentEventLinkEncoder service. If overridden to "false" this does not occur, but you should provide a LinkCreationListener2 (registered with the LinkCreationHub) in order to add the locale as a query parameter (or provide some alternate means of persisting the locale between requests
).</p><h3 id="Configuration-tapestry.exception-report-page">tapestry.exception-report-page</h3><p>The name of the page used to report exceptions. This defaults to "ExceptionReport".</p><h3 id="Configuration-tapestry.execution-mode">tapestry.execution-mode</h3><p>The execution mode. See <a shape="rect" href="configuration.html">Setting Execution Modes</a> below.</p><h3 id="Configuration-tapestry.file-check-interval">tapestry.file-check-interval</h3><p>Time interval between file system checks. During a file system check, only a single thread is active (all others are blocked) and any files loaded are checked for changes (this is part of <a shape="rect" href="configuration.html">automatic component reloading</a>).</p><p>The default is "1 s" (one second; see <a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/util/TimeInterval.html">Time Interval Formats</a>), and is usually overridden with a higher value in production (say, be
tween one and five minutes).</p><h3 id="Configuration-tapestry.file-check-update-timeout">tapestry.file-check-update-timeout</h3><p>Time interval that Tapestry will wait to obtain the exclusive lock needed for a file check. If the exclusive lock can't be obtained in that amount of time, the request will proceed normally (without the check), but each successive request will attempt to get the lock and perform the check until successful.</p><p>The default is "50 ms" (50 milliseconds; see <a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/util/TimeInterval.html">Time Interval Formats</a>).</p><h3 id="Configuration-tapestry.force-absolute-uris">tapestry.force-absolute-uris</h3>
+<p> </p></div><p>If "true", then resources (individually or when aggregated into stacks) will be minimized via the ResourceMinimizer service. If "false", then minification is disabled. The default is "true" in production mode, "false" otherwise.</p><p>Note that Tapestry's default implementation of ResourceMinimizer does nothing; minification is provided by add-on libraries. See <a shape="rect" href="assets.html">Assets</a> for details.</p><h3 id="Configuration-tapestry.encode-locale-into-path">tapestry.encode-locale-into-path</h3><p>If "true" (the default), then the <a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/services/PersistentLocale.html">PersistentLocale</a> will be encoded into URLs by the ComponentEventLinkEncoder service. If overridden to "false" this does not occur, but you should provide a LinkCreationListener2 (registered with the LinkCreationHub) in order to add the locale as a query parameter (or provide
some alternate means of persisting the locale between requests). See <a shape="rect" href="localization.html">Localization</a> for more details on localization.</p><h3 id="Configuration-tapestry.exception-report-page">tapestry.exception-report-page</h3><p>The name of the page used to report exceptions. This defaults to "ExceptionReport", a page that Tapestry provides. See <a shape="rect" href="overriding-exception-reporting.html">Overriding Exception Reporting</a> for details.</p><h3 id="Configuration-tapestry.execution-mode">tapestry.execution-mode</h3><p>The execution mode. See <a shape="rect" href="configuration.html">Setting Execution Modes</a> below.</p><h3 id="Configuration-tapestry.file-check-interval">tapestry.file-check-interval</h3><p>Time interval between file system checks. During a file system check, only a single thread is active (all others are blocked) and any files loaded are checked for changes (this is part of Tapestry's <a shape="rect" href="class-reloading.html
">Class Reloading</a> mechanism).</p><p>The default is "1 s" (one second; see <a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/util/TimeInterval.html">Time Interval Formats</a>), and is usually overridden with a higher value in production (say, between one and five minutes).</p><h3 id="Configuration-tapestry.file-check-update-timeout">tapestry.file-check-update-timeout</h3><p>Time interval that Tapestry will wait to obtain the exclusive lock needed for a file check. If the exclusive lock can't be obtained in that amount of time, the request will proceed normally (without the check), but each successive request will attempt to get the lock and perform the check until successful.</p><p>The default is "50 ms" (50 milliseconds; see <a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/util/TimeInterval.html">Time Interval Formats</a>).</p><h3 id="Configuration-tapestr
y.force-absolute-uris">tapestry.force-absolute-uris</h3>
<div class="confluence-information-macro confluence-information-macro-warning"><p class="title">Deprecated since 5.2</p><span class="aui-icon aui-icon-small aui-iconfont-error confluence-information-macro-icon"></span><div class="confluence-information-macro-body">
</div></div>
@@ -275,7 +275,7 @@ div.rbtoc1437941978046 li {margin-left:
<div class="confluence-information-macro confluence-information-macro-information"><p class="title">Added in 5.3.6</p><span class="aui-icon aui-icon-small aui-iconfont-info confluence-information-macro-icon"></span><div class="confluence-information-macro-body">
</div></div>
<div style="border-right: 20px solid #D8E4F1;border-left: 20px solid #D8E4F1;">
-<p> </p></div><p>The plaintext phrase used to set the key for <a shape="rect" class="external-link" href="http://en.wikipedia.org/wiki/HMAC" >HMAC</a> securing of serialized object data. The default is blank, which causes a runtime alert and console error. You should set this to a reasonably unique, private value, and ensure (in a cluster) that all servers use the same value – typically by making a contribution in your applications module class (normally AppModule.java).</p><h3 id="Configuration-tapestry.include-core-stack">tapestry.include-core-stack</h3>
+<p> </p></div><p>The plaintext phrase used to set the key for <a shape="rect" class="external-link" href="http://en.wikipedia.org/wiki/HMAC" >HMAC</a> securing of serialized object data. The default is blank, which causes a runtime alert and console error. You should set this to a reasonably unique, private value, and ensure (in a cluster) that all servers use the same value – typically by making a contribution in your applications module class (normally AppModule.java). See <a shape="rect" href="security.html">Security</a> for details.</p><h3 id="Configuration-tapestry.include-core-stack">tapestry.include-core-stack</h3>
<div class="confluence-information-macro confluence-information-macro-information"><p class="title">Added in 5.4</p><span class="aui-icon aui-icon-small aui-iconfont-info confluence-information-macro-icon"></span><div class="confluence-information-macro-body">
</div></div>
@@ -316,7 +316,7 @@ div.rbtoc1437941978046 li {margin-left:
<div class="confluence-information-macro confluence-information-macro-warning"><p class="title">Deprecated since 5.2</p><span class="aui-icon aui-icon-small aui-iconfont-error confluence-information-macro-icon"></span><div class="confluence-information-macro-body">
</div></div>
<div style="border-right: 20px solid #ffcccc;border-left: 20px solid #ffcccc;">
-<p>Starting in 5.2, this is only used if tapestry.page-pool-enabled is "true". <em>Removed in 5.3</em></p></div><p>The time interval that Tapestry will wait for a page instance to become available before deciding whether to create an entirely new page instance.</p><p>The default is "10 ms" (10 milliseconds; see <a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/util/TimeInterval.html">Time Interval Formats</a>).</p><h3 id="Configuration-tapestry.persistence-strategy">tapestry.persistence-strategy</h3><p>Identifies the default <a shape="rect" class="external-link" href="http://tapestry.apache.org/persistent-page-data.html#PersistentPageData-PersistenceStrategies">persistence strategy</a> for all pages that do not provide an override. The default is "session" (PersistenceConstants.SESSION).</p><h3 id="Configuration-tapestry.production-mode">tapestry.production-mode</h3><p>A flag (true or false) indicating whether the applica
tion is running in production or in development. The default is true, which means that runtime exceptions are not reported with full detail (only the root exception message is displayed, not the entire stack of exceptions, properties and other information shown in development mode).</p><h3 id="Configuration-tapestry.secure-enabled">tapestry.secure-enabled</h3><p>If true, then @<a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/annotations/Secure.html">Secure</a> annotations are honored; if false, no security checks or redirects take place. This defaults to tapestry.production-mode, meaning that in development mode it will (by default) be disabled.</p><h3 id="Configuration-tapestry.secure-page">tapestry.secure-page</h3><p>If true, then the page may only be accessed via HTTPS. The @<a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/annotations/Secure.html">Secure</a> annot
ation will set this value to true. This symbol is the default for all pages; set it to "true" to force the entire application to be secure.</p><h3 id="Configuration-tapestry.service-reloading-enabled">tapestry.service-reloading-enabled</h3>
+<p>Starting in 5.2, this is only used if tapestry.page-pool-enabled is "true". <em>Removed in 5.3</em></p></div><p>The time interval that Tapestry will wait for a page instance to become available before deciding whether to create an entirely new page instance.</p><p>The default is "10 ms" (10 milliseconds; see <a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/util/TimeInterval.html">Time Interval Formats</a>).</p><h3 id="Configuration-tapestry.persistence-strategy">tapestry.persistence-strategy</h3><p>Identifies the default <a shape="rect" class="external-link" href="http://tapestry.apache.org/persistent-page-data.html#PersistentPageData-PersistenceStrategies">persistence strategy</a> for all pages that do not provide an override. The default is "session" (PersistenceConstants.SESSION).</p><h3 id="Configuration-tapestry.production-mode">tapestry.production-mode</h3><p>A flag (true or false) indicating whether the applica
tion is running in production or in development. The default is true, which means that runtime exceptions are not reported with full detail (only the root exception message is displayed, not the entire stack of exceptions, properties and other information shown in development mode).</p><h3 id="Configuration-tapestry.secure-enabled">tapestry.secure-enabled</h3><p>If true, then @<a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/annotations/Secure.html">Secure</a> annotations are honored; if false, no security checks or redirects take place. This defaults to tapestry.production-mode, meaning that in development mode it will (by default) be disabled. See <a shape="rect" href="https.html">HTTPS</a> for details.</p><h3 id="Configuration-tapestry.secure-page">tapestry.secure-page</h3><p>If true, then the page may only be accessed via HTTPS. The @<a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/o
rg/apache/tapestry5/annotations/Secure.html">Secure</a> annotation will set this value to true. This symbol is the default for all pages; set it to "true" to force the entire application to be secure. See <a shape="rect" href="https.html">HTTPS</a> for details.</p><h3 id="Configuration-tapestry.service-reloading-enabled">tapestry.service-reloading-enabled</h3>
<div class="confluence-information-macro confluence-information-macro-information"><p class="title">Added in 5.2</p><span class="aui-icon aui-icon-small aui-iconfont-info confluence-information-macro-icon"></span><div class="confluence-information-macro-body">
</div></div>