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 2022/03/28 14:11:54 UTC
svn commit: r1078951 - in /websites/production/tapestry/content: cache/main.pageCache configuration.html
Author: buildbot
Date: Mon Mar 28 14:11:54 2022
New Revision: 1078951
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 Mar 28 14:11:54 2022
@@ -160,7 +160,7 @@
<span class="icon aui-icon content-type-page" title="Page">Page:</span> </div>
<div class="details">
- <a href="response-compression.html">Response Compression</a>
+ <a href="tapestry-ioc-configuration.html">Tapestry IoC Configuration</a>
</div>
@@ -169,7 +169,7 @@
<span class="icon aui-icon content-type-page" title="Page">Page:</span> </div>
<div class="details">
- <a href="tapestry-ioc-configuration.html">Tapestry IoC Configuration</a>
+ <a href="response-compression.html">Response Compression</a>
</div>
@@ -214,11 +214,11 @@
<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.rbtoc1613085707327 {padding: 0px;}
-div.rbtoc1613085707327 ul {list-style: disc;margin-left: 0px;}
-div.rbtoc1613085707327 li {margin-left: 0px;padding-left: 0px;}
+div.rbtoc1648476707657 {padding: 0px;}
+div.rbtoc1648476707657 ul {list-style: disc;margin-left: 0px;}
+div.rbtoc1648476707657 li {margin-left: 0px;padding-left: 0px;}
-/*]]>*/</style></p><div class="toc-macro rbtoc1613085707327">
+/*]]>*/</style></p><div class="toc-macro rbtoc1648476707657">
<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><li><a href="#Configuration-SegregatingApplicationsIntoFolders">Segregating Applications Into Folders</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><code class="language-xml"><!DOCTYPE web-app
@@ -270,14 +270,14 @@ div.rbtoc1613085707327 li {margin-left:
<div class="param-body"></div>
-</div><p><strong>SymbolConstants.APPLICATION_FOLDER</strong> – The folder, of the context, in which the Tapestry application executes. By default this is blank, meaning the Tapestry application executes in the root of the web application context. Setting this value allows the Tapestry application to be <a href="https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=85460413">segregated into a folder</a>, which can be useful when Tapestry is executed inside a web application with other servlets or filters.</p><h3 id="Configuration-tapestry.asset-url-fully-qualified">tapestry.asset-url-fully-qualified</h3>
+</div><p><strong>SymbolConstants.APPLICATION_FOLDER</strong> – The folder, of the context, in which the Tapestry application executes. By default this is blank, meaning the Tapestry application executes in the root of the web application context. Setting this value allows the Tapestry application to be <a href="configuration.html">segregated into a folder</a>, which can be useful when Tapestry is executed inside a web application with other servlets or filters.</p><h3 id="Configuration-tapestry.asset-url-fully-qualified">tapestry.asset-url-fully-qualified</h3>
<div class="aui-message aui-message-info macro-since"><b class="param-since">Added in 5.3</b>
<div class="param-body"></div>
-</div><p><strong>SymbolConstants.ASSET_URL_FULL_QUALIFIED</strong> – A boolean value to indicate whether <a href="https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=85460413">asset</a> URLs should be fully qualified in the rendered page. This defaults to <code>false</code> (not fully qualified).</p><h3 id="Configuration-tapestry.asset-path-prefix">tapestry.asset-path-prefix</h3>
+</div><p><strong>SymbolConstants.ASSET_URL_FULL_QUALIFIED</strong> – A boolean value to indicate whether <a href="configuration.html">asset</a> URLs should be fully qualified in the rendered page. This defaults to <code>false</code> (not fully qualified).</p><h3 id="Configuration-tapestry.asset-path-prefix">tapestry.asset-path-prefix</h3>
<div class="aui-message aui-message-info macro-since"><b class="param-since">Added in 5.3.1</b>
@@ -361,7 +361,14 @@ div.rbtoc1613085707327 li {margin-left:
<div class="param-body"></div>
-</div><p><strong>SymbolConstants.DEFAULT_STYLESHEET</strong> – In 5.3, this is the default stylesheet automatically injected into every rendered HTML page. Many Tapestry components assume that this stylesheet is available. All the classes defined in the stylesheet are prefixed with "t-". The exact contents of the stylesheet are subject to change at any time (they are considered internal), so replacing the stylesheet, rather than overriding selected rules within it, entails some risk.</p><p>The default is org/apache/tapestry5/default.css, stored on the classpath.</p><p>Deprecated in 5.4 with no replacement. The stylesheet is now associated with the core JavaScriptStack.</p><p>Undeprecated in 5.5.0. The stylesheet defined by this symbol is needed when Tapestry is configured to not include Bootstrap at all.</p><h3 id="Configuration-tapestry.enable-html5-support">tapestry.enable-html5-support</h3><p>
+</div><p><strong>SymbolConstants.DEFAULT_STYLESHEET</strong> – In 5.3, this is the default stylesheet automatically injected into every rendered HTML page. Many Tapestry components assume that this stylesheet is available. All the classes defined in the stylesheet are prefixed with "t-". The exact contents of the stylesheet are subject to change at any time (they are considered internal), so replacing the stylesheet, rather than overriding selected rules within it, entails some risk.</p><p>The default is org/apache/tapestry5/default.css, stored on the classpath.</p><p>Deprecated in 5.4 with no replacement. The stylesheet is now associated with the core JavaScriptStack.</p><p>Undeprecated in 5.5.0. The stylesheet defined by this symbol is needed when Tapestry is configured to not include Bootstrap at all.</p><h3 id="Configuration-tapestry.error-css-class">tapestry.error-css-class</h3>
+
+<div class="aui-message aui-message-info macro-since"><b class="param-since">Added in 5..5</b>
+
+
+ <div class="param-body"></div>
+
+</div><p><strong>SymbolConstants.ERROR_CSS_CLASS</strong> – Defines the CSS class that will be given to the HTML element generated by the Error component. If the value isn't <code>help-block</code>, the class attributewill be <code>help-block [symbol value]</code>. The default value is <code>help-block</code>.</p><h3 id="Configuration-tapestry.enable-html5-support">tapestry.enable-html5-support</h3><p>
</p><div class="aui-message aui-message-info macro-since"><b class="param-since">Added in 5.4</b>
@@ -389,7 +396,7 @@ div.rbtoc1613085707327 li {margin-left:
<div class="param-body"></div>
-</div><strong>SymbolConstants.EXCEPTION_REPORTS_DIR</strong> – 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></p><h3 id="Configuration-tapestry.execution-mode">tapestry.execution-mode</h3><p><strong>SymbolConstants.EXECUTION_MODE</strong> – The execution mode. See <a href="https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=85460413">Configuration#Setting Execution Modes</a> below.</p><h3 id="Configuration-tapestry.file-check-interval">tapestry.file-check-interval</h3><p><strong>SymbolConstants.FILE_CHECK_INTERVAL</strong> – 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 ch
anges (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><strong>SymbolConstants.FILE_CHECK_UPDATE_TIMEOUT</strong> – 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/api
docs/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><strong>SymbolConstants.EXCEPTION_REPORTS_DIR</strong> – 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></p><h3 id="Configuration-tapestry.execution-mode">tapestry.execution-mode</h3><p><strong>SymbolConstants.EXECUTION_MODE</strong> – 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><strong>SymbolConstants.FILE_CHECK_INTERVAL</strong> – 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><strong>SymbolConstants.FILE_CHECK_UPDATE_TIMEOUT</strong> – 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 F
ormats</a>).</p><h3 id="Configuration-tapestry.force-absolute-uris">tapestry.force-absolute-uris</h3>
<div class="aui-message aui-message-warning macro-deprecated"><b class="param-deprecated">Deprecated since 5.2</b>