Author: buildbot
Date: Mon Feb 15 16:20:03 2016
New Revision: 980483
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 Mon Feb 15 16:20:03
2016
@@ -136,11 +136,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.rbtoc1447035667851 {padding: 0px;}
-div.rbtoc1447035667851 ul {list-style: disc;margin-left: 0px;}
-div.rbtoc1447035667851 li {margin-left: 0px;padding-left: 0px;}
+div.rbtoc1455553188967 {padding: 0px;}
+div.rbtoc1455553188967 ul {list-style: disc;margin-left: 0px;}
+div.rbtoc1455553188967 li {margin-left: 0px;padding-left: 0px;}
-/*]]>*/</style></p><div class="toc-macro rbtoc1447035667851">
+/*]]>*/</style></p><div class="toc-macro rbtoc1455553188967">
<ul class="toc-indentation"><li><a
href="#Configuration-XMLconfiguration(web.xml)">XML configuration
(web.xml)</a></li><li><a
href="#Configuration-YourApplication'sModuleClass">Your Application's Module
Class</a></li><li><a
href="#Configuration-ConfigurationSymbolNames">Configuration Symbol
Names</a></li><li><a
href="#Configuration-SettingComponentParameterDefaults">Setting Component
Parameter Defaults</a></li><li><a
href="#Configuration-ConfiguringIgnoredPaths">Configuring Ignored
Paths</a></li><li><a
href="#Configuration-ConfiguringContentTypeMapping">Configuring Content Type
Mapping</a></li><li><a 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
@@ -252,7 +252,7 @@ div.rbtoc1447035667851 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.
See <a 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 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
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
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 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 href="class-reloading.html">Class
Reloading</a> mechanism).</p><p>The default is "1 s" (one second
; see <a 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 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 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 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
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
href="overriding-exception-reporting.html">Overriding Exception Reporting</a>
for details.</p><h3
id="Configuration-tapestry.exception-reports-dir">tapestry.exception-reports-dir</h3><div
class="error"><span class="error">Unknown macro: {since|since=5.4}</span>
</div><p>The root directory where Tapestry's built-in OperationTracker will
create dated folders into which it writes exception report files. This is
<code>build/exceptions</code> by default but should be overridden for
production. See the related <code>tapestry.restrictive-environment</code>
symbol below.</p><h3
id="Configuration-tapestry.execution-mode">tapestry.execution-mode</h3><p>Th
e execution mode. See <a 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 href="class-reloading.html">Class
Reloading</a> mechanism).</p><p>The default is "1 s" (one second; see <a
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 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>
<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>
@@ -318,7 +318,7 @@ div.rbtoc1447035667851 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 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 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 application is running in produ
ction 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 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 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 class="external-link"
href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/annotations/Secure.html";>Secure</a>
anno
tation 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
href="https.html">HTTPS</a> for details.</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 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 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 application is running in produ
ction 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.restrictive-environment">tapestry.restrictive-environment</h3><div
class="error"><span class="error">Unknown macro: {since|since=5.4}</span>
</div><p>A flag (true or false) that, if true, changes some default Tapestry
behavior to make it work better in restrictive environments such as Google App
Engine (GAE). Specifically, if true, then OperationsTracker writes its
exception report files into a single folder (specified by the
tapestry.exception-reports-dir symbol, above) rather than creating dated
sub-folders under that path, and ResourceTransformerFactory avoids creating a
cache folder for resources.</p><h3
id="Configuration-tapestry.secure-enabled">tapestry.secure-enabled</h3><p>If
true, then
@<a 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 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 class="external-link"
href="http://tapestry.apache.org/current/apidocs/org/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
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>
