Repository: struts-site Updated Branches: refs/heads/asf-site 40d302a8b -> 1b9b67fae
Updates production by Jenkins Project: http://git-wip-us.apache.org/repos/asf/struts-site/repo Commit: http://git-wip-us.apache.org/repos/asf/struts-site/commit/1b9b67fa Tree: http://git-wip-us.apache.org/repos/asf/struts-site/tree/1b9b67fa Diff: http://git-wip-us.apache.org/repos/asf/struts-site/diff/1b9b67fa Branch: refs/heads/asf-site Commit: 1b9b67faea53d30d5eec096baa1449ae8fb2e3dd Parents: 40d302a Author: jenkins <bui...@apache.org> Authored: Wed Aug 23 11:17:30 2017 +0000 Committer: jenkins <bui...@apache.org> Committed: Wed Aug 23 11:17:30 2017 +0000 ---------------------------------------------------------------------- .../core-developers/configuration-files.html | 49 +-- content/core-developers/default-properties.html | 422 +++++++++++++++++++ content/core-developers/struts-xml.html | 33 +- content/core-developers/web-xml.html | 252 +++++------ 4 files changed, 544 insertions(+), 212 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/struts-site/blob/1b9b67fa/content/core-developers/configuration-files.html ---------------------------------------------------------------------- diff --git a/content/core-developers/configuration-files.html b/content/core-developers/configuration-files.html index f6d8082..2b6d14e 100644 --- a/content/core-developers/configuration-files.html +++ b/content/core-developers/configuration-files.html @@ -127,19 +127,14 @@ <a class="edit-on-gh" href="https://github.com/apache/struts-site/edit/master/source/core-developers/configuration-files.md"; title="Edit this page on GitHub">Edit on GitHub</a> <h1 id="configuration-files">Configuration Files</h1> -<p>From a Struts developer point of view, the one required configuration file used by the framework is</p> +<p>From a Struts developer point of view, the one required configuration file used by the framework is <code class="highlighter-rouge">web.xml</code>.<br /> +From here, you have full control over how Struts configures both itself and your application. By default, Struts will +load a set of internal configuration files to configure itself, then another set to configure your application, however +it is possible to build an entire Struts application without writing a single configuration file other than <code class="highlighter-rouge">web.xml</code>.</p> -<div class="highlighter-rouge"><pre class="highlight"><code>web.xml -</code></pre> -</div> -<p>. From here, you have full control over how Struts configures both itself and your application. By default, Struts will load a set of internal configuration files to configure itself, then another set to configure your application, however it is possible to build an entire Struts application without writing a single configuration file other than</p> - -<div class="highlighter-rouge"><pre class="highlight"><code>web.xml -</code></pre> -</div> -<p>.</p> - -<p>The table lists the files that you can use to configure the framework for your application. Some configuration files can be reloaded dynamically. Dynamic reloading makes interactive development possible. See <a href="reloading-configuration.html">Reloading configuration</a> for more.</p> +<p>The table lists the files that you can use to configure the framework for your application. Some configuration files +can be reloaded dynamically. Dynamic reloading makes interactive development possible. +See <a href="reloading-configuration.html">Reloading configuration</a> for more.</p> <table> <thead> @@ -191,7 +186,7 @@ <td>struts-plugin.xml</td> <td>yes</td> <td>At the root of a plugin JAR</td> - <td>Optional configuration files for <em>Plugins</em> in the same format as struts.xml.</td> + <td>Optional configuration files for <a href="../plugins-developer-guide/">Plugins</a> in the same format as struts.xml.</td> </tr> <tr> <td><a href="velocity-properties.html">velocity.properties</a></td> @@ -202,32 +197,22 @@ </tbody> </table> -<p>####Static Content####</p> - -<p>Common static content that is needed by the framework (JavaScript and CSS files, etc.) is served automatically by the FilterDispatcher filter. Any request starting with â</p> - -<div class="highlighter-rouge"><pre class="highlight"><code>/struts/ -</code></pre> -</div> -<p>â denotes that static content is required, and then mapping the value after â</p> +<h2 id="static-content">Static Content</h2> -<div class="highlighter-rouge"><pre class="highlight"><code>/struts/ -</code></pre> -</div> -<p>â to common packages in the framework and, optionally in the applicationâs class path.</p> +<p>Common static content that is needed by the framework (JavaScript and CSS files, etc.) is served automatically by +the FilterDispatcher filter. Any request starting with <code class="highlighter-rouge">/struts/</code> denotes that static content is required, and then +mapping the value after <code class="highlighter-rouge">/struts/</code> to common packages in the framework and, optionally in the applicationâs class path.</p> <p>By default, the following packages are searched:</p> <ul> - <li> - <p>org.apache.struts2.static</p> - </li> - <li> - <p>template</p> - </li> + <li><code class="highlighter-rouge">org.apache.struts2.static</code></li> + <li><code class="highlighter-rouge">template</code></li> </ul> -<p>Additional packages can be specified by providing a comma separated list to the configuration parameter named âpackagesâ (configured in web.xml for the FilterDispatcher filter). When specifying additional static content, you should be careful not to expose sensitive configuration information (such as the password to a database).</p> +<p>Additional packages can be specified by providing a comma separated list to the configuration parameter named âpackagesâ +(configured in <code class="highlighter-rouge">web.xml</code> for the FilterDispatcher filter). When specifying additional static content, you should +be careful not to expose sensitive configuration information (such as the password to a database).</p> </section> </article> http://git-wip-us.apache.org/repos/asf/struts-site/blob/1b9b67fa/content/core-developers/default-properties.html ---------------------------------------------------------------------- diff --git a/content/core-developers/default-properties.html b/content/core-developers/default-properties.html new file mode 100644 index 0000000..ad14a3c --- /dev/null +++ b/content/core-developers/default-properties.html @@ -0,0 +1,422 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="UTF-8"/> + <meta name="viewport" content="width=device-width, initial-scale=1.0"/> + <meta name="Date-Revision-yyyymmdd" content="20140918"/> + <meta http-equiv="Content-Language" content="en"/> + <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> + + <title>default.properties</title> + + <link href="//fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,600,700,400italic,600italic,700italic" rel="stylesheet" type="text/css"> + <link href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css" rel="stylesheet"> + <link href="/css/main.css" rel="stylesheet"> + <link href="/css/custom.css" rel="stylesheet"> + <link href="/highlighter/github-theme.css" rel="stylesheet"> + + <script src="//ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"></script> + <script type="text/javascript" src="/bootstrap/js/bootstrap.js"></script> + <script type="text/javascript" src="/js/community.js"></script> +</head> +<body> + +<a href="http://github.com/apache/struts"; class="github-ribbon"> + <img style="position: absolute; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png"; alt="Fork me on GitHub"> +</a> + +<header> + <nav> + <div role="navigation" class="navbar navbar-default navbar-fixed-top"> + <div class="container"> + <div class="navbar-header"> + <button type="button" data-toggle="collapse" data-target="#struts-menu" class="navbar-toggle"> + Menu + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a href="/index.html" class="navbar-brand logo"><img src="/img/struts-logo.svg"></a> + </div> + <div id="struts-menu" class="navbar-collapse collapse"> + <ul class="nav navbar-nav"> + <li class="dropdown"> + <a data-toggle="dropdown" href="#" class="dropdown-toggle"> + Home<b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="/index.html">Welcome</a></li> + <li><a href="/downloads.html">Downloads</a></li> + <li><a href="/announce.html">Announcements</a></li> + <li><a href="http://www.apache.org/licenses/";>License</a></li> + <li><a href="http://apache.org/foundation/thanks.html";>Thanks!</a></li> + <li><a href="http://apache.org/foundation/sponsorship.html";>Sponsorship</a></li> + </ul> + </li> + <li class="dropdown"> + <a data-toggle="dropdown" href="#" class="dropdown-toggle"> + Support<b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="/mail.html">User Mailing List</a></li> + <li><a href="https://issues.apache.org/jira/browse/WW";>Issue Tracker</a></li> + <li><a href="/security.html">Reporting Security Issues</a></li> + <li class="divider"></li> + <li><a href="/maven/project-info.html">Project info</a></li> + <li><a href="/maven/struts2-core/dependencies.html">Struts Core dependencies</a></li> + <li><a href="/maven/struts2-plugins/modules.html">Plugin dependencies</a></li> + </ul> + </li> + <li class="dropdown"> + <a data-toggle="dropdown" href="#" class="dropdown-toggle"> + Documentation<b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="/birdseye.html">Birds Eye</a></li> + <li><a href="/primer.html">Key Technologies</a></li> + <li><a href="/kickstart.html">Kickstart FAQ</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/WW/Home";>Wiki</a></li> + <li class="divider"></li> + <li><a href="/getting-started/">Getting Started</a></li> + <li><a href="/security/">Security Guide</a></li> + <li><a href="/docs/tutorials.html">Tutorials</a></li> + <li><a href="/docs/faqs.html">FAQs</a></li> + <li><a href="/docs/guides.html">Guides</a></li> + <li class="divider"></li> + <li><a href="/maven/struts2-core/apidocs/index.html">Struts Core API</a></li> + <li><a href="/docs/plugins.html">Plugin APIs</a></li> + <li><a href="/docs/tag-reference.html">Tag reference</a></li> + <li><a href="http://cwiki.apache.org/S2PLUGINS/home.html";>Plugin registry</a></li> + <li class="divider"></li> + <li><a href="/core-developers/">Core Developers Guide (WIP)</a></li> + <li><a href="/plugins/">Plugins (WIP)</a></li> + </ul> + </li> + <li class="dropdown"> + <a data-toggle="dropdown" href="#" class="dropdown-toggle"> + Contributing<b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="/youatstruts.html">You at Struts</a></li> + <li><a href="/helping.html">How to Help FAQ</a></li> + <li><a href="/dev-mail.html">Development Lists</a></li> + <li class="divider"></li> + <li><a href="/submitting-patches.html">Submitting patches</a></li> + <li><a href="/builds.html">Source Code</a></li> + <li><a href="/coding-standards.html">Coding standards</a></li> + <li class="divider"></li> + <li><a href="/releases.html">Release Guidelines</a></li> + <li><a href="/bylaws.html">PMC Charter</a></li> + <li><a href="/volunteers.html">Volunteers</a></li> + <li><a href="https://git-wip-us.apache.org/repos/asf?p=struts.git";>Source Repository</a></li> + </ul> + </li> + <li class="apache"><a href="http://www.apache.org/";><img src="/img/apache.png"></a></li> + </ul> + </div> + </div> + </div> + </nav> +</header> + + +<article class="container"> + <section class="col-md-12"> + <a href="index.html" title="back to Core Developers Guide"><< back to Core Developers Guide</a> + <a class="edit-on-gh" href="https://github.com/apache/struts-site/edit/master/source/core-developers/default-properties.md"; title="Edit this page on GitHub">Edit on GitHub</a> + <h1 id="defaultproperties">default.properties</h1> + +<blockquote> + <p>All properties can also be set using <a href="constant-configuration.html">Constant Configuration</a> in an XML configuration file.</p> +</blockquote> + +<p>The framework uses a number of properties that can be changed to fit your needs. To change any of these properties, +specify the property key and value in an <code class="highlighter-rouge">default.properties</code> file. The properties file can be locate anywhere +on the classpath, but it is typically found under <code class="highlighter-rouge">/WEB-INF/classes</code>.</p> + +<p>The list of properties can be found in <code class="highlighter-rouge">default.properties</code> (inside <code class="highlighter-rouge">struts2-core.jar</code>).</p> + +<p><strong>default.properties</strong></p> + +<figure class="highlight"><pre><code class="language-txt" data-lang="txt"># +# $Id$ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +### START SNIPPET: complete_file + +### Struts default properties +###(can be overridden by a struts.properties file in the root of the classpath) +### + +### This can be used to set your default locale and encoding scheme +# struts.locale=en_US +struts.i18n.encoding=UTF-8 + +### if specified, the default object factory can be overridden here +### Note: short-hand notation is supported in some cases, such as "spring" +### Alternatively, you can provide a com.opensymphony.xwork2.ObjectFactory subclass name here +# struts.objectFactory = spring + +### specifies the autoWiring logic when using the SpringObjectFactory. +### valid values are: name, type, auto, and constructor (name is the default) +struts.objectFactory.spring.autoWire = name + +### indicates to the struts-spring integration if Class instances should be cached +### this should, until a future Spring release makes it possible, be left as true +### unless you know exactly what you are doing! +### valid values are: true, false (true is the default) +struts.objectFactory.spring.useClassCache = true + +### ensures the autowire strategy is always respected. +### valid values are: true, false (false is the default) +struts.objectFactory.spring.autoWire.alwaysRespect = false + +### By default SpringObjectFactory doesn't support AOP +### This flag was added just temporally to check if nothing is broken +### See https://issues.apache.org/jira/browse/WW-4110 +struts.objectFactory.spring.enableAopSupport = false + +### if specified, the default object type determiner can be overridden here +### Note: short-hand notation is supported in some cases, such as "tiger" or "notiger" +### Alternatively, you can provide a com.opensymphony.xwork2.util.ObjectTypeDeterminer implementation name here +### Note: By default, com.opensymphony.xwork2.util.DefaultObjectTypeDeterminer is used which handles type detection +### using generics. com.opensymphony.xwork2.util.GenericsObjectTypeDeterminer was deprecated since XWork 2, it's +### functions are integrated in DefaultObjectTypeDeterminer now. +### To disable tiger support use the "notiger" property value here. +#struts.objectTypeDeterminer = tiger +#struts.objectTypeDeterminer = notiger + +### Parser to handle HTTP POST requests, encoded using the MIME-type multipart/form-data +# struts.multipart.parser=cos +# struts.multipart.parser=pell +# struts.multipart.parser=jakarta-stream +struts.multipart.parser=jakarta +# uses javax.servlet.context.tempdir by default +struts.multipart.saveDir= +struts.multipart.maxSize=2097152 + +### Load custom property files (does not override struts.properties!) +# struts.custom.properties=application,org/apache/struts2/extension/custom + +### How request URLs are mapped to and from actions +#struts.mapper.class=org.apache.struts2.dispatcher.mapper.DefaultActionMapper + +### Used by the DefaultActionMapper +### You may provide a comma separated list, e.g. struts.action.extension=action,jnlp,do +### The blank extension allows you to match directory listings as well as pure action names +### without interfering with static resources, which can be specified as an empty string +### prior to a comma e.g. struts.action.extension=, or struts.action.extension=x,y,z,, +struts.action.extension=action,, + +### Used by FilterDispatcher +### If true then Struts serves static content from inside its jar. +### If false then the static content must be available at <context_path>/struts +struts.serve.static=true + +### Used by FilterDispatcher +### This is good for development where one wants changes to the static content be +### fetch on each request. +### NOTE: This will only have effect if struts.serve.static=true +### If true -> Struts will write out header for static contents such that they will +### be cached by web browsers (using Date, Cache-Content, Pragma, Expires) +### headers). +### If false -> Struts will write out header for static contents such that they are +### NOT to be cached by web browser (using Cache-Content, Pragma, Expires +### headers) +struts.serve.static.browserCache=true + +### Set this to false if you wish to disable implicit dynamic method invocation +### via the URL request. This includes URLs like foo!bar.action, as well as params +### like method:bar (but not action:foo). +### An alternative to implicit dynamic method invocation is to use wildcard +### mappings, such as <action name="*/*" method="{2}" class="actions.{1}"> +struts.enable.DynamicMethodInvocation = false + +### Set this to true if you wish to allow slashes in your action names. If false, +### Actions names cannot have slashes, and will be accessible via any directory +### prefix. This is the traditional behavior expected of WebWork applications. +### Setting to true is useful when you want to use wildcards and store values +### in the URL, to be extracted by wildcard patterns, such as +### <action name="*/*" method="{2}" class="actions.{1}"> to match "/foo/edit" or +### "/foo/save". +struts.enable.SlashesInActionNames = false + +### Disables support for action: prefix +struts.mapper.action.prefix.enabled = false + +### Blocks access to actions in other namespace than current with action: prefix +struts.mapper.action.prefix.crossNamespaces = false + +### use alternative syntax that requires %{} in most places +### to evaluate expressions for String attributes for tags +struts.tag.altSyntax=true + +### when set to true, Struts will act much more friendly for developers. This +### includes: +### - struts.i18n.reload = true +### - struts.configuration.xml.reload = true +### - raising various debug or ignorable problems to errors +### For example: normally a request to foo.action?someUnknownField=true should +### be ignored (given that any value can come from the web and it +### should not be trusted). However, during development, it may be +### useful to know when these errors are happening and be told of +### them right away. +struts.devMode = false + +### when set to true, resource bundles will be reloaded on _every_ request. +### this is good during development, but should never be used in production +### struts.i18n.reload=false + +### Standard UI theme +### Change this to reflect which path should be used for JSP control tag templates by default +struts.ui.theme=xhtml +struts.ui.templateDir=template +### Change this to use a different token to indicate template theme expansion +struts.ui.theme.expansion.token=~~~ +#sets the default template type. Either ftl, vm, or jsp +struts.ui.templateSuffix=ftl + +### Configuration reloading +### This will cause the configuration to reload struts.xml when it is changed +### struts.configuration.xml.reload=false + +### Location of velocity.properties file. defaults to velocity.properties +struts.velocity.configfile = velocity.properties + +### Comma separated list of VelocityContext classnames to chain to the StrutsVelocityContext +struts.velocity.contexts = + +### Location of the velocity toolbox +struts.velocity.toolboxlocation= + +### used to build URLs, such as the UrlTag +struts.url.http.port = 80 +struts.url.https.port = 443 +### possible values are: none, get or all +struts.url.includeParams = none + +### Load custom default resource bundles +# struts.custom.i18n.resources=testmessages,testmessages2 + +### workaround for some app servers that don't handle HttpServletRequest.getParameterMap() +### often used for WebLogic, Orion, and OC4J +struts.dispatcher.parametersWorkaround = false + +### configure the Freemarker Manager class to be used +### Allows user to plug-in customised Freemarker Manager if necessary +### MUST extends off org.apache.struts2.views.freemarker.FreemarkerManager +#struts.freemarker.manager.classname=org.apache.struts2.views.freemarker.FreemarkerManager + +### Enables caching of FreeMarker templates +### Has the same effect as copying the templates under WEB_APP/templates +### struts.freemarker.templatesCache=false + +### Enables caching of models on the BeanWrapper +struts.freemarker.beanwrapperCache=false + +### See the StrutsBeanWrapper javadocs for more information +struts.freemarker.wrapper.altMap=true + +### maxStrongSize for MruCacheStorage for freemarker, when set to 0 SoftCacheStorage which performs better in heavy loaded application +### check WW-3766 for more details +struts.freemarker.mru.max.strong.size=0 + +### configure the XSLTResult class to use stylesheet caching. +### Set to true for developers and false for production. +struts.xslt.nocache=false + +### Whether to always select the namespace to be everything before the last slash or not +struts.mapper.alwaysSelectFullNamespace=false + +### Whether to allow static method access in OGNL expressions or not +struts.ognl.allowStaticMethodAccess=false + +### Whether to throw a RuntimeException when a property is not found +### in an expression, or when the expression evaluation fails +struts.el.throwExceptionOnFailure=false + +### Logs as Warnings properties that are not found (very verbose) +struts.ognl.logMissingProperties=false + +### Caches parsed OGNL expressions, but can lead to memory leaks +### if the application generates a lot of different expressions +struts.ognl.enableExpressionCache=true + +### Indicates if Dispatcher should handle unexpected exceptions by calling sendError() +### or simply rethrow it as a ServletException to allow future processing by other frameworks like Spring Security +struts.handle.exception=true +### END SNIPPET: complete_file</code></pre></figure> + + + </section> +</article> + + +<footer class="container"> + <div class="col-md-12"> + Copyright © 2000-2016 <a href="http://www.apache.org/";>The Apache Software Foundation </a>. + All Rights Reserved. + </div> + <div class="col-md-12"> + Apache Struts, Struts, Apache, the Apache feather logo, and the Apache Struts project logos are + trademarks of The Apache Software Foundation. + </div> + <div class="col-md-12">Logo and website design donated by <a href="https://softwaremill.com/";>SoftwareMill</a>.</div> +</footer> + +<script>!function (d, s, id) { + var js, fjs = d.getElementsByTagName(s)[0]; + if (!d.getElementById(id)) { + js = d.createElement(s); + js.id = id; + js.src = "//platform.twitter.com/widgets.js"; + fjs.parentNode.insertBefore(js, fjs); + } +}(document, "script", "twitter-wjs");</script> +<script src="https://apis.google.com/js/platform.js"; async="async" defer="defer"></script> + +<div id="fb-root"></div> + +<script>(function (d, s, id) { + var js, fjs = d.getElementsByTagName(s)[0]; + if (d.getElementById(id)) return; + js = d.createElement(s); + js.id = id; + js.src = "//connect.facebook.net/en_GB/all.js#xfbml=1"; + fjs.parentNode.insertBefore(js, fjs); +}(document, 'script', 'facebook-jssdk'));</script> + + +<script> +$(function() { + return $("h2, h3, h4, h5, h6").each(function(i, el) { + var $el, id; + $el = $(el); + id = $el.attr('id'); + if (id) { + $el.removeAttr('id'); + return $el.before($("<a />").addClass('anchor').attr('name', id)); + } + }); +}); +</script> + +</body> +</html> http://git-wip-us.apache.org/repos/asf/struts-site/blob/1b9b67fa/content/core-developers/struts-xml.html ---------------------------------------------------------------------- diff --git a/content/core-developers/struts-xml.html b/content/core-developers/struts-xml.html index 1f5e76d..b6086e1 100644 --- a/content/core-developers/struts-xml.html +++ b/content/core-developers/struts-xml.html @@ -127,34 +127,15 @@ <a class="edit-on-gh" href="https://github.com/apache/struts-site/edit/master/source/core-developers/struts-xml.md"; title="Edit this page on GitHub">Edit on GitHub</a> <h1 id="strutsxml">struts.xml</h1> -<p>The core configuration file for the framework is the default (</p> - -<div class="highlighter-rouge"><pre class="highlight"><code>struts.xml -</code></pre> -</div> -<p>) file and should reside on the classpath of the webapp (generally</p> - -<div class="highlighter-rouge"><pre class="highlight"><code>/WEB-INF/classes -</code></pre> -</div> -<p>).</p> - -<ul> - <li> - <p>The default file may include other configuration files as needed.</p> - </li> - <li> - <p>A</p> - </li> -</ul> - -<div class="highlighter-rouge"><pre class="highlight"><code>struts-plugin.xml -</code></pre> -</div> -<p>file can be placed in a JAR and automatically plugged into an application, so that modules can be self-contained and automatically configured.</p> +<p>The core configuration file for the framework is the default (<code class="highlighter-rouge">struts.xml</code>) file and should reside on the classpath +of the webapp (generally <code class="highlighter-rouge">/WEB-INF/classes</code>).</p> <ul> - <li>In the case of Freemarker and Velocity modules, the templates can also be loaded from the classpath, so the entire module can be plugged in as a single JAR.</li> + <li>The default file may include other configuration files as needed.</li> + <li>A <code class="highlighter-rouge">struts-plugin.xml</code> file can be placed in a JAR and automatically plugged into an application, so that modules +can be self-contained and automatically configured.</li> + <li>In the case of Freemarker and Velocity modules, the templates can also be loaded from the classpath, so the entire +module can be plugged in as a single JAR.</li> </ul> </section> http://git-wip-us.apache.org/repos/asf/struts-site/blob/1b9b67fa/content/core-developers/web-xml.html ---------------------------------------------------------------------- diff --git a/content/core-developers/web-xml.html b/content/core-developers/web-xml.html index 51e7b3f..989eaf0 100644 --- a/content/core-developers/web-xml.html +++ b/content/core-developers/web-xml.html @@ -127,221 +127,165 @@ <a class="edit-on-gh" href="https://github.com/apache/struts-site/edit/master/source/core-developers/web-xml.md"; title="Edit this page on GitHub">Edit on GitHub</a> <h1 id="webxml">web.xml</h1> -<p>The</p> +<p>The <code class="highlighter-rouge">web.xml</code> web application descriptor file represents the core of the Java web application, so it is appropriate +that it is also part of the core of the Struts framework. In the <code class="highlighter-rouge">web.xml</code> file, Struts defines its FilterDispatcher, +the Servlet Filter class that initializes the Struts framework and handles all requests. This filter can contain +initialization parameters that affect what, if any, additional configuration files are loaded and how the framework +should behave.</p> -<div class="highlighter-rouge"><pre class="highlight"><code>web.xml -</code></pre> -</div> -<p>web application descriptor file represents the core of the Java web application, so it is appropriate that it is also part of the core of the Struts framework. In the</p> - -<div class="highlighter-rouge"><pre class="highlight"><code>web.xml -</code></pre> -</div> -<p>file, Struts defines its FilterDispatcher, the Servlet Filter class that initializes the Struts framework and handles all requests. This filter can contain initialization parameters that affect what, if any, additional configuration files are loaded and how the framework should behave.</p> - -<p>####Simple Example####</p> +<h2 id="simple-example">Simple Example</h2> -<p>Configuring</p> - -<div class="highlighter-rouge"><pre class="highlight"><code>web.xml -</code></pre> -</div> -<p>for the framework is a matter of adding a filter and filter-mapping.</p> +<p>Configuring <code class="highlighter-rouge">web.xml</code> for the framework is a matter of adding a filter and filter-mapping.</p> <p><strong>Filter Example (web.xml)</strong></p> -<div class="highlighter-rouge"><pre class="highlight"><code><web-app id="MyStrutsApp" version="2.4" - xmlns="http://java.sun.com/xml/ns/j2ee"; - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; - xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"> +<div class="highlighter-rouge"><pre class="highlight"><code><span class="nt"><web-app</span> <span class="na">id=</span><span class="s">"MyStrutsApp"</span> <span class="na">version=</span><span class="s">"2.4"</span> + <span class="na">xmlns=</span><span class="s">"http://java.sun.com/xml/ns/j2ee";</span> + <span class="na">xmlns:xsi=</span><span class="s">"http://www.w3.org/2001/XMLSchema-instance";</span> + <span class="na">xsi:schemaLocation=</span><span class="s">"http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd";</span><span class="nt">></span> - <filter> - <filter-name>struts2</filter-name> - <filter-class>org.apache.struts2.dispatcher.filter.StrutsPrepareAndExecuteFilter</filter-class> - </filter> + <span class="nt"><filter></span> + <span class="nt"><filter-name></span>struts2<span class="nt"></filter-name></span> + <span class="nt"><filter-class></span>org.apache.struts2.dispatcher.filter.StrutsPrepareAndExecuteFilter<span class="nt"></filter-class></span> + <span class="nt"></filter></span> - <filter-mapping> - <filter-name>struts2</filter-name> - <url-pattern>/*</url-pattern> - </filter-mapping> + <span class="nt"><filter-mapping></span> + <span class="nt"><filter-name></span>struts2<span class="nt"></filter-name></span> + <span class="nt"><url-pattern></span>/*<span class="nt"></url-pattern></span> + <span class="nt"></filter-mapping></span> - <!-- ... --> - -</web-app> + <span class="c"><!-- ... --></span> +<span class="nt"></web-app></span> </code></pre> </div> -<p>#####Changed filter package in Struts >= 2.5#####</p> +<h2 id="changed-filter-package-in-struts--25">Changed filter package in Struts >= 2.5</h2> -<p>As from Struts 2.5 all filters were moved to top package, if you are using older version you must use the old package, see example:</p> +<p>As from Struts 2.5 all filters were moved to top package, if you are using older version you must use the old package, +see example:</p> -<div class="highlighter-rouge"><pre class="highlight"><code><web-app id="WebApp_9" version="2.4" - xmlns="http://java.sun.com/xml/ns/j2ee"; - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; - xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"> +<div class="highlighter-rouge"><pre class="highlight"><code><span class="nt"><web-app</span> <span class="na">id=</span><span class="s">"WebApp_9"</span> <span class="na">version=</span><span class="s">"2.4"</span> + <span class="na">xmlns=</span><span class="s">"http://java.sun.com/xml/ns/j2ee";</span> + <span class="na">xmlns:xsi=</span><span class="s">"http://www.w3.org/2001/XMLSchema-instance";</span> + <span class="na">xsi:schemaLocation=</span><span class="s">"http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd";</span><span class="nt">></span> - <filter> - <filter-name>struts2</filter-name> - <filter-class>org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter</filter-class> + <span class="nt"><filter></span> + <span class="nt"><filter-name></span>struts2<span class="nt"></filter-name></span> + <span class="nt"><filter-class></span>org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter<span class="nt"></filter-class></span> ... </code></pre> </div> -<p>#####Changed Filter Structure in Struts >= 2.1.3#####</p> +<h2 id="changed-filter-structure-in-struts--213">Changed Filter Structure in Struts >= 2.1.3</h2> -<p>To split up the the dispatcher phases, FilterDispatcher is deprecated since Struts 2.1.3. If working with older versions, you need to use</p> +<p>To split up the the dispatcher phases, FilterDispatcher is deprecated since Struts 2.1.3. If working with older +versions, you need to use</p> <div class="highlighter-rouge"><pre class="highlight"><code> ... - <filter> - <filter-name>struts2</filter-name> - <filter-class>org.apache.struts2.dispatcher.FilterDispatcher</filter-class> + <span class="nt"><filter></span> + <span class="nt"><filter-name></span>struts2<span class="nt"></filter-name></span> + <span class="nt"><filter-class></span>org.apache.struts2.dispatcher.FilterDispatcher<span class="nt"></filter-class></span> ... - </code></pre> </div> -<p>See <em>SiteMesh Plugin</em> for an example on when to use seperate Filters for prepare and execution phase</p> +<p>See <a href="../plugins/sitemesh-plugin.html">SiteMesh Plugin</a> for an example on when to use seperate Filters for prepare +and execution phase</p> -<p>#####Exclude specific URLs#####</p> +<h2 id="exclude-specific-urls">Exclude specific URLs</h2> -<p>In the example above weâve mapped the Struts 2 dispatcher to</p> +<p>In the example above weâve mapped the Struts 2 dispatcher to <code class="highlighter-rouge">/*</code>, so Struts 2 has a crack at all incoming requests. +This is because Struts 2 serves static content from its jar files, including Dojo JavaScript files (if using S2.0, +or the Dojo plugin in S2.1+) and FreeMarker templates for the Struts 2 tags that produce HTML.</p> -<div class="highlighter-rouge"><pre class="highlight"><code>/* -</code></pre> -</div> -<p>, so Struts 2 has a crack at all incoming requests. This is because Struts 2 serves static content from its jar files, including Dojo JavaScript files (if using S2.0, or the Dojo plugin in S2.1+) and FreeMarker templates for the Struts 2 tags that produce HTML.</p> - -<p>If we change the filter mapping to something else, for example</p> - -<div class="highlighter-rouge"><pre class="highlight"><code>/*.html -</code></pre> -</div> -<p>, we must take this in to account and extract the content that would normally be served from the Struts 2 jar files, or some other solution.</p> - -<p>Since Struts 2.1.7, you are able to provide a comma seperated list of patterns for which when matching against the - request URL the Filter will just pass by. This is done via the configuration option struts.action.excludePattern, for example in your struts.xml</p> +<p>If we change the filter mapping to something else, for example <code class="highlighter-rouge">/*.html</code>, we must take this in to account and extract +the content that would normally be served from the Struts 2 jar files, or some other solution.</p> -<p> </p> +<p>Since Struts 2.1.7, you are able to provide a comma separated list of patterns for which when matching against +the request URL the Filter will just pass by. This is done via the configuration option struts.action.excludePattern, +for example in your struts.xml:</p> -<div class="highlighter-rouge"><pre class="highlight"><code><struts> - <constant name="struts.action.excludePattern" value=".*unfiltered.*,.*\\.nofilter"/> +<div class="highlighter-rouge"><pre class="highlight"><code><span class="nt"><struts></span> + <span class="nt"><constant</span> <span class="na">name=</span><span class="s">"struts.action.excludePattern"</span> <span class="na">value=</span><span class="s">".*unfiltered.*,.*\.nofilter"</span><span class="nt">/></span> ... -</struts> +<span class="nt"></struts></span> </code></pre> </div> -<p>####Taglib Example####</p> +<h2 id="taglib-example">Taglib Example</h2> -<p>Typically, configuring a taglib is neither required nor recommended. The taglib is included in</p> +<p>Typically, configuring a taglib is neither required nor recommended. The taglib is included in <code class="highlighter-rouge">struts-core.jar</code>, and +the container will discover it automatically.</p> -<div class="highlighter-rouge"><pre class="highlight"><code>struts-core.jar -</code></pre> -</div> -<p>, and the container will discover it automatically.</p> +<blockquote> + <p>If, for some reason, a taglib configuration is needed within web.xml, extract the TLD file from the <code class="highlighter-rouge">struts-core.jar</code> +<code class="highlighter-rouge">META-INF</code> folder, and add a <code class="highlighter-rouge">taglib</code> element to the <code class="highlighter-rouge">web.xml</code>.</p> +</blockquote> -<p>(ok) If, for some reason, a taglib configuration is needed within web.xml, extract the TLD file from the</p> +<div class="highlighter-rouge"><pre class="highlight"><code> <span class="c"><!-- ... --></span> + <span class="nt"></welcome-file-list></span> -<div class="highlighter-rouge"><pre class="highlight"><code>struts-core.jar + <span class="nt"><taglib></span> + <span class="nt"><taglib-uri></span>/s<span class="nt"></taglib-uri></span> + <span class="nt"><taglib-location></span>/WEB-INF/struts-tags.tld<span class="nt"></taglib-location></span> + <span class="nt"></taglib></span> +<span class="nt"></web-app></span> </code></pre> </div> -<div class="highlighter-rouge"><pre class="highlight"><code>META-INF -</code></pre> -</div> -<p>folder, and add a</p> +<h2 id="custom-filemanager-and-filemanagerfactory-implementations">Custom FileManager and FileManagerFactory implementations</h2> -<div class="highlighter-rouge"><pre class="highlight"><code>taglib -</code></pre> -</div> -<p>element to the</p> - -<div class="highlighter-rouge"><pre class="highlight"><code>web.xml -</code></pre> -</div> -<p>.</p> - -<div class="highlighter-rouge"><pre class="highlight"><code> <!-- ... --> - </welcome-file-list> - - <taglib> - <taglib-uri>/s</taglib-uri> - <taglib-location>/WEB-INF/struts-tags.tld</taglib-location> - </taglib> -</web-app> - -</code></pre> -</div> - -<p>####Custom FileManager and FileManagerFactory implementations####</p> - -<p>If there is a need to support an App Serverâs specific file system (eg. VFS in JBoss), you can implement your own version of FileManager. But it must be registered at âthe beginningâ to support bootstrap of the whole framework.</p> +<p>If there is a need to support an App Serverâs specific file system (eg. VFS in JBoss), you can implement your own +version of FileManager. But it must be registered at âthe beginningâ to support bootstrap of the whole framework.</p> -<p>To register your own FileManger you can do it with <init-param/> as below:</p> - -<div class="highlighter-rouge"><pre class="highlight"><code><filter> - <filter-name>struts2</filter-name> - <filter-class>org.apache.struts2.dispatcher.filter.StrutsPrepareAndExecuteFilter</filter-class> - <init-param> - <param-name>struts.fileManager</param-name> - <param-value>com.company.MyFileManager</param-value> - </init-param> -</filter> +<p>To register your own FileManger you can do it with <code class="highlighter-rouge"><init-param/></code> as below:</p> +<div class="highlighter-rouge"><pre class="highlight"><code><span class="nt"><filter></span> + <span class="nt"><filter-name></span>struts2<span class="nt"></filter-name></span> + <span class="nt"><filter-class></span>org.apache.struts2.dispatcher.filter.StrutsPrepareAndExecuteFilter<span class="nt"></filter-class></span> + <span class="nt"><init-param></span> + <span class="nt"><param-name></span>struts.fileManager<span class="nt"></param-name></span> + <span class="nt"><param-value></span>com.company.MyFileManager<span class="nt"></param-value></span> + <span class="nt"></init-param></span> +<span class="nt"></filter></span> </code></pre> </div> -<p>You can as well register your own FileManagerFactory with <init-param/>, see example:</p> - -<div class="highlighter-rouge"><pre class="highlight"><code><filter> - <filter-name>struts2</filter-name> - <filter-class>org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter</filter-class> - <init-param> - <param-name>struts.fileManagerFactory</param-name> - <param-value>com.company.MyFileManagerFactory</param-value> - </init-param> -</filter> +<p>You can as well register your own FileManagerFactory with <code class="highlighter-rouge"><init-param/></code>, see example:</p> +<div class="highlighter-rouge"><pre class="highlight"><code><span class="nt"><filter></span> + <span class="nt"><filter-name></span>struts2<span class="nt"></filter-name></span> + <span class="nt"><filter-class></span>org.apache.struts2.dispatcher.filter.StrutsPrepareAndExecuteFilter<span class="nt"></filter-class></span> + <span class="nt"><init-param></span> + <span class="nt"><param-name></span>struts.fileManagerFactory<span class="nt"></param-name></span> + <span class="nt"><param-value></span>com.company.MyFileManagerFactory<span class="nt"></param-value></span> + <span class="nt"></init-param></span> +<span class="nt"></filter></span> </code></pre> </div> -<p>Take a look on default implementations - DefaultFileManager.java and DefaultFileManagerFactory.java to understand how and why.</p> - -<p>####Custom configuration provider####</p> +<p>Take a look on default implementations - <code class="highlighter-rouge">DefaultFileManager.java</code> and <code class="highlighter-rouge">DefaultFileManagerFactory.java</code> to understand how and why.</p> -<p>It is possible to use your custom </p> +<h2 id="custom-configuration-provider">Custom configuration provider</h2> -<div class="highlighter-rouge"><pre class="highlight"><code>ConfigurationProvider -</code></pre> -</div> -<p>to programmatically configure your application. To do this use </p> +<p>It is possible to use your custom <code class="highlighter-rouge">ConfigurationProvider</code> to programmatically configure your application. To do this use +<code class="highlighter-rouge">configProviders</code> (it can be a comma-separated list of class names) <code class="highlighter-rouge"><init-param/></code> as below:</p> -<div class="highlighter-rouge"><pre class="highlight"><code>configProviders -</code></pre> -</div> -<p> (it can be a comma-separated list of class names) </p> - -<div class="highlighter-rouge"><pre class="highlight"><code><init-param/> -</code></pre> -</div> -<p> as below:</p> - -<div class="highlighter-rouge"><pre class="highlight"><code><filter> - <filter-name>struts2</filter-name> - <filter-class>org.apache.struts2.dispatcher.filter.StrutsPrepareAndExecuteFilter</filter-class> - <init-param> - <param-name>configProviders</param-name> - <param-value>com.company.MyConfigurationProvider</param-value> - </init-param> -</filter> +<div class="highlighter-rouge"><pre class="highlight"><code><span class="nt"><filter></span> + <span class="nt"><filter-name></span>struts2<span class="nt"></filter-name></span> + <span class="nt"><filter-class></span>org.apache.struts2.dispatcher.filter.StrutsPrepareAndExecuteFilter<span class="nt"></filter-class></span> + <span class="nt"><init-param></span> + <span class="nt"><param-name></span>configProviders<span class="nt"></param-name></span> + <span class="nt"><param-value></span>com.company.MyConfigurationProvider<span class="nt"></param-value></span> + <span class="nt"></init-param></span> +<span class="nt"></filter></span> </code></pre> </div> <p>See <a href="configuration-provider-and-configuration.html">Configuration Provider & Configuration</a> for more details.</p> -<p> </p> - </section> </article>
![https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png"](https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png"){kind=link}