From 19aaa292941c5e3256122d300438a2df7b04a6ae Mon Sep 17 00:00:00 2001 From: tdferreira <49493150+tdferreira@users.noreply.github.com> Date: Tue, 22 Oct 2024 23:36:46 +0200 Subject: [PATCH 1/5] Rename tiles2 to tiles3 --- pom.xml | 32 ++---------------- {tiles2 => tiles3}/pom.xml | 18 ++++++++-- .../tiles3}/RedeployableActionServlet.java | 2 +- .../apache/struts/tiles3}/TilesPlugin.java | 2 +- .../struts/tiles3}/TilesPluginContainer.java | 2 +- .../tiles3}/TilesPluginContainerFactory.java | 2 +- .../struts/tiles3}/TilesRequestProcessor.java | 2 +- .../actions/DefinitionDispatcherAction.java | 0 .../actions/ReloadDefinitionsAction.java | 0 .../struts/tiles3}/actions/TilesAction.java | 0 .../tiles3}/commands/TilesPreProcessor.java | 0 .../struts/tiles3}/doc-files/image001.png | Bin .../struts/tiles3}/doc-files/tilesUML.png | Bin .../apache/struts/tiles3}/package-info.java | 0 .../tiles3}/preparer/ActionPreparer.java | 0 .../preparer/StrutsPreparerFactory.java | 0 .../struts/tiles3}/preparer/UrlPreparer.java | 0 .../util/PlugInConfigContextAdapter.java | 0 .../src/main/resources/LICENSE.txt | 0 .../src/main/resources/NOTICE.txt | 0 .../apache/struts/tiles3}/chain-config.xml | 4 +-- {tiles2 => tiles3}/src/site/fml/faq.fml | 0 .../site/resources/images/struts-power.gif | Bin {tiles2 => tiles3}/src/site/site.xml | 0 {tiles2 => tiles3}/src/site/xdoc/examples.xml | 0 {tiles2 => tiles3}/src/site/xdoc/index.xml | 0 .../src/site/xdoc/installation.xml | 0 .../src/site/xdoc/userGuide.xml | 0 .../struts/tiles3}/TestTilesPlugin.java | 6 ++-- .../struts/tiles3}/config/tiles-defs.xml | 4 +-- 30 files changed, 29 insertions(+), 45 deletions(-) rename {tiles2 => tiles3}/pom.xml (86%) rename {tiles2/src/main/java/org/apache/struts/tiles2 => tiles3/src/main/java/org/apache/struts/tiles3}/RedeployableActionServlet.java (98%) rename {tiles2/src/main/java/org/apache/struts/tiles2 => tiles3/src/main/java/org/apache/struts/tiles3}/TilesPlugin.java (99%) rename {tiles2/src/main/java/org/apache/struts/tiles2 => tiles3/src/main/java/org/apache/struts/tiles3}/TilesPluginContainer.java (99%) rename {tiles2/src/main/java/org/apache/struts/tiles2 => tiles3/src/main/java/org/apache/struts/tiles3}/TilesPluginContainerFactory.java (99%) rename {tiles2/src/main/java/org/apache/struts/tiles2 => tiles3/src/main/java/org/apache/struts/tiles3}/TilesRequestProcessor.java (99%) rename {tiles2/src/main/java/org/apache/struts/tiles2 => tiles3/src/main/java/org/apache/struts/tiles3}/actions/DefinitionDispatcherAction.java (100%) rename {tiles2/src/main/java/org/apache/struts/tiles2 => tiles3/src/main/java/org/apache/struts/tiles3}/actions/ReloadDefinitionsAction.java (100%) rename {tiles2/src/main/java/org/apache/struts/tiles2 => tiles3/src/main/java/org/apache/struts/tiles3}/actions/TilesAction.java (100%) rename {tiles2/src/main/java/org/apache/struts/tiles2 => tiles3/src/main/java/org/apache/struts/tiles3}/commands/TilesPreProcessor.java (100%) rename {tiles2/src/main/java/org/apache/struts/tiles2 => tiles3/src/main/java/org/apache/struts/tiles3}/doc-files/image001.png (100%) rename {tiles2/src/main/java/org/apache/struts/tiles2 => tiles3/src/main/java/org/apache/struts/tiles3}/doc-files/tilesUML.png (100%) rename {tiles2/src/main/java/org/apache/struts/tiles2 => tiles3/src/main/java/org/apache/struts/tiles3}/package-info.java (100%) rename {tiles2/src/main/java/org/apache/struts/tiles2 => tiles3/src/main/java/org/apache/struts/tiles3}/preparer/ActionPreparer.java (100%) rename {tiles2/src/main/java/org/apache/struts/tiles2 => tiles3/src/main/java/org/apache/struts/tiles3}/preparer/StrutsPreparerFactory.java (100%) rename {tiles2/src/main/java/org/apache/struts/tiles2 => tiles3/src/main/java/org/apache/struts/tiles3}/preparer/UrlPreparer.java (100%) rename {tiles2/src/main/java/org/apache/struts/tiles2 => tiles3/src/main/java/org/apache/struts/tiles3}/util/PlugInConfigContextAdapter.java (100%) rename {tiles2 => tiles3}/src/main/resources/LICENSE.txt (100%) rename {tiles2 => tiles3}/src/main/resources/NOTICE.txt (100%) rename {tiles2/src/main/resources/org/apache/struts/tiles2 => tiles3/src/main/resources/org/apache/struts/tiles3}/chain-config.xml (98%) rename {tiles2 => tiles3}/src/site/fml/faq.fml (100%) rename {tiles2 => tiles3}/src/site/resources/images/struts-power.gif (100%) rename {tiles2 => tiles3}/src/site/site.xml (100%) rename {tiles2 => tiles3}/src/site/xdoc/examples.xml (100%) rename {tiles2 => tiles3}/src/site/xdoc/index.xml (100%) rename {tiles2 => tiles3}/src/site/xdoc/installation.xml (100%) rename {tiles2 => tiles3}/src/site/xdoc/userGuide.xml (100%) rename {tiles2/src/test/java/org/apache/struts/tiles2 => tiles3/src/test/java/org/apache/struts/tiles3}/TestTilesPlugin.java (98%) rename {tiles2/src/test/resources/org/apache/struts/tiles2 => tiles3/src/test/resources/org/apache/struts/tiles3}/config/tiles-defs.xml (97%) diff --git a/pom.xml b/pom.xml index 67dc514c2..bcb6d4ce0 100644 --- a/pom.xml +++ b/pom.xml @@ -382,8 +382,6 @@ 4.0.15 4.15.0 2.0.9 - 3.0.8 - 1.0.7 4.13.1 4.0.4 2.3.6 @@ -518,7 +516,7 @@ scripting taglib tiles - tiles2 + tiles3 @@ -1156,32 +1154,6 @@ groovy-jsr223 ${groovyVersion} - - org.apache.tiles - tiles-api - ${tilesVersion} - - - org.apache.tiles - tiles-core - ${tilesVersion} - - - org.slf4j - jcl-over-slf4j - - - - - org.apache.tiles - tiles-request-api - ${tilesRequestVersion} - - - org.apache.tiles - tiles-request-servlet - ${tilesRequestVersion} - ${project.groupId} struts-blank @@ -1275,7 +1247,7 @@ ${project.groupId} - struts-tiles2 + struts-tiles3 ${project.version} diff --git a/tiles2/pom.xml b/tiles3/pom.xml similarity index 86% rename from tiles2/pom.xml rename to tiles3/pom.xml index e44973448..aedbb82fc 100644 --- a/tiles2/pom.xml +++ b/tiles3/pom.xml @@ -29,12 +29,14 @@ 4.0.0 - struts-tiles2 + struts-tiles3 jar - Struts Tiles 2 integration + Struts Tiles 3 integration - org.apache.struts.tiles2 + org.apache.struts.tiles3 + 3.0.8 + 1.0.7 @@ -60,18 +62,28 @@ org.apache.tiles tiles-api + ${tiles3Version} org.apache.tiles tiles-core + ${tiles3Version} + + + org.slf4j + jcl-over-slf4j + + org.apache.tiles tiles-request-api + ${tilesRequestVersion} org.apache.tiles tiles-request-servlet + ${tilesRequestVersion} commons-beanutils diff --git a/tiles2/src/main/java/org/apache/struts/tiles2/RedeployableActionServlet.java b/tiles3/src/main/java/org/apache/struts/tiles3/RedeployableActionServlet.java similarity index 98% rename from tiles2/src/main/java/org/apache/struts/tiles2/RedeployableActionServlet.java rename to tiles3/src/main/java/org/apache/struts/tiles3/RedeployableActionServlet.java index 0a9ddc661..fb8f61e6b 100644 --- a/tiles2/src/main/java/org/apache/struts/tiles2/RedeployableActionServlet.java +++ b/tiles3/src/main/java/org/apache/struts/tiles3/RedeployableActionServlet.java @@ -18,7 +18,7 @@ * specific language governing permissions and limitations * under the License. */ -package org.apache.struts.tiles2; +package org.apache.struts.tiles3; import javax.servlet.ServletException; diff --git a/tiles2/src/main/java/org/apache/struts/tiles2/TilesPlugin.java b/tiles3/src/main/java/org/apache/struts/tiles3/TilesPlugin.java similarity index 99% rename from tiles2/src/main/java/org/apache/struts/tiles2/TilesPlugin.java rename to tiles3/src/main/java/org/apache/struts/tiles3/TilesPlugin.java index 7c7a7bfd9..e0c5bcdfa 100644 --- a/tiles2/src/main/java/org/apache/struts/tiles2/TilesPlugin.java +++ b/tiles3/src/main/java/org/apache/struts/tiles3/TilesPlugin.java @@ -19,7 +19,7 @@ * under the License. */ -package org.apache.struts.tiles2; +package org.apache.struts.tiles3; import javax.servlet.ServletException; diff --git a/tiles2/src/main/java/org/apache/struts/tiles2/TilesPluginContainer.java b/tiles3/src/main/java/org/apache/struts/tiles3/TilesPluginContainer.java similarity index 99% rename from tiles2/src/main/java/org/apache/struts/tiles2/TilesPluginContainer.java rename to tiles3/src/main/java/org/apache/struts/tiles3/TilesPluginContainer.java index e97751ba8..20c20afc7 100644 --- a/tiles2/src/main/java/org/apache/struts/tiles2/TilesPluginContainer.java +++ b/tiles3/src/main/java/org/apache/struts/tiles3/TilesPluginContainer.java @@ -19,7 +19,7 @@ * under the License. */ -package org.apache.struts.tiles2; +package org.apache.struts.tiles3; import java.util.HashMap; import java.util.Map; diff --git a/tiles2/src/main/java/org/apache/struts/tiles2/TilesPluginContainerFactory.java b/tiles3/src/main/java/org/apache/struts/tiles3/TilesPluginContainerFactory.java similarity index 99% rename from tiles2/src/main/java/org/apache/struts/tiles2/TilesPluginContainerFactory.java rename to tiles3/src/main/java/org/apache/struts/tiles3/TilesPluginContainerFactory.java index de5340c47..ab734aff4 100644 --- a/tiles2/src/main/java/org/apache/struts/tiles2/TilesPluginContainerFactory.java +++ b/tiles3/src/main/java/org/apache/struts/tiles3/TilesPluginContainerFactory.java @@ -19,7 +19,7 @@ * under the License. */ -package org.apache.struts.tiles2; +package org.apache.struts.tiles3; import java.util.Collections; import java.util.List; diff --git a/tiles2/src/main/java/org/apache/struts/tiles2/TilesRequestProcessor.java b/tiles3/src/main/java/org/apache/struts/tiles3/TilesRequestProcessor.java similarity index 99% rename from tiles2/src/main/java/org/apache/struts/tiles2/TilesRequestProcessor.java rename to tiles3/src/main/java/org/apache/struts/tiles3/TilesRequestProcessor.java index c470fed04..19f78fcd1 100644 --- a/tiles2/src/main/java/org/apache/struts/tiles2/TilesRequestProcessor.java +++ b/tiles3/src/main/java/org/apache/struts/tiles3/TilesRequestProcessor.java @@ -18,7 +18,7 @@ * specific language governing permissions and limitations * under the License. */ -package org.apache.struts.tiles2; +package org.apache.struts.tiles3; import java.io.IOException; diff --git a/tiles2/src/main/java/org/apache/struts/tiles2/actions/DefinitionDispatcherAction.java b/tiles3/src/main/java/org/apache/struts/tiles3/actions/DefinitionDispatcherAction.java similarity index 100% rename from tiles2/src/main/java/org/apache/struts/tiles2/actions/DefinitionDispatcherAction.java rename to tiles3/src/main/java/org/apache/struts/tiles3/actions/DefinitionDispatcherAction.java diff --git a/tiles2/src/main/java/org/apache/struts/tiles2/actions/ReloadDefinitionsAction.java b/tiles3/src/main/java/org/apache/struts/tiles3/actions/ReloadDefinitionsAction.java similarity index 100% rename from tiles2/src/main/java/org/apache/struts/tiles2/actions/ReloadDefinitionsAction.java rename to tiles3/src/main/java/org/apache/struts/tiles3/actions/ReloadDefinitionsAction.java diff --git a/tiles2/src/main/java/org/apache/struts/tiles2/actions/TilesAction.java b/tiles3/src/main/java/org/apache/struts/tiles3/actions/TilesAction.java similarity index 100% rename from tiles2/src/main/java/org/apache/struts/tiles2/actions/TilesAction.java rename to tiles3/src/main/java/org/apache/struts/tiles3/actions/TilesAction.java diff --git a/tiles2/src/main/java/org/apache/struts/tiles2/commands/TilesPreProcessor.java b/tiles3/src/main/java/org/apache/struts/tiles3/commands/TilesPreProcessor.java similarity index 100% rename from tiles2/src/main/java/org/apache/struts/tiles2/commands/TilesPreProcessor.java rename to tiles3/src/main/java/org/apache/struts/tiles3/commands/TilesPreProcessor.java diff --git a/tiles2/src/main/java/org/apache/struts/tiles2/doc-files/image001.png b/tiles3/src/main/java/org/apache/struts/tiles3/doc-files/image001.png similarity index 100% rename from tiles2/src/main/java/org/apache/struts/tiles2/doc-files/image001.png rename to tiles3/src/main/java/org/apache/struts/tiles3/doc-files/image001.png diff --git a/tiles2/src/main/java/org/apache/struts/tiles2/doc-files/tilesUML.png b/tiles3/src/main/java/org/apache/struts/tiles3/doc-files/tilesUML.png similarity index 100% rename from tiles2/src/main/java/org/apache/struts/tiles2/doc-files/tilesUML.png rename to tiles3/src/main/java/org/apache/struts/tiles3/doc-files/tilesUML.png diff --git a/tiles2/src/main/java/org/apache/struts/tiles2/package-info.java b/tiles3/src/main/java/org/apache/struts/tiles3/package-info.java similarity index 100% rename from tiles2/src/main/java/org/apache/struts/tiles2/package-info.java rename to tiles3/src/main/java/org/apache/struts/tiles3/package-info.java diff --git a/tiles2/src/main/java/org/apache/struts/tiles2/preparer/ActionPreparer.java b/tiles3/src/main/java/org/apache/struts/tiles3/preparer/ActionPreparer.java similarity index 100% rename from tiles2/src/main/java/org/apache/struts/tiles2/preparer/ActionPreparer.java rename to tiles3/src/main/java/org/apache/struts/tiles3/preparer/ActionPreparer.java diff --git a/tiles2/src/main/java/org/apache/struts/tiles2/preparer/StrutsPreparerFactory.java b/tiles3/src/main/java/org/apache/struts/tiles3/preparer/StrutsPreparerFactory.java similarity index 100% rename from tiles2/src/main/java/org/apache/struts/tiles2/preparer/StrutsPreparerFactory.java rename to tiles3/src/main/java/org/apache/struts/tiles3/preparer/StrutsPreparerFactory.java diff --git a/tiles2/src/main/java/org/apache/struts/tiles2/preparer/UrlPreparer.java b/tiles3/src/main/java/org/apache/struts/tiles3/preparer/UrlPreparer.java similarity index 100% rename from tiles2/src/main/java/org/apache/struts/tiles2/preparer/UrlPreparer.java rename to tiles3/src/main/java/org/apache/struts/tiles3/preparer/UrlPreparer.java diff --git a/tiles2/src/main/java/org/apache/struts/tiles2/util/PlugInConfigContextAdapter.java b/tiles3/src/main/java/org/apache/struts/tiles3/util/PlugInConfigContextAdapter.java similarity index 100% rename from tiles2/src/main/java/org/apache/struts/tiles2/util/PlugInConfigContextAdapter.java rename to tiles3/src/main/java/org/apache/struts/tiles3/util/PlugInConfigContextAdapter.java diff --git a/tiles2/src/main/resources/LICENSE.txt b/tiles3/src/main/resources/LICENSE.txt similarity index 100% rename from tiles2/src/main/resources/LICENSE.txt rename to tiles3/src/main/resources/LICENSE.txt diff --git a/tiles2/src/main/resources/NOTICE.txt b/tiles3/src/main/resources/NOTICE.txt similarity index 100% rename from tiles2/src/main/resources/NOTICE.txt rename to tiles3/src/main/resources/NOTICE.txt diff --git a/tiles2/src/main/resources/org/apache/struts/tiles2/chain-config.xml b/tiles3/src/main/resources/org/apache/struts/tiles3/chain-config.xml similarity index 98% rename from tiles2/src/main/resources/org/apache/struts/tiles2/chain-config.xml rename to tiles3/src/main/resources/org/apache/struts/tiles3/chain-config.xml index 7f17f824f..f5fd29fe3 100644 --- a/tiles2/src/main/resources/org/apache/struts/tiles2/chain-config.xml +++ b/tiles3/src/main/resources/org/apache/struts/tiles3/chain-config.xml @@ -212,7 +212,7 @@ className="org.apache.struts.chain.commands.ExecuteForwardCommand"/> + className="org.apache.struts.tiles3.commands.TilesPreProcessor"/> + className="org.apache.struts.tiles3.commands.TilesPreProcessor"/> + "-//Apache Software Foundation//DTD Tiles Configuration 3.0//EN" + "http://tiles.apache.org/dtds/tiles-config_3_0.dtd"> From 3ba76a772c9f1dc802fc3abac47879f8c93063c0 Mon Sep 17 00:00:00 2001 From: tdferreira <49493150+tdferreira@users.noreply.github.com> Date: Tue, 22 Oct 2024 23:39:25 +0200 Subject: [PATCH 2/5] Restore tiles2 module supporting Tiles 2.x --- pom.xml | 20 + tiles2/pom.xml | 165 +++++++ .../tiles2/RedeployableActionServlet.java | 92 ++++ .../org/apache/struts/tiles2/TilesPlugin.java | 348 ++++++++++++++ .../struts/tiles2/TilesPluginContainer.java | 156 +++++++ .../tiles2/TilesPluginContainerFactory.java | 114 +++++ .../struts/tiles2/TilesRequestProcessor.java | 262 +++++++++++ .../actions/DefinitionDispatcherAction.java | 125 +++++ .../actions/ReloadDefinitionsAction.java | 88 ++++ .../struts/tiles2/actions/TilesAction.java | 112 +++++ .../tiles2/commands/TilesPreProcessor.java | 114 +++++ .../struts/tiles2/doc-files/image001.gif | Bin 0 -> 1031 bytes .../struts/tiles2/doc-files/tilesUML.gif | Bin 0 -> 22375 bytes .../apache/struts/tiles2/package-info.java | 298 ++++++++++++ .../org/apache/struts/tiles2/package.html | 341 ++++++++++++++ .../tiles2/preparer/ActionPreparer.java | 68 +++ .../preparer/StrutsPreparerFactory.java | 55 +++ .../struts/tiles2/preparer/UrlPreparer.java | 87 ++++ .../util/PlugInConfigContextAdapter.java | 393 ++++++++++++++++ tiles2/src/main/resources/LICENSE.txt | 174 +++++++ tiles2/src/main/resources/NOTICE.txt | 10 + .../org/apache/struts/tiles2/chain-config.xml | 256 ++++++++++ tiles2/src/site/fml/faq.fml | 43 ++ .../site/resources/images/struts-power.gif | Bin 0 -> 1798 bytes tiles2/src/site/site.xml | 81 ++++ tiles2/src/site/xdoc/examples.xml | 294 ++++++++++++ tiles2/src/site/xdoc/index.xml | 166 +++++++ tiles2/src/site/xdoc/installation.xml | 114 +++++ tiles2/src/site/xdoc/userGuide.xml | 438 ++++++++++++++++++ .../apache/struts/tiles2/TestTilesPlugin.java | 296 ++++++++++++ .../struts/tiles2/config/tiles-defs.xml | 133 ++++++ 31 files changed, 4843 insertions(+) create mode 100644 tiles2/pom.xml create mode 100644 tiles2/src/main/java/org/apache/struts/tiles2/RedeployableActionServlet.java create mode 100644 tiles2/src/main/java/org/apache/struts/tiles2/TilesPlugin.java create mode 100644 tiles2/src/main/java/org/apache/struts/tiles2/TilesPluginContainer.java create mode 100644 tiles2/src/main/java/org/apache/struts/tiles2/TilesPluginContainerFactory.java create mode 100644 tiles2/src/main/java/org/apache/struts/tiles2/TilesRequestProcessor.java create mode 100644 tiles2/src/main/java/org/apache/struts/tiles2/actions/DefinitionDispatcherAction.java create mode 100644 tiles2/src/main/java/org/apache/struts/tiles2/actions/ReloadDefinitionsAction.java create mode 100644 tiles2/src/main/java/org/apache/struts/tiles2/actions/TilesAction.java create mode 100644 tiles2/src/main/java/org/apache/struts/tiles2/commands/TilesPreProcessor.java create mode 100644 tiles2/src/main/java/org/apache/struts/tiles2/doc-files/image001.gif create mode 100644 tiles2/src/main/java/org/apache/struts/tiles2/doc-files/tilesUML.gif create mode 100644 tiles2/src/main/java/org/apache/struts/tiles2/package-info.java create mode 100644 tiles2/src/main/java/org/apache/struts/tiles2/package.html create mode 100644 tiles2/src/main/java/org/apache/struts/tiles2/preparer/ActionPreparer.java create mode 100644 tiles2/src/main/java/org/apache/struts/tiles2/preparer/StrutsPreparerFactory.java create mode 100644 tiles2/src/main/java/org/apache/struts/tiles2/preparer/UrlPreparer.java create mode 100644 tiles2/src/main/java/org/apache/struts/tiles2/util/PlugInConfigContextAdapter.java create mode 100644 tiles2/src/main/resources/LICENSE.txt create mode 100644 tiles2/src/main/resources/NOTICE.txt create mode 100644 tiles2/src/main/resources/org/apache/struts/tiles2/chain-config.xml create mode 100644 tiles2/src/site/fml/faq.fml create mode 100644 tiles2/src/site/resources/images/struts-power.gif create mode 100644 tiles2/src/site/site.xml create mode 100644 tiles2/src/site/xdoc/examples.xml create mode 100644 tiles2/src/site/xdoc/index.xml create mode 100644 tiles2/src/site/xdoc/installation.xml create mode 100644 tiles2/src/site/xdoc/userGuide.xml create mode 100644 tiles2/src/test/java/org/apache/struts/tiles2/TestTilesPlugin.java create mode 100644 tiles2/src/test/resources/org/apache/struts/tiles2/config/tiles-defs.xml diff --git a/pom.xml b/pom.xml index bcb6d4ce0..ba8ef9151 100644 --- a/pom.xml +++ b/pom.xml @@ -516,6 +516,7 @@ scripting taglib tiles + tiles2 tiles3 @@ -812,6 +813,20 @@ + + org.apache.maven.plugins + maven-source-plugin + 3.3.1 + + + attach-sources + verify + + jar-no-fork + + + + @@ -1245,6 +1260,11 @@ struts-tiles ${project.version} + + ${project.groupId} + struts-tiles2 + ${project.version} + ${project.groupId} struts-tiles3 diff --git a/tiles2/pom.xml b/tiles2/pom.xml new file mode 100644 index 000000000..4c9918816 --- /dev/null +++ b/tiles2/pom.xml @@ -0,0 +1,165 @@ + + + + + + + io.github.weblegacy + struts-parent + 1.4.6-SNAPSHOT + + + 4.0.0 + struts-tiles2 + jar + Struts Tiles 2 integration + http://struts.apache.org + + + scm:svn:http://svn.apache.org/repos/asf/struts/struts1/trunk/tiles2/ + scm:svn:https://svn.apache.org/repos/asf/struts/struts1/trunk/tiles2/ + http://svn.apache.org/repos/asf/struts/struts1/trunk/tiles2/ + + + + + apache-site + scp://people.apache.org/www/struts.apache.org/1.x/struts-tiles2 + + + + + org.apache.struts.tiles2 + 2.2.2 + + + + + + src/main/resources + + + + + + src/test/java + + **/*.xml + + + + + + + + ${project.groupId} + struts-core + ${project.version} + + + ${project.groupId} + struts-core + tests + test-jar + + + jakarta.servlet + jakarta.servlet-api + + + jakarta.servlet.jsp + jakarta.servlet.jsp-api + test + + + org.apache.tiles + tiles-api + ${tiles2Version} + + + org.apache.tiles + tiles-core + ${tiles2Version} + + + org.apache.tiles + tiles-api + ${tiles2Version} + + + org.apache.tiles + tiles-servlet + ${tiles2Version} + + + commons-beanutils + commons-beanutils + + + io.github.weblegacy + commons-chain + + + org.junit.jupiter + junit-jupiter-api + + + org.slf4j + slf4j-api + + + + org.slf4j + jcl-over-slf4j + + + + + + + io.github.weblegacy + taglib-maven-plugin + + ${project.basedir}/src/main/resources/META-INF/tld + true + + + + + + + + pre-assembly + + + + maven-javadoc-plugin + + + maven-source-plugin + + + + + + + \ No newline at end of file diff --git a/tiles2/src/main/java/org/apache/struts/tiles2/RedeployableActionServlet.java b/tiles2/src/main/java/org/apache/struts/tiles2/RedeployableActionServlet.java new file mode 100644 index 000000000..be59be509 --- /dev/null +++ b/tiles2/src/main/java/org/apache/struts/tiles2/RedeployableActionServlet.java @@ -0,0 +1,92 @@ +/* + * $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. + */ +package org.apache.struts.tiles2; + +import javax.servlet.ServletException; + +import org.apache.struts.Globals; +import org.apache.struts.action.ActionServlet; +import org.apache.struts.action.RequestProcessor; +import org.apache.struts.config.ModuleConfig; +import org.apache.tiles.definition.DefinitionsFactoryException; +import org.apache.tiles.definition.util.DefinitionsFactoryUtil; + + +/** + *

+ * WebLogic (at least v6 and v7) attempts to serialize the TilesRequestProcessor + * when re-deploying the Webapp in development mode. The TilesRequestProcessor + * is not serializable, and loses the Tiles definitions. This results in + * NullPointerException and/or NotSerializableException when using the app after + * automatic redeploy. + *

+ *

+ * This bug report proposes a workaround for this problem, in the hope it will + * help others and maybe motivate an actual fix. + *

+ *

+ * The attached class extends the Struts Action servlet and fixes the problem by + * reloading the Tiles definitions when they have disappeared. + *

+ *

+ * For background discussion see + * http://issues.apache.org/bugzilla/show_bug.cgi?id=26322 + *

+ * @version $Rev$ $Date$ + * @since 1.2.1 + */ +public class RedeployableActionServlet extends ActionServlet { + + /** + * The request processor for Tiles definitions. + */ + private TilesRequestProcessor tileProcessor; + + /** {@inheritDoc} */ + protected synchronized RequestProcessor + getRequestProcessor(ModuleConfig config) throws ServletException { + + if (tileProcessor != null) { + TilesRequestProcessor processor = (TilesRequestProcessor) super.getRequestProcessor(config); + return processor; + } + + // reset the request processor + String requestProcessorKey = Globals.REQUEST_PROCESSOR_KEY + + config.getPrefix(); + getServletContext().removeAttribute(requestProcessorKey); + + // create a new request processor instance + TilesRequestProcessor processor = (TilesRequestProcessor) super.getRequestProcessor(config); + + tileProcessor = processor; + + try { + // reload Tiles defs + DefinitionsFactoryUtil.reloadDefinitionsFactory( + getServletContext()); + } catch (DefinitionsFactoryException e) { + e.printStackTrace(); + } + + return processor; + } +} diff --git a/tiles2/src/main/java/org/apache/struts/tiles2/TilesPlugin.java b/tiles2/src/main/java/org/apache/struts/tiles2/TilesPlugin.java new file mode 100644 index 000000000..dc85c8670 --- /dev/null +++ b/tiles2/src/main/java/org/apache/struts/tiles2/TilesPlugin.java @@ -0,0 +1,348 @@ +/* + * $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. + */ + +package org.apache.struts.tiles2; + +import java.util.HashMap; +import java.util.Map; + +import javax.servlet.ServletException; +import javax.servlet.http.HttpServletRequest; + +import org.apache.struts.action.ActionServlet; +import org.apache.struts.action.PlugIn; +import org.apache.struts.action.RequestProcessor; +import org.apache.struts.chain.ComposableRequestProcessor; +import org.apache.struts.config.ControllerConfig; +import org.apache.struts.config.ModuleConfig; +import org.apache.struts.config.PlugInConfig; +import org.apache.struts.tiles2.preparer.StrutsPreparerFactory; +import org.apache.struts.tiles2.util.PlugInConfigContextAdapter; +import org.apache.struts.util.ModuleUtils; +import org.apache.struts.util.RequestUtils; +import org.apache.tiles.TilesContainer; +import org.apache.tiles.TilesException; +import org.apache.tiles.access.TilesAccess; +import org.apache.tiles.context.ChainedTilesContextFactory; +import org.apache.tiles.context.TilesRequestContext; +import org.apache.tiles.definition.DefinitionsFactory; +import org.apache.tiles.definition.UrlDefinitionsFactory; +import org.apache.tiles.factory.KeyedDefinitionsFactoryTilesContainerFactory; +import org.apache.tiles.factory.TilesContainerFactory; +import org.apache.tiles.impl.BasicTilesContainer; +import org.apache.tiles.impl.KeyedDefinitionsFactoryTilesContainer; +import org.apache.tiles.impl.KeyedDefinitionsFactoryTilesContainer.KeyExtractor; +import org.apache.tiles.servlet.context.ServletTilesRequestContext; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.slf4j.Marker; +import org.slf4j.MarkerFactory; + +/** + * Tiles Plugin used to initialize Tiles. + * This plugin is to be used with Struts 1.1 in association with + * {@link TilesRequestProcessor}. + *
+ * This plugin creates one definition factory for each Struts-module. The definition factory + * configuration is read first from 'web.xml' (backward compatibility), then it is + * overloaded with values found in the plugin property values. + *
+ * The plugin changes the Struts configuration by specifying a {@link TilesRequestProcessor} as + * request processor. If you want to use your own RequestProcessor, + * it should subclass TilesRequestProcessor. + *
+ * This plugin can also be used to create one single factory for all modules. + * This behavior is enabled by specifying moduleAware=false in each + * plugin properties. In this case, the definition factory + * configuration file is read by the first Tiles plugin to be initialized. The order is + * determined by the order of modules declaration in web.xml. The first module + * is always the default one if it exists. + * The plugin should be declared in each struts-config.xml file in order to + * properly initialize the request processor. + * + * @version $Rev$ $Date$ + * @since Struts 1.1 + */ +// TODO Complete the plugin to be module-aware. +public class TilesPlugin implements PlugIn { + + /** + * Marker for logging of fatal errors. + */ + private final static Marker FATAL = MarkerFactory.getMarker("FATAL"); + + /** + * Defaults form Tiles 2 configuration in case of a module-aware + * configuration. + */ + private static final Map MODULE_AWARE_DEFAULTS = + new HashMap(); + + /** + * Defaults form Tiles 2 configuration in case of a configuration without + * modules. + */ + private static final Map NO_MODULE_DEFAULTS = + new HashMap(); + + static { + NO_MODULE_DEFAULTS.put(TilesContainerFactory + .CONTEXT_FACTORY_INIT_PARAM, + ChainedTilesContextFactory.class.getName()); + NO_MODULE_DEFAULTS.put(TilesContainerFactory + .DEFINITIONS_FACTORY_INIT_PARAM, + UrlDefinitionsFactory.class.getName()); + NO_MODULE_DEFAULTS.put(TilesContainerFactory + .PREPARER_FACTORY_INIT_PARAM, + StrutsPreparerFactory.class.getName()); + + MODULE_AWARE_DEFAULTS.putAll(NO_MODULE_DEFAULTS); + MODULE_AWARE_DEFAULTS.put( + KeyedDefinitionsFactoryTilesContainerFactory + .KEY_EXTRACTOR_CLASS_INIT_PARAM, + ModuleKeyExtractor.class.getName()); + MODULE_AWARE_DEFAULTS.put(TilesContainerFactory + .CONTAINER_FACTORY_INIT_PARAM, + KeyedDefinitionsFactoryTilesContainerFactory.class.getName()); + } + + /** + * The {@code Log} instance for this class. + */ + private final Logger log = + LoggerFactory.getLogger(TilesPlugin.class); + + /** + * Is the factory module aware? + */ + protected boolean moduleAware = false; + + /** + * The plugin config object provided by the ActionServlet initializing + * this plugin. + */ + protected PlugInConfig currentPlugInConfigObject = null; + + /** + * The plugin config object adapted to become a context-like object, that + * exposes init parameters methods. + */ + protected PlugInConfigContextAdapter currentPlugInConfigContextAdapter = null; + + /** + * Get the module aware flag. + * @return true: user wants a single factory instance, + * false: user wants multiple factory instances (one per module with Struts) + */ + public boolean isModuleAware() { + return moduleAware; + } + + /** + * Set the module aware flag. + * This flag is only meaningful if the property tilesUtilImplClassname is not + * set. + * @param moduleAware true: user wants a single factory instance, + * false: user wants multiple factory instances (one per module with Struts) + */ + public void setModuleAware(boolean moduleAware) { + this.moduleAware = moduleAware; + } + + /** + *

Receive notification that the specified module is being + * started up.

+ * + * @param servlet ActionServlet that is managing all the modules + * in this web application. + * @param moduleConfig ModuleConfig for the module with which + * this plugin is associated. + * + * @exception ServletException if this PlugIn cannot + * be successfully initialized. + */ + public void init(ActionServlet servlet, ModuleConfig moduleConfig) + throws ServletException { + + currentPlugInConfigContextAdapter = new PlugInConfigContextAdapter( + this.currentPlugInConfigObject, servlet.getServletContext()); + + // Set RequestProcessor class + this.initRequestProcessorClass(moduleConfig); + + // Initialize Tiles + try { + TilesPluginContainerFactory factory; + TilesContainer container; + if (moduleAware) { + factory = new TilesPluginContainerFactory(); + container = TilesAccess.getContainer( + currentPlugInConfigContextAdapter); + if (container == null) { + container = factory.createContainer( + currentPlugInConfigContextAdapter); + TilesAccess.setContainer(currentPlugInConfigContextAdapter, + container); + } + if (container instanceof TilesPluginContainer) { + TilesPluginContainer pluginContainer = + (TilesPluginContainer) container; + // If we have a definition factory for the current module + // prefix then we are trying to re-initialize the same module, + // and it is wrong! + if (pluginContainer.getProperDefinitionsFactory(moduleConfig + .getPrefix()) != null) { + throw new ServletException("Tiles definitions factory for module '" + + moduleConfig.getPrefix() + + "' has already been configured"); + } + DefinitionsFactory defsFactory = factory + .createDefinitionsFactory(pluginContainer, currentPlugInConfigContextAdapter); + pluginContainer.setDefinitionsFactory(moduleConfig.getPrefix(), defsFactory); + } else { + log.warn("The created container is not instance of " + + "TilesPluginContainer" + + " and cannot be configured correctly"); + } + } else { + if (currentPlugInConfigContextAdapter.getApplicationScope() + .containsKey(TilesAccess.CONTAINER_ATTRIBUTE)) { + throw new ServletException( + "Tiles container has already been configured"); + } + factory = new TilesPluginContainerFactory(); + container = factory.createContainer( + currentPlugInConfigContextAdapter); + TilesAccess.setContainer(currentPlugInConfigContextAdapter, + container); + } + } catch (TilesException e) { + log.error(FATAL, "Unable to retrieve tiles factory.", e); + throw new IllegalStateException("Unable to instantiate container."); + } + } + + /** + * End plugin. + */ + public void destroy() { + try { + TilesAccess.setContainer(currentPlugInConfigContextAdapter, null); + } catch (TilesException e) { + log.warn("Unable to remove tiles container from service."); + } + } + + /** + * Set RequestProcessor to appropriate Tiles {@link RequestProcessor}. + * First, check if a RequestProcessor is specified. If yes, check if it extends + * the appropriate {@link TilesRequestProcessor} class. If not, set processor class to + * TilesRequestProcessor. + * + * @param config ModuleConfig for the module with which + * this plugin is associated. + * @throws ServletException On errors. + */ + protected void initRequestProcessorClass(ModuleConfig config) + throws ServletException { + + String tilesProcessorClassname = TilesRequestProcessor.class.getName(); + ControllerConfig ctrlConfig = config.getControllerConfig(); + String configProcessorClassname = ctrlConfig.getProcessorClass(); + + // Check if specified classname exist + Class configProcessorClass; + try { + configProcessorClass = + RequestUtils.applicationClass(configProcessorClassname); + + } catch (ClassNotFoundException ex) { + log.error(FATAL, "Can't set TilesRequestProcessor: bad class name '{}'.", + configProcessorClassname); + throw new ServletException(ex); + } + + // Check to see if request processor uses struts-chain. If so, + // no need to replace the request processor. + if (ComposableRequestProcessor.class.isAssignableFrom(configProcessorClass)) { + return; + } + + // Check if it is the default request processor or Tiles one. + // If true, replace by Tiles' one. + if (configProcessorClassname.equals(RequestProcessor.class.getName()) + || configProcessorClassname.endsWith(tilesProcessorClassname)) { + + ctrlConfig.setProcessorClass(tilesProcessorClassname); + return; + } + + // Check if specified request processor is compatible with Tiles. + Class tilesProcessorClass = TilesRequestProcessor.class; + if (!tilesProcessorClass.isAssignableFrom(configProcessorClass)) { + // Not compatible + String msg = + "TilesPlugin : Specified RequestProcessor not compatible with TilesRequestProcessor"; + log.error(FATAL, msg); + throw new ServletException(msg); + } + } + + /** + * Method used by the ActionServlet initializing this plugin. + * Set the plugin config object read from module config. + * @param plugInConfigObject PlugInConfig. + */ + public void setCurrentPlugInConfigObject(PlugInConfig plugInConfigObject) { + this.currentPlugInConfigObject = plugInConfigObject; + } + + /** + * Extracts the definitions factory key according to the module prefix. + */ + public static class ModuleKeyExtractor implements KeyExtractor { + + /** {@inheritDoc} */ + public String getDefinitionsFactoryKey(TilesRequestContext request) { + String retValue = null; + + if (request instanceof ServletTilesRequestContext) { + HttpServletRequest servletRequest = + (HttpServletRequest) ((ServletTilesRequestContext) request).getRequest(); + ModuleConfig config = ModuleUtils.getInstance().getModuleConfig( + servletRequest); + + if (config == null) { + // ModuleConfig not found in current request. Select it. + ModuleUtils.getInstance().selectModule(servletRequest, + servletRequest.getSession().getServletContext()); + config = ModuleUtils.getInstance().getModuleConfig(servletRequest); + } + + if (config != null) { + retValue = config.getPrefix(); + } + } + return retValue; + } + + } +} diff --git a/tiles2/src/main/java/org/apache/struts/tiles2/TilesPluginContainer.java b/tiles2/src/main/java/org/apache/struts/tiles2/TilesPluginContainer.java new file mode 100644 index 000000000..fac7945a8 --- /dev/null +++ b/tiles2/src/main/java/org/apache/struts/tiles2/TilesPluginContainer.java @@ -0,0 +1,156 @@ +/* + * $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. + */ + +package org.apache.struts.tiles2; + +import java.util.HashMap; +import java.util.Map; + +import javax.servlet.http.HttpServletRequest; + +import org.apache.struts.config.ModuleConfig; +import org.apache.struts.util.ModuleUtils; +import org.apache.tiles.context.TilesRequestContext; +import org.apache.tiles.Definition; +import org.apache.tiles.definition.DefinitionsFactory; +import org.apache.tiles.impl.BasicTilesContainer; +import org.apache.tiles.locale.LocaleResolver; +import org.apache.tiles.servlet.context.ServletTilesRequestContext; + +public class TilesPluginContainer extends BasicTilesContainer { + + /** + * Maps definition factories to their keys. + */ + private final Map key2definitionsFactory = + new HashMap<>(); + + /** + * The locale resolver. + */ + private LocaleResolver localeResolver; + + /** + * Sets the locale resolver. + * + * @param localeResolver the locale resolver for this container. + * + * @since Struts 1.4.1 + */ + void setLocaleResolver(LocaleResolver localeResolver) { + this.localeResolver = localeResolver; + } + + /** + * Returns the locale resolver. + * + * @return The locale resolve. + * + * @since Struts 1.4.1 + */ + LocaleResolver getLocaleResolverIntern() { + return localeResolver; + } + + /** + * Returns the proper definition factory for the given key, i.e. if the key + * is not present, null will be returned. + * + * @return the definitions factory used by this container. If the key is not + * valid, null will be returned. + * @param key The key of the needed definitions factory. + */ + public DefinitionsFactory getProperDefinitionsFactory(String key) { + DefinitionsFactory retValue = null; + + if (key != null) { + retValue = key2definitionsFactory.get(key); + } + + return retValue; + } + + /** + * Set the definitions factory. This method first ensures that the container + * has not yet been initialized. + * + * @param key The key under which the definitions factory is cataloged. + * @param definitionsFactory the definitions factory for this instance. + * @since 2.1.0 + */ + public void setDefinitionsFactory(String key, + DefinitionsFactory definitionsFactory) { + if (key != null) { + key2definitionsFactory.put(key, definitionsFactory); + } else { + setDefinitionsFactory(definitionsFactory); + } + } + + @Override + public Definition getDefinition(String definitionName, + TilesRequestContext request) { + Definition retValue = null; + String key = getDefinitionsFactoryKey(request); + if (key != null) { + DefinitionsFactory definitionsFactory = + key2definitionsFactory.get(key); + if (definitionsFactory != null) { + retValue = definitionsFactory.getDefinition(definitionName, + request); + } + } + if (retValue == null) { + retValue = super.getDefinition(definitionName, request); + } + return retValue; + } + + /** + * Returns the definitions factory key. + * + * @param request The request object. + * @return The needed factory key. + */ + protected String getDefinitionsFactoryKey(TilesRequestContext request) { + String retValue = null; + + if (request instanceof ServletTilesRequestContext) { + HttpServletRequest servletRequest = + (HttpServletRequest) ((ServletTilesRequestContext) request).getRequest(); + ModuleConfig config = ModuleUtils.getInstance().getModuleConfig( + servletRequest); + + if (config == null) { + // ModuleConfig not found in current request. Select it. + ModuleUtils.getInstance().selectModule(servletRequest, + servletRequest.getSession().getServletContext()); + config = ModuleUtils.getInstance().getModuleConfig(servletRequest); + } + + if (config != null) { + retValue = config.getPrefix(); + } + } + return retValue; + } + +} \ No newline at end of file diff --git a/tiles2/src/main/java/org/apache/struts/tiles2/TilesPluginContainerFactory.java b/tiles2/src/main/java/org/apache/struts/tiles2/TilesPluginContainerFactory.java new file mode 100644 index 000000000..4ae9b95d5 --- /dev/null +++ b/tiles2/src/main/java/org/apache/struts/tiles2/TilesPluginContainerFactory.java @@ -0,0 +1,114 @@ +/* + * $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. + */ + +package org.apache.struts.tiles2; + +import java.io.IOException; +import java.net.URL; +import java.util.Collections; +import java.util.List; + +import org.apache.tiles.TilesApplicationContext; +import org.apache.tiles.TilesContainer; +import org.apache.tiles.context.TilesRequestContextFactory; +import org.apache.tiles.definition.DefinitionsFactory; +import org.apache.tiles.definition.UnresolvingLocaleDefinitionsFactory; +import org.apache.tiles.evaluator.AttributeEvaluatorFactory; +import org.apache.tiles.factory.BasicTilesContainerFactory; +import org.apache.tiles.factory.TilesContainerFactoryException; +import org.apache.tiles.locale.LocaleResolver; + +public class TilesPluginContainerFactory extends BasicTilesContainerFactory { + + @Override + public TilesContainer createContainer(TilesApplicationContext applicationContext) { + TilesPluginContainer container = instantiateContainer(applicationContext); + TilesRequestContextFactory requestContextFactory = + createRequestContextFactory(applicationContext); + container.setApplicationContext(applicationContext); + LocaleResolver resolver = createLocaleResolver(applicationContext, requestContextFactory); + container.setLocaleResolver(resolver); + container.setDefinitionsFactory(createDefinitionsFactory(applicationContext, requestContextFactory, + resolver)); + AttributeEvaluatorFactory attributeEvaluatorFactory = createAttributeEvaluatorFactory( + applicationContext, requestContextFactory, resolver); + container.setAttributeEvaluatorFactory(attributeEvaluatorFactory); + container.setPreparerFactory(createPreparerFactory(applicationContext, requestContextFactory)); + container.setRendererFactory(createRendererFactory(applicationContext, requestContextFactory, + container, attributeEvaluatorFactory)); + return container; + } + + @Override + protected TilesPluginContainer instantiateContainer( + TilesApplicationContext context) { + return new TilesPluginContainer(); + } + + /** + * Returns a list containing the URLs to be parsed. By default, it returns a + * list containing the URL point to "definitions-config". + * + * @param applicationContext The Tiles application context. + * @param contextFactory The Tiles-Request-Context-Factory + * @return The source URLs. + * @since Struts 1.4.1 + */ + protected List getSourceURLs(TilesApplicationContext applicationContext, + TilesRequestContextFactory contextFactory) { + String param = applicationContext + .getInitParams().get(DefinitionsFactory.DEFINITIONS_CONFIG); + if (param == null) { + param = applicationContext + .getInitParams().get("definitions-config"); + } + if (param == null) { + param = "/WEB-INF/tiles.xml"; + } + + try { + return Collections + .singletonList(applicationContext.getResource(param)); + } catch (IOException e) { + throw new TilesContainerFactoryException( + "Cannot get URL: " + param, e); + } + } + + /** + * Creates the definitions factory. By default it creates a + * {@link UnresolvingLocaleDefinitionsFactory} with default dependencies. + * + * @param container The Tiles-Plugin-Container. + * @param applicationContext The Tiles application context. + * + * @return The definitions factory. + * @since Struts 1.4.1 + */ + public DefinitionsFactory createDefinitionsFactory(TilesPluginContainer container, + TilesApplicationContext applicationContext) { + TilesRequestContextFactory requestContextFactory = + createRequestContextFactory(applicationContext); + LocaleResolver resolver = container.getLocaleResolverIntern(); + return createDefinitionsFactory(applicationContext, requestContextFactory, resolver); + } + +} \ No newline at end of file diff --git a/tiles2/src/main/java/org/apache/struts/tiles2/TilesRequestProcessor.java b/tiles2/src/main/java/org/apache/struts/tiles2/TilesRequestProcessor.java new file mode 100644 index 000000000..0fe5b1220 --- /dev/null +++ b/tiles2/src/main/java/org/apache/struts/tiles2/TilesRequestProcessor.java @@ -0,0 +1,262 @@ +/* + * $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. + */ +package org.apache.struts.tiles2; + +import java.io.IOException; + +import javax.servlet.ServletException; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; + +import org.apache.struts.action.ActionServlet; +import org.apache.struts.action.RequestProcessor; +import org.apache.struts.config.ForwardConfig; +import org.apache.struts.config.ModuleConfig; +import org.apache.tiles.TilesContainer; +import org.apache.tiles.TilesException; +import org.apache.tiles.access.TilesAccess; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * RequestProcessor contains the processing logic that the + * Struts controller servlet performs as it receives each servlet request from + * the container. + *

This processor subclasses the Struts RequestProcessor in order to + * intercept calls to forward or include. When such calls are done, the Tiles + * processor checks if the specified URI is a definition name. If {@code true}, + * the definition is retrieved and included. If {@code false}, the original URI + * is included or a forward is performed.

+ *

Actually, catching is done by overloading the following methods: + *

    + *
  • {@link #processForwardConfig(HttpServletRequest,HttpServletResponse,ForwardConfig)}
    • + *
  • {@link #internalModuleRelativeForward(String, HttpServletRequest , HttpServletResponse)}
    • + *
  • {@link #internalModuleRelativeInclude(String, HttpServletRequest , HttpServletResponse)}
    • + *
+ *

+ * + * @since Struts 1.1 + */ +public class TilesRequestProcessor extends RequestProcessor { + + /** + * The {@code Log} instance for this class. + */ + private transient final Logger log = + LoggerFactory.getLogger(TilesRequestProcessor.class); + + /** + * Initialize this request processor instance. + * + * @param servlet The ActionServlet we are associated with. + * @param moduleConfig The ModuleConfig we are associated with. + * + * @throws ServletException If an error occurs during initialization. + */ + public void init(ActionServlet servlet, ModuleConfig moduleConfig) + throws ServletException { + + super.init(servlet, moduleConfig); + } + + /** + * Process a Tile definition name. This method tries to process the + * parameter {@code definitionName} as a definition name. It returns + * {@code true} if a definition has been processed, or {@code false} + * otherwise. + * + * @param definitionName Definition name to insert. + * @param request Current page request. + * @param response Current page response. + * + * @return {@code true} if the method has processed uri as a definition + * name, [@code false} otherwise. + * + * @throws IOException If something goes wrong during writing the + * definition. + * @throws ServletException If something goes wrong during the evaluation + * of the definition + */ + protected boolean processTilesDefinition( + String definitionName, + HttpServletRequest request, + HttpServletResponse response) + throws IOException, ServletException { + + TilesContainer container = TilesAccess.getContainer(servlet + .getServletContext()); + if (container == null) { + log.debug("Tiles container not found, so pass to next command."); + return false; + } + + boolean retValue = false; + + if (container.isValidDefinition(definitionName, new Object[] { request, + response })) { + retValue = true; + try { + container.render(definitionName, new Object[] { request, + response }); + } catch (TilesException e) { + throw new ServletException("Cannot render definition '" + + definitionName + "'"); + } + } else { + // ignore not found + log.debug("Cannot find definition '{}'", definitionName); + } + + return retValue; + } + + /** + * Do a forward using request dispatcher. Uri is a valid uri. If response + * has already been commited, do an include instead. + * + * @param uri Uri or Definition name to forward. + * @param request Current page request. + * @param response Current page response. + * + * @throws IOException If something goes wrong during writing the + * definition. + * @throws ServletException If something goes wrong during the evaluation + * of the definition + */ + protected void doForward( + String uri, + HttpServletRequest request, + HttpServletResponse response) + throws IOException, ServletException { + + if (response.isCommitted()) { + this.doInclude(uri, request, response); + + } else { + super.doForward(uri, request, response); + } + } + + /** + * Overloaded method from Struts' RequestProcessor. Forward or redirect to + * the specified destination by the specified mechanism. + *

This method catches the Struts' actionForward call. It checks if the + * actionForward is done on a Tiles definition name. If true, process the + * definition and insert it. If false, call the original parent's + * method.

+ * + * @param request The servlet request we are processing. + * @param response The servlet response we are creating. + * @param forward The ActionForward controlling where we go next. + * + * @throws IOException if an input/output error occurs. + * @throws ServletException if a servlet exception occurs. + */ + protected void processForwardConfig( + HttpServletRequest request, + HttpServletResponse response, + ForwardConfig forward) + throws IOException, ServletException { + + // Required by struts contract + if (forward == null) { + return; + } + + log.debug("processForwardConfig({})", forward.getPath()); + + // Try to process the definition. + if (processTilesDefinition(forward.getPath(), + request, response)) { + log.debug(" '{}' - processed as definition", forward.getPath()); + return; + } + + log.debug(" '{}' - processed as uri", forward.getPath()); + + // forward doesn't contain a definition, let parent do processing + super.processForwardConfig(request, response, forward); + } + + /** + * Catch the call to a module relative forward. If the specified uri is a + * tiles definition name, insert it. Otherwise, parent processing is + * called. Do a module relative forward to specified uri using request + * dispatcher. Uri is relative to the current module. The real uri is + * computed by prefixing the module name. + *

This method is used internally and is not part of the public + * API. It is advised to not use it in subclasses.

+ * + * @param uri Module-relative URI to forward to. + * @param request Current page request. + * @param response Current page response. + * + * @throws IOException If something goes wrong during writing the + * definition. + * @throws ServletException If something goes wrong during the evaluation + * of the definition + * + * @since Struts 1.1 + */ + protected void internalModuleRelativeForward( + String uri, + HttpServletRequest request, + HttpServletResponse response) + throws IOException, ServletException { + + if (processTilesDefinition(uri, request, response)) { + return; + } + + super.internalModuleRelativeForward(uri, request, response); + } + + /** + * Do a module relative include to specified uri using request dispatcher. + * Uri is relative to the current module. The real uri is computed by + * prefixing the module name. + *

This method is used internally and is not part of the public + * API. It is advised to not use it in subclasses.

+ * + * @param uri Module-relative URI to forward to. + * @param request Current page request. + * @param response Current page response. + * + * @throws IOException If something goes wrong during writing the + * definition. + * @throws ServletException If something goes wrong during the evaluation + * of the definition + * + * @since Struts 1.1 + */ + protected void internalModuleRelativeInclude( + String uri, + HttpServletRequest request, + HttpServletResponse response) + throws IOException, ServletException { + + if (processTilesDefinition(uri, request, response)) { + return; + } + + super.internalModuleRelativeInclude(uri, request, response); + } +} \ No newline at end of file diff --git a/tiles2/src/main/java/org/apache/struts/tiles2/actions/DefinitionDispatcherAction.java b/tiles2/src/main/java/org/apache/struts/tiles2/actions/DefinitionDispatcherAction.java new file mode 100644 index 000000000..d65035a20 --- /dev/null +++ b/tiles2/src/main/java/org/apache/struts/tiles2/actions/DefinitionDispatcherAction.java @@ -0,0 +1,125 @@ +/* + * $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. + */ + +package org.apache.struts.tiles2.actions; + +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; + +import org.apache.struts.action.Action; +import org.apache.struts.action.ActionForm; +import org.apache.struts.action.ActionForward; +import org.apache.struts.action.ActionMapping; +import org.apache.tiles.TilesContainer; +import org.apache.tiles.access.TilesAccess; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + *

An Action that dispatches to a Tiles Definition + * that is named by the request parameter whose name is specified + * by the parameter property of the corresponding + * ActionMapping. + * This action is useful in following situations: + *

  • + *
      To associate an Url to a definition
    + *
      To use Struts <html:link> tag on a definition
    + *
    • + *

    To configure the use of this action in your + * struts-config.xml file, create an entry like this:

    + * + * + * <action path="/saveSubscription" + * type="org.apache.struts.tiles2.actions.DefinitionDispatcherAction" + * parameter="def"/> + * <forward name="success" path="anything" //> + * <forward name="error" path="path.to.error.page" //> + * + * + *

    which will use the value of the request parameter named "def" + * to pick the appropriate definition name. + *

    The value for success doesn't matter. The forward will forward to + * appropriate definition. + *

    The value for error should denote a valid jsp path or definition name. + * + * @version $Rev$ $Date$ + */ +public class DefinitionDispatcherAction extends Action { + + /** + * The {@code Log} instance for this class. + */ + private transient final Logger log = + LoggerFactory.getLogger(DefinitionDispatcherAction.class); + + /** + * Process the specified HTTP request, and create the corresponding HTTP + * response (or forward to another web component that will create it), + * with provision for handling exceptions thrown by the business logic. + * + * @param mapping The ActionMapping used to select this instance + * @param form The optional ActionForm bean for this request (if any) + * @param request The HTTP request we are processing + * @param response The HTTP response we are creating + * + * @throws Exception if the application business logic throws + * an exception + * @return The forward object.. + * @since Struts 1.1 + */ + public ActionForward execute( + ActionMapping mapping, + ActionForm form, + HttpServletRequest request, + HttpServletResponse response) + throws Exception { + + // Identify the request parameter containing the method name + // If none defined, use "def" + String parameter = mapping.getParameter(); + if (parameter == null) { + parameter = "def"; + } + + // Identify the method name to be dispatched to + String name = request.getParameter(parameter); + if (name == null) { + log.error("Can't get parameter '{}'.", parameter); + + return mapping.findForward("error"); + } + + // Try to dispatch to requested definition + // Read definition from factory, but we can create it here. + TilesContainer container = TilesAccess.getContainer(request + .getSession().getServletContext()); + if (container != null + && container.isValidDefinition(name, new Object[] { request, + response })) { + container.render(name, new Object[] { request, response }); + } else { + log.error("Can't get definition '{}'.", name); + return mapping.findForward("error"); + } + + return mapping.findForward("success"); + } +} \ No newline at end of file diff --git a/tiles2/src/main/java/org/apache/struts/tiles2/actions/ReloadDefinitionsAction.java b/tiles2/src/main/java/org/apache/struts/tiles2/actions/ReloadDefinitionsAction.java new file mode 100644 index 000000000..323aa7c17 --- /dev/null +++ b/tiles2/src/main/java/org/apache/struts/tiles2/actions/ReloadDefinitionsAction.java @@ -0,0 +1,88 @@ +/* + * $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. + */ + + +package org.apache.struts.tiles2.actions; + +import java.io.PrintWriter; + +import javax.servlet.ServletContext; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; + +import org.apache.struts.action.Action; +import org.apache.struts.action.ActionForm; +import org.apache.struts.action.ActionForward; +import org.apache.struts.action.ActionMapping; +import org.apache.tiles.definition.DefinitionsFactoryException; +import org.apache.tiles.definition.util.DefinitionsFactoryUtil; + +/** + *

    A standard Action that calls the + * reload() method of our controller servlet to + * reload its configuration information from the configuration + * files (which have presumably been updated) dynamically.

    + * + * @version $Rev$ $Date$ + */ + +public class ReloadDefinitionsAction extends Action { + + /** + * Process the specified HTTP request, and create the corresponding HTTP + * response (or forward to another web component that will create it), + * with provision for handling exceptions thrown by the business logic. + * + * @param mapping The ActionMapping used to select this instance + * @param form The optional ActionForm bean for this request (if any) + * @param request The HTTP request we are processing + * @param response The HTTP response we are creating + * + * @throws Exception if the application business logic throws + * an exception + * @return The forward object. + * @since Struts 1.1 + */ + public ActionForward execute(ActionMapping mapping, + ActionForm form, + HttpServletRequest request, + HttpServletResponse response) + throws Exception { + response.setContentType("text/plain"); + PrintWriter writer = response.getWriter(); + + try { + ServletContext context = getServlet().getServletContext(); + DefinitionsFactoryUtil.reloadDefinitionsFactory(context); + writer.println("OK"); + } catch (DefinitionsFactoryException e) { + writer.println("FAIL - " + e.toString()); + getServlet().log("ReloadAction", e); + } + + writer.flush(); + writer.close(); + + return (null); + + } + +} diff --git a/tiles2/src/main/java/org/apache/struts/tiles2/actions/TilesAction.java b/tiles2/src/main/java/org/apache/struts/tiles2/actions/TilesAction.java new file mode 100644 index 000000000..ae7f6da25 --- /dev/null +++ b/tiles2/src/main/java/org/apache/struts/tiles2/actions/TilesAction.java @@ -0,0 +1,112 @@ +/* + * $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. + */ + +package org.apache.struts.tiles2.actions; + +import javax.servlet.ServletException; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; + +import org.apache.struts.action.Action; +import org.apache.struts.action.ActionForm; +import org.apache.struts.action.ActionForward; +import org.apache.struts.action.ActionMapping; +import org.apache.tiles.AttributeContext; +import org.apache.tiles.access.TilesAccess; + +/** + * Base class for Tiles Actions. + * This class has the same role as Struts Action. It provides a method execute(...) + * called when action is invoked. The difference is, that the execute() method takes + * an additional parameter : tile context. + * This class extends Struts Action. Subclasses should override + * execute(AttributeContext ...) method instead of Struts + * execute(ActionMapping ...) method. + * @version $Rev$ $Date$ + */ +public abstract class TilesAction extends Action { + + /** + * Original Struts Action's method. + * Retrieve current Tile context and call TilesAction execute method. + * Do not overload this method! + * + * @param mapping The ActionMapping used to select this instance. + * @param form The optional ActionForm bean for this request (if any). + * @param request The HTTP request we are processing. + * @param response The HTTP response we are creating. + * + * @throws Exception if the application business logic throws + * an exception + * @return The forward object. + * @since Struts 1.1 + */ + public ActionForward execute( + ActionMapping mapping, + ActionForm form, + HttpServletRequest request, + HttpServletResponse response) + throws Exception { + + // Try to retrieve tile context + AttributeContext context = TilesAccess.getContainer( + request.getSession().getServletContext()).getAttributeContext( + new Object[] { request, response }); + if (context == null) { + throw new ServletException( + "Can't find Tile context for '" + + this.getClass().getName() + + "'. TilesAction subclasses must be called from a Tile"); + } + + return this.execute(context, mapping, form, request, response); + } + + /** + * Process the specified HTTP request and create the corresponding HTTP + * response (or forward to another web component that will create it), + * with provision for handling exceptions thrown by the business logic. + *
    + * Override this method to provide functionality. + * + * @param context The current Tile context, containing Tile attributes. + * @param mapping The ActionMapping used to select this instance. + * @param form The optional ActionForm bean for this request (if any). + * @param request The HTTP request we are processing. + * @param response The HTTP response we are creating. + * + * @throws Exception if the application business logic throws + * an exception + * @return The forward object. + * @since Struts 1.1 + */ + public ActionForward execute( + AttributeContext context, + ActionMapping mapping, + ActionForm form, + HttpServletRequest request, + HttpServletResponse response) + throws Exception { + + return null; + } + +} diff --git a/tiles2/src/main/java/org/apache/struts/tiles2/commands/TilesPreProcessor.java b/tiles2/src/main/java/org/apache/struts/tiles2/commands/TilesPreProcessor.java new file mode 100644 index 000000000..ccffcab21 --- /dev/null +++ b/tiles2/src/main/java/org/apache/struts/tiles2/commands/TilesPreProcessor.java @@ -0,0 +1,114 @@ +/* + * $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. + */ +package org.apache.struts.tiles2.commands; + +import org.apache.commons.chain.Command; +import org.apache.struts.chain.contexts.ServletActionContext; +import org.apache.struts.config.ForwardConfig; +import org.apache.tiles.TilesContainer; +import org.apache.tiles.access.TilesAccess; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * Command class intended to perform responsibilities of the + * TilesRequestProcessor in Struts 1.1. Does not actually dispatch requests, + * but simply prepares the chain context for a later forward as appropriate. + * Should be added to a chain before something which would handle a + * conventional ForwardConfig. + * + *

    This class will never have any effect on the chain unless a + * {@code TilesDefinitionFactory} can be found; however it does not consider + * the absence of a definition factory to be a fatal error; the command simply + * returns false and lets the chain continue.

    + * + *

    To initialize the {@code TilesDefinitionFactory}, use + * {@code org.apache.struts.chain.commands.legacy.TilesPlugin}. This class is a + * simple extension to {@code org.apache.struts.tiles2.TilesPlugin} which + * simply does not interfere with your choice of {@code RequestProcessor} + * implementation.

    + */ +public class TilesPreProcessor implements Command { + + + // ------------------------------------------------------ Instance Variables + + + /** + * The {@code Log} instance for this class. + */ + private final Logger log = + LoggerFactory.getLogger(TilesPreProcessor.class); + + // ---------------------------------------------------------- Public Methods + + + /** + * If the current {@code ForwardConfig} is using "tiles", perform necessary + * pre-processing to set up the {@code TilesContext} and substitute a new + * {@code ForwardConfig} which is understandable to a + * {@code RequestDispatcher}. + * + *

    Note that if the command finds a previously existing + * {@code AttributeContext} in the request, then it infers that it has been + * called from within another tile, so instead of changing the + * {@code ForwardConfig} in the chain {@code Context}, the command uses + * {@code RequestDispatcher} to include the tile, and returns + * true, indicating that the processing chain is complete.

    + * + * @param sacontext The {@code Context} for the current request + * + * @throws Exception If something goes wrong. + * + * @return {@code false} in most cases, but true if we determine + * that we're processing in "include" mode. + */ + public boolean execute(ServletActionContext sacontext) throws Exception { + + // Is there a Tiles Definition to be processed? + ForwardConfig forwardConfig = sacontext.getForwardConfig(); + if (forwardConfig == null || forwardConfig.getPath() == null) { + // this is not a serious error, so log at low priority + log.debug("No forwardConfig or no path, so pass to next command."); + return (false); + } + + + TilesContainer container = TilesAccess.getContainer(sacontext + .getContext()); + if (container == null) { + log.debug("Tiles container not found, so pass to next command."); + return false; + } + + if (container.isValidDefinition(forwardConfig.getPath(), new Object[] { + sacontext.getRequest(), sacontext.getResponse() })) { + container.render(forwardConfig.getPath(), new Object[] { + sacontext.getRequest(), sacontext.getResponse() }); + sacontext.setForwardConfig(null); + } else { + // ignore not found + log.debug("Cannot find definition '{}'", forwardConfig.getPath()); + } + + return false; + } +} \ No newline at end of file diff --git a/tiles2/src/main/java/org/apache/struts/tiles2/doc-files/image001.gif b/tiles2/src/main/java/org/apache/struts/tiles2/doc-files/image001.gif new file mode 100644 index 0000000000000000000000000000000000000000..f675c127c8a11f34a2d225faf336a291148fa253 GIT binary patch literal 1031 zcmV+i1o-<$Nk%w1VU_@{0CxZ}A^sXuZ)S9NVRB_UAWdmwa&L2QW^^D=W@c$)WdI@h z1OWg5001ll00ID!0I2|i0000000000|IGjY|Nof*0s{d80|5d91OF(x-2O1iNvpjW z0x`P(U?`4cX`X1RuA;)ea4gTX=hk?x@8`|`z#z;gEEM5;SLDZ{O zn%#Pr-LF^}9-DXNvzitT%-rj7Hvosx<8ltEZpVw;19u*R9fW~yb%cn1Ol@$Fg^_`h zf{=84j7ETzmxGmqg`Ja`V0t5olAxogqpGAwo2!(whl{eWu%;oMqK21`wuhmZxIbyd z$j8XI%FCq9&WzB}c+=Et*4Jm*+Iij7+}~c|;#%b8R_Ewk8SU=x@bU5vYy|fA`1$(# z{Qds_00RmPC}2aqfd~^ST*we$L0v-{N}Ncs;=P9lEo$7zQU4#t83HIiZyEQ{r~)3<`RHN;iuPn1P)~qebgn` z(|aMX=U_(=#x1umN-Cop}04q>_9RG-Q%C2FlW)2S#Y< zp?>-Y=%W2BSXPmc`V(iRUaI*drjgdUDX05f3MxOMj_Q%8K$?nAsj6OtDy6Lwz-p|s zwpy#Ix0;&ksJnvNE2qC=8f>M*LR##i#~PY!psvgE+3cOq&Kd2S)3RADn%9z>`PE|2Tp*shEZ%_Hx;^wwL!tLvDdPQFd-%WoM!D8@x>lIV{d525MDAdnogS!(_wn^Y@nHHpa* z$HL0YsvuJ1$w`dt%3`bJKU7OWq{XvEaFcYuEb^8Xj){}bf(8w3J-9V@W>p>q%r00sgeKmZg7fB^w; zAOHXY06_o{2ml5FARqt~1b~46a1a0h1^~eT5EuXk10Y}k6byiY0dO$j)gKT706_p? z$g5)j6as)j0PxpXPyi4L06_s@C;$QlK%oE_6aa?;05AX$1^~eTU>E=b13+N_7z_Z1 z0RV6S5Doyr0bn=)0tZ0h02mwqhXVir5b$3*An?B+Am~3+5F7w{%@PO%fq)<|5Cj2& zpg<4|2!aDauez_|*8v8BARrJF1cHG;@K*<55D@%N3I>B9U=S1xf`LJBFzB^NAmpDa z7y^PoKu`z>1_8k#px4TQ(0}$|CR0*L*U?7m#@~Zim$SN0}6q_ zAP_hN^2!7d3VE#u{3?P%pil@53V}l*uk-+6kk=x?uX->D6b6C8AaEGul`|k5@>)6g z)ff(e!XYp?1P+G){;iAG@?P0~ReI&{m9AH2{;>!I{=)(c{O1u0gu#F?IPjI6S04TW z1P1*J1N{fjD-!?s27>>g1_u9&4F$tsU>F?y3dU>QuO+@#^DiMN1O|h=M*g=lfY5*V zf}#JighF93C=3pL4gMPE)#a=8tKzE+_VV`}3eAN;ATO_r?r~pB7G!`uNN0CWq$TU^&3@5Q!t&KF*?2Y^2hY}H@*B(q4DwpVuHaiRv2u#+UEH^qHt)*+Z=q+jdBEv*$ZIsyTi>1>iN^7{#hywTy{6vDS?MqP`C^ ziA3!0ixY7S50qP~4L?lQYkmK(9y>&asP!T%T5kkrvh?1E?;8kH=3i^skh%ma>d|No zB)D+)CT)ast2G!#@HbPWgj1X>0K+dnE&_x6gPqlNvN#@6qJ$2e;2KKx^M+z9UECN! zB4P_$iC{cegCyGjl4p_#E)nv6AW%wfrixo?Zl~&uSrkM&J+PZ3zC+A6PCb4IE{N4B zZ#2+!d`iyE{#|9UpN+uDYZT{jc#|6=rWZn<<0^(sqYu?;F3Kf8HK$B2%rBk^_&^9P z4h^mPL!0I~hGdqT%_zB39?^Waq12(Nz8_nUJxr7Dv~>8ApWaFNGq+yW zW*Zx@Vl=_W+(0scgRKMZe5(%x%MU%WQXVz`y_II{`<%E^30~wyv=7Gld!*j5;6cyO ziDJjktfP!Cz@7?c^s*h;G$gQ}*6ilCA5gw3yh`O6Ouml!z7Icd|(F9V5qz6;Z z3nF>@{rrxgl2dw+Sn<=fu0@SC4A8A9 z2n!f(KCR%0iPK(sa?$IflHHY%NWD}B+4;qziY_)SP4?4nq2$rJiue3l=q957D}~|L z`N?~w>Z=EPAJMn_PBMNV@h1q;7+MolgtROg9JWFAk*WZI{5epqm6WxrQB?X3Iw^AO z3Ts8o5GSePw~we)Zq1AJswr1#lEwq8Yb;#VfUJZrKp(@+ekU4scceJd##?V($fuPJ zBHz$KaAD9$a}up+_0=2;{(yvU@np*MO8#FN8q(l;lyo&M9aqYEsU4?l>g}FF3H{lj zpDS;DwLvfe2ngE^+30KUKn~-{V&u<1_EG-^|PaYDWWln8|RNPAbZ)1P4mXw8O58;z($ z4&iqZXHku$>%re*19lPRFlvnjIbx?~3g5)n!InN;#K>Kje0kvo7AbA#;OrEuE08a$ zs@_(krLFvTT7{UTd5%xey2U($jOscULu^TSLU^?hncRovjy6Gab^E}D;<5ciHyZHXrXOXW1&ChYJlU@oQ880Qpj~U{gA#WMS#p+kz z;3v_Q)j|ahodet28orj5(a2B{AY8q9`}I-cjNiUVT-Wx8`@qjL7DN0tufAIpqRX>{ z+mg+{=jv(J2nAs_UuXYIyo7O&vAF0x2E6BnBa!ar5Ru5J>7eCw?RrrK?6~(QPJQY6 zdaJO*lBQKOP; z-?uW!mNAE*PgBj$WcWB`ye$W_A?Ww*B@@;RzJu0+E&IdMo1(`F70gm$;aCt&J=q< z0Tu6U;lB@i#U^P*Zapf8islT)WVP^ZXWvO%EW}3`#Dw7i4$PY5Vx6*!&>9*qtg_XY z-d1q@y@-s24GVgF9r_he^f@BUst&Nxg^PWXarM;%<@4Y7FVEkdHICVQcS2oEp7r~n z*whmw6HX;t^);fVC$FOMy@gY1Q0gKu6H-#!ZAM=+u8QO6_EId=jZ}WvrAkJ z)YkdN?`MH4^0yzaTMzD&whrE-c|`9tLbRP}JF~!_uAfXk;Pv|@aquaVbMKI<*3T&I zTh&qHTmw<3GQ&L~XU!s$G|_+_?OEGdyp`YL-@STytA#l+qBnqDiG&X_@I8Tf9tEr% zYZ{g%kf=D2W4%D3GP=y+)(C!tE!T`7$DS47pbNiD%2; z%7{9D8e*9Elo=J&t!w{;)2s`OXutefIBpXfX#@XU*#Hn%{$8-V9sbVCRM2Tk)FL|K z{Vjmmz2Gbm%gOug;+Mbgnq+0x9WO76sDnb~5ts+4An7g^Yn*QH8b#aUMF9&ERw{yj z9Tg%lA@2rg|ITB54)nrn^r6W1I_&YdZG*2yzakMgp1GlsJ$I1Aec&hK05kI-zee4l#-NBK%|3tK81CRWjo|nVvPd`g z@TA~0Zg9xHSn9rgW+5vYDJ#Z3^XF5ZWv zwh*!0(C>(0FJK{XE4O>ETUerh=stNEbynD}NZ0_9-z0Z9*$tb&Fw01xe&mfwr>k>N zjl#T&;&)a*!lZB>Qm+>Ch?&L++(ZEcEDOjR$Golty5_l3d;+^&G$fym>p zQBC_1K|9(4emawWQP>pJUxI=+Fle)H1rp{&Is6zm_C+(WBTU#-l(vNi>a0K9w)yM`1rsWxtRw%-7`R@2?VYqaBv35rP$q z^d=muDU#bXW-=&-_91S>AUp&?xFCoFk{7KZYV&p8bBB~8AKP6nHa2=D{!%z{)+s85 zROj=JtIeMQ8M$P8(}zd}oIsF#ZvhfPtq-imH15g` z8i9+Vnej>bPl8p2$9KwoBeE%&3Kzd+MI1*2yJrz%J?VyI4GN5D@Wuz zbwW}OZ*$JvP86?LPKSAp&{8BhFO;RDSPF#vU6MCfX6TpbQo8t(D(zCPij=$jP`ctD zF=<*|)up^$l6Zny=oN0_7)Sn1Qy!8_-WpGy-ctVhMS2u&fl*()kVI@xU_?ex{#H-E z?NY(;e+BnN)I>A|^Y!sT7WuBlKT31+e>X;W92P`*5T!Orm`TQAd7MBbSxwcvs{gMFbX*y3AqEn8VChc-t>7wYT`a`(;poDF8Q#U#Y$m+xtm826Q*;#EHHRX7b+ zNFi6gNv)I;u5`4h3=FD7#;?jPtVA2mi=eIg+EUryY>#!6#gw_>8hug+VlLO`yeK(1ocuJN9)-k_{m5v}1|t_cpRDax<0dRv>fTO*cgeI639 z*i-o|S=-)OBaUB}O%3#^qmbhZlR;rupsUjvRv$$cM*2`MV;HBxQz%ans9D0Oo=R)A zTt|mo7`Bt_+eK}E1Yrwy7m_Z&E9i0<5Y9bGT_w<YInQeXHip)QF3twv)f@ zwQ0~ts{3d z)W);YEqIK<_W0$yHHPqGx0okvaj09owMQmQK$2fq(GmC`eYbKNP}Z|oA8x;fpN{C$hYY4M-v{E~-s=n|lC?o$~zstq%61 z>cb%oMIS8PxG_uH9*4&~J1Rzg_3aOa^RpW~$Vk6l0q+@M(%wU|Iovn%!%f+Xj;}eVTuDI`DWJL^z{FJ0qeyLu550kv_vhUos=J zIx~DUqd+*zRXwewJFB)jqMkmh^;E09I;+P(sZTg(D2t~eFlU-RZQ?a&$;>cq(KcsW zHf8fP=O8d;FEH=oHR14-Zt;8JMQ%~|NCUbM_?f!e9+%(A>`XrUvS$(gzi8j z;i601WDLn-Lfcfs(n4a};+K@gw5LUqlSQb&61rF1+q$7`MWDFkQt9YC$6Rj@?qJmP zQmx;|g|@Ul&0tQj&T{M1$ZzXN?VJivPn}GHa_6Pxfsc#*ZNne76W1TDf1<7o3ar|W z3}S2#62>NSFUE4^FU~xz`rR)J@2{ZqBrNNe-5{+UK6P)}By4-R6&7*t@2?)|t}o25 z4L=SPw+ZyEv{Ur#%P z_ye!gH;BeM|2%Gx%1!8SZc?JP#}VREwQtg|Z8AP@G81hPvkGpp>uqs*Z*gaA@wRXA zuWboFZ-I!mg#@=n^tQ!--rEux+fwb@GHcs%&)W(_J4%8(DtbF=-a8r@J6i2K#5!v` zde1vxqFqD5U1PmnQ}12#j9tt2UF)@7+vnXMghYD|f_qMSdoJF4ZW((X?R%bUd*07` z5TgCxg8Kx1diw$1`#~A|A?^ENYx@z;`%y#(F@gtidIt&k-Umq;2Py3bX=?`=&j(PV z!)(FBT)o45@54f&jKkvg!_u`woy5(`HT?33eL}RJ8o8r*)uV>?`Q}sm7Tf)o!0~9! z{MZD!65iAfqJ3(QACg-?Opn)@AGjxsHwO3g_U_Zir)^`ZJ`N=`4Nb4D&I<0&%V{j8 zL6A?Q7N$h}aT{ZmPP6g@oKS4k5>Jg<#zw_5H_G?6=I|ZpJ^Pl%6Rot?rL7Ae3$TocYUDG z+7sa{R*orQbhIePH_l$>+Lq`T6NklSL)1)5EWbt)svk4WXN#j9b#7EE<+;n|R7UYL^!EH7DyIz*-oZ5$+^gqQFzZ$#$ zpbH+`zI@wrONsF!z7Mjy4~fKq$$xGC_V{h{u7l~Zvm>Ox;;|?4aqQb{4eIJI8Kaxi zu`{FyPqdA8fj%$MQ{Ezm;GvsQ+q;>Fh3d>~4A$|f;xRp9`v=SNhK}7s`Eje%Iq9LW zRXh8f0~Uq(V!(g!b;(G-7OY z7Q7_T8f#6MD;4Rqc_ZSh9cxsZjB>I!-yCbz+YlF1G-27QlvwRGpSa=BEQP3?Y}OUt z?FWn%J7>*d-8<#4cdKGCVWzROf`{T6^!w71OLRul1@_V&u~~I9y?8Jp{w^Asw`)j7 zGJ4?EOU(V^c;BlVYhha;Z1-mjZ^qGPwl|zuJj1h6WOFEe9WA-8NUB%G^>2Mj(%lSv zzKZkgPg>K&nR3pXvlI0@m$I2QVFbHpH_wZkkIVg;uMJf1rymDb?-i;ebBD+3j=$0! zb3G8`lvKXiK>1uao6vj+>yuEf{Qi-N-@5tooychi(zh@6B46Z1SbAaJMpdF%`UEKa zGp0sAcvrf%qWCtpyV1oaOpl8D-Z~#evk-nro9xH%>amif%=BZGx=4$w9$KJ$j1nio zK~ZW%u9+DcN{V`PkS3UByW}{9Vb;iUt^2Xb@tCC4jD4kDBw3S7CSIf zGtS0$?I;hL$E;NpC-!Go!YqobogzAu{#@KM7CR&(gY`5$HEZ6ZFfHHo$UfVTidm2VY}Mx6rsI0e+D$0rT*jekl4w$|nV#m)DW&yas!NaM zYV#yLPBLHpK)6;br^{9`&LpMu;nq*bU5mBry3GnP`iJY`p4O+G z?l{3;Po3+(+83H%^Z+P#TxYr#Hi!gJz=JFL9H^Xal{R6Fe!DuVib{hqM;EcG4_`<0 zhdMTS?0Xyvp^KYwzn36K_y-2cl=$!A64Y-o=V%9tk?JFV8wg{L8NO$pbfPigj7vr+ zFs;TtJVd)tBHl-ykNG#U{(oXx&%e9*6PgF++DGCLMB_lpAC%f@e&VD z(NRlmpPw8M>Muqmqh(eMh&Uc9cx_|C?x)fh2qd`{8Dc`ibB!t9_OvuwoJMz&4QwcOlQ(eYr#o%YGhXoD!6UxMJc&y(!@lb>DVk6_EDT^Z>M*j9zxEE`h zE_*h~g6+R(!^k7RkDRjt#u$U%J_ulvGEO;_5Eh|Q0)5_K3tH!~vt(3WvqIJ)*ih@K z#OD>Vm1i14pL%gu2)Q{3>rmeJOE{YSj@Or6!_QTC>e+^|lpd z?C2KXNqC2Yhp_U|!%IX6wdNDFq$@s*T7e&E7uv9~D}B@VwXs?>q*>>*9-XX>Dfl$y zlw7{~)LNTzv}m5%*BgDfwl)`4=hNazkFV|Kx3N@hS)xjIspT=Tu{Pn;&Yrwwm8`b0 zb#7VqzEmp=ytet_&!_VXy@7s#&DJ5lWu=E@-WQZ{#U0=wbK$2r#*801rB7bQ8a;a^yc=Ko4B#p$b3? z$tpI)Zn)Q>(4!B-_te9iU+ClNvyX6YH6of{=v{ka`QaOei;H4Dkig)e9cvAz$UGU4 z@OJo+^Ef&t$5SnBsuIy1UzI8^9x|itf4oPR2G}?FF}*A zK<=YIWQeag-uGpHs{Zdy^OOr~orW^uy2$AdGuTfGlCyVK-vyW4CR=xlUSuqE8+N8* zk5>4pJ`78&O@|fGJ6BK%?5K9%%}@C`3&hUL86exG5A^BQ#LEim+41F|V47BnGFV$x zf2!Nw#sB=#!pyGxPGwoc%hjU^bsNDH>P_00nOy?CQ; z8Q=LicIm*stAyjX_P1h>jh52ry$nQ5K0fMOzEW-jqJj=Fi8}q{ys2uc4Hr{4cUxB{ z^TS-em$Wqm{&dwA&Vd}J?>PB)xrpUzjcu=zQ+K^-#|@lOzycl73CGce(O^Y?-%F#7U_Zs!E2xyO||yN;aS1G`4-qJ zugfnbrcoc9Lm-_Aj(U2(ja^cz(bu|MtD^AqG0wHS8|%TU>(O_p#2cN22h^WF9^2X6 zFpP3r4M0Dn=bTm3raoV_O-D^04?Cd+o3jZLUgZABH9y>AWc5X3$@9GB-<-{LyGJZu z2>zs3Eim>6L#;3^_<6GkRKTGrm3lgdwh9zahm9Mt-*@%1In^Ky8aN&}MC*I6?Jd2w zZt&+f(xS;DBlxXC86r~5F7Etaj=+{If1dR}ut~Obl9iuoX8{}pjp*7nQ1}Bb*mo{s zJxSxav>MulS)PRX=N75aNo!-iV=v;<5g*p0cSPRX-ki0$MU7M^Ux3-Z#R%5p>O3X~k+Y zq9IMa@xHx!BD8v#eG2rwM*K}+&tgMaX)&tspZzYS;ylLrP9wb*t^Kmc{m0qy zKZQw?2fJnz#62Fxf5{A>x0cI=wpj`Hd&Twnx01Q$O8gF%5bNUf{VrsDJ%HaLVOBK| z6_*o6Ky;#9;~6*5Pdd10F}Q;)G1-Yv)VGvKLM0%}-zs{PV3PCW;FV5OpDyOE7{kI_JCVR>Z zTYFsNQfC*R@`wQ+h?VSn<zq&Nt)Nc)S~n5F)2pFgejyv=k!k{& zw+?wi9vv9QBkLH%-;V|-6+8JvhU;ev|7-oS9yYLQAe)LgI^W7MzB0Vn+KBkOUayEx zyd)W?OBUr1bsGX2_wS(&cHZ9zp-$DUCt*@F=rWt+G6&b+J+kXjUX;h$jmH3K?MfG< z19a?)F-1qlpsxQ$zf_N&Zx1|ox0Y>-g`aa#qK{b`~bZxSa81O(T0_>bJkb8CRhc->MbHjOuUR z65Id$Mv+}7w20Bx^lg}6BG`D4;;DYOB+n7K^+X$MRr!;Bw$h>R>xK0wJ3%T91t)fz zB-6>%(w9!Qus&xM95xfBFrZ?bR1!Xh#Mx(3ktb@=BeZUQ_Ep^;;g4RE*dxj`CsS85 z1@df47X;IqO)?Gqib90_${ZBd#mYFnDt~?X4ZEpiymCE5W&t*33Zer)*k^Z+$Ca{q zPMio^iyJ;%D(tbV<&`E!3(XnyVo6cZ>g)txM6am&^GJO{O@_v@dsQ*9h$_8l8??xq zYeY~>T2Ql}RmJKR{gEyW8l7O#lw#ExwWXN0Q&rEwo&EW-N%cm0BToH0!?Z^m{ZiFj z0Ybs!3dgJ`rbW8C2!h5Vv*Pg)CLboNZqIzk=)Bv<86Coz0A~%>7>&D)7Nwm9o!@E$ zD+|$OpT>ZN{8og%qMBa(^W?fAlZj8IQ%AhN(=}4^I%A%Ol4dp0zkEmK5PbZr=|8ey zzO$J9q{_#jA*Q%wDWlbJG+&UHGn6v}zgH<%CGo#e_n2MkM_0S8(L8%xN>A6y6nXMJL}kWL=fFazR$ysZKpDt0`tDGBEIz7bhcS_4W_Dl zo|`@4we~WjJ9@Kt*sFISyLLLe7J{xXmN zGuH6Dv2Ypn@#Z#eyudi#8^mksC@wky6ov|28z~4O*LAu?YLf5d3<>JiFo-s3#5j;o z4LZ`ZnJy!x_Xjna8xqW@J*Bja)c3Pi{8w^kROn;83;eP`7V#=^0QZ8#&}{ zb=GaMt9coGncG@P-{26N1U(yeo^0|l8nbd5hv9Bf+Zuh%k8_!v6J%We_RffL%t$g| z9n;&Ga&o&Mbo;SQR;XQH#(PN-twpJxJ=A|kBf%sJ69;;{B#&kyf<1I=qQ9fCqxVJ} zNk-lTJz3LNTrq)Y>Z(QPG?#h@nS z%9WE`|B|8Vb3kglZJmD@Y)WTgI{v;b4WEKyP=pw%IOEzc+@ctUEXuXDHC2$I0NhpA zxt(jMKP;Iu95z=<9wCS$h#AuTUJ#Fyj4z|3#d|a!O@VnmgMHa&?&&@H32R+WLM%4 zf9rDQR%CI1x?rAr(G@(IutRq?J*Mf z@b)eU{aA6|UlN>Me8j0i{&a~eeo6Anc%|zCJ#vLm-QgK~Nl=@uS#OzIOWdXxQD8Cs z%-hnQeq7N(?&PlCp$qZq*K;}d*5zv#knNKRG7p~u`4wlu5tHlHC$@^O<7ccL%Y5S| ze2M)6dsoWLItefiLV8@u9?NIk@OwibeF{3GB?G=&z?=4gbJ=j^Dp~GoFvzs zwkc;R>aKazo!H(lD~RtWtBomDILN=hu~c(DcR7;m9GP}-Ch5O^DPPizJe+!Gj+I%e zBkzDNe)9lyNm!N&={q;jFX268yp+1d`Q~7Y?IIvvA{XM4JvsR4?pC{^(y&6a@s5#+ zg8x+Sy_PA_4`}hNZoa*>I)|=M#a;D)PUbDP?X7XU3mNg%!0k@ljo42!S9`m2*F9IQ z>$_jBu5PGm@+}$B5!2nHp;RKHEuVXO+V4~=ZXl*Nf0}zl)$b{vZ$HUjpZF+-Qg!6$ zS$gWn<<~DJnz`FbT0dFe#g(~ph~N9kyNaRN5mL3%xKfRh6yP&9WcRyeH|&MsTov7( zh3_%x6Fd~B?%GqC^q$&P_~8a|brAbIHh;08=WpvTmHX>C(*LC{KEwTsmPSW|Yx2$~mmpRTWp~Xu@_-(!58wc{UQ7Q-yPU^NN!eKIc>4 zucx94@6RJgEeJusUI3^FpdV1!@Av3YsVtbX^E@NVCa6qMWh=UZKoq~bC3 z7MI(ifh5x9Gf6QU!$E`wq&-Pfh7#fU7R@8vHKwxZ*jVqPiCi6 z$o0IDGSTK{GAs-zJ0;Xn|1lBFNOKq_iOFi3C1^u*^7zHZu+NHy_S!tfsV^;tN9uH8 z$$5LGI^HsX5S?mgr9r!9t!UY9AKn#cq$}guXumOd!T9a;k;iFsG)Gx}CCOxZINt`( z`N_j@az#);@13oS$4$+CCh}~^(}mh_l)(7Qk1ti;IUEfBc_SCPmfNHeI( zyjo=Mlg*XNZxTXxEs_Zn`G&-|8fq-RIK`(&u}eFW8kDQj<7fknojxAK4=laUM;2!PJAatQ!JU^Y^n0A z+HAY1w4Iu+tZXjDAX`@K&?3#p`JgD5W-TP&!@t)o&r~PAe$usrhA!2uV3u>ubf<_G zTGHKD%+Qdx8-J2}(A12VF@V>nk`8y#&TT%zmOifg`;lTR5NgPiW0yq3Yua$oOsC#r zBgxI&iHPsX-1Ygn2B#nfvKiM>zN%_R6b1)DyO`(tVik{pzbpGr_rjST!k9@t150Yb)Go^H+4)UW|#S;BJZoXz#B-O-6g zsJT^gO;18diBk<__HxlsoPGV`VhCMZ1Jqre;Q{W;NI8QP>tJ3I%?|jGxl|~*mNA2c3YC>Cl$WlMX zdoT}w7fF7?qW()Ka(-S=;11bxz3m3HE+55D z&ky?U8u!A!JWdP~+=KP*}Kd%YU??g6`D`@-M2 zjb^b%WwSIodct#%R{brT1`n3ug!i%$393I<_t)kLam27CRD<~L_j40G0xKIQkisrv zy&wMgn50fYK|NSB=seP%*+oz!!6!v~SD|jb&v`+j40090U0a(NZAfA|CegkK1Y0u` zNPH~bis5X=IryIt`qzU?LR|P4urjtZ*ag~cBIY*8P@j+_07Uj669RJBXPzce+UnoG zt+%oFOhs%3V!Y%1wsjaSsAZ59V$(#zsNS24NqSd18sN$XyvW9;MjDOFZGV+_ZU2(KO+dt3<}&WtewrG6 zZN_?V0IEP_48HCBoUu?n?sRIC^;o+iyjUbBEa#M8ME6B`b<-lgvYSSQ8Wx zn~UL3DXM6x=;o78(NU$ir6kcFiz~{(ax*5XSFF$*{X>s9j)+r~S1Fb?uCN;85cEPb zYHb_m#cM_Ii0YP-#*0?Wx0!7D=t!} zee;hRt;I)?;Y+MEvE5nA6pm73)dPK$S@j3p+U!5phiV@S>q=>UlxP1uZrk2d9z2~* z_Qf&*Pp4>(60+t2dY47CA zLvm-s4U9j7F3Ju&D97uK2&%U^w^Dfac6IOniE3BcGGU${UOYWW%$+^5`W47qdZfz< zyYW==zOn!Z)#IqX^fKHb^ULh9s>)l7R{myKgsTeN*T7=W$qRnU2{JCoQJ9_we3;!h zEI+Lq=%PtrEFG@7oNsUU`vJOfGo(4ufYNZ<2NC*$c1&da2A{OPX<8UXY<{)7@M4W~ zG#dxpCMDCkR22mgEHYeFR9A6Wdv(q~Zm}#!4H=i)&|e`{jA?M0uMc7bcLnUwq9~7W z-JU03$%wNZCHKe9ux`PcFGmDDM6ZAj8|8?ns~=hPZ~KUo4U3inD}_G7}7jfzg1Jl;baNIALDO1i7yd; zZ?*2jJxV&pQO!Zysg&t3k8t9w?uGJYwpnYoTQ8?{x^UmvF}3f-=$1WN-UddA#sOUtOuj~tD)FBu#G;^9^bzO2iUw_==aM^9(VjY=OPz?craZoQ1$Xe7^ef!}nt&in2azYyB_N3Lvn?7H>KuAKpu-PUUpP9dsm zHgN?yyTzV%agK6VVSQ;kJ+lKtO+<4upYjF>LQf=;uY`Y~c&^>YNH(PFdRIRp~ zI(DV9T0MDo?bvPGRMU4$t`T(0d8fA+%9R)5!)wwLyK)v8X}*Q{>w#BzemPdXm4&9m z{UyNu`nc{#`TYmiB(s(4>e1F+-ET(Uw&E{5KMCxcd|IaJdJY#8S3cWu`5DoPwxeOde&c7P=3M!qn|<{b$S@tN}tuT z2%XdMR)KelNWFPUSYnH9i=&tcDnJ8+PiQ0v;Ut(5P`vUDDaFh*0_peh!{)skq2DvA zO+vAUGSBM_`aL&dUmgq;O(r}rv-djVw>80;x!5s?(6vz@4stfRTsH0>e*(4D#v)vy zi{VBm!UuOEpL@x}56W-+p&NDhlur{xN~CnOnM(#^-wm=?pAfYWhHGResNQ7SqWUkX zAf&Eh7K!x9Myu;5jkxs0E{RB|CTCx}%hL&xv6pMcY@j7E&q3oz$I~~XX`~qO33rpvyvGh zDMn+g!qiPyvr9KBD&5kR#Al!-Z>rk5ll{Q2MouxbwGlVJcplPZpXkCIVkbMh3Cx}N zx=GSJYc3GUO5#oG~n7V>);#Q`a8MsS zCU>EsG}?WiXOZZF?$4T`u2vQXLNjhWP|$PPMGU~M0xD?BrM7-H{Y!7G-fQw0He^hZ zZAF@?%b0F9W_lz0o^f@T^&Q>=bVU9JQ%*JCXenS}!hm8)-@2N}hO*!w4?}Bh$4Y2Y zRxHawq`*Oq3b#4alyT`8cW;BFz}b5b?n5}+n~s=a;FJP=vYnZ|dL->X3Z%(Y(kIq58tm_CiiUys$Cq@C@oH z1+(zo!U$S0<;LsNKh#mS`DpKGqOps97l%gT6~!>pxLy*+3ev<;77&Ti#H(4Dxn#%N znHD8flv$6%u}MD5UJw?rkx66;Cj5{RgNK@7n!J`xFGQFvXZcWO&X0`REF$#{gG@CX zDQr-)ZXrGmszh64xRw#|PR~#-KLtgf5nBxrPqk^WIKr}M?r`s-|CxV}?cHHsBd+RU zypbYBAAfimcF7?RY4PZR`$)0OgGmWzp0tU7$5*<#J}T-l(`M!)@kvq>#3L_ex-zwr zMxpFPhQrSs#mf06vYjSBdd-i+=~}f+NK=lQyhE!cC<}fc=4U9(Pgu1+TZu6QbYK`p zRZha*(06&5s5)45Vwf0o2_C=qSnkB2|KgmLB}CtMsaK=5muyg!W9Olj&BLOeWXy~hFHv@y(zcsC+NMKD!5jz`d?ySA!vyyRrj_)I_5 zr9UBqt zHYTlH+48&npQwurL$p02wAnr~y2uQr0u($LbH;7O>lxYx2_M^oayXVwmMLu!hDe9n zrx&jCY*>u|A;%b}xv*-jY~wOZe>tmchV|m3G@A1LX0k0qTU)$&?zJtq|Mr$#Xzklh zyOwmOr~1S=k-zhf?OT_wzupe7o$No`rYvqs%#~NXQ7=T!(Xk27DzaH)J(&*}*cH<* z31+xDIjuoE-FZ`Si#=CV9Fi9@rFl8Y$0JjBL=$Y|>tOh%Ok;wq-Dc-H^VO&j+kmAbit$)>^i- z8ET8FF!ax@v@x35C=DPj3jQs}{K3uuvE+lWT&mK!TH&@d@=+inS^2S`&3f?pRXj7= zCySEWWP$AQCI(YbLgEl0mnAPsk*Z))#N6_{5CTtAC39V@oJGZroR2y>mzj; z=~zZpIMd9`9QGI}bHfQNZ+@}h;h2?DP&?#R;p1ckRM}Uzvk)Go;C7S}4D4R z(eRd)5$Eb-qIe-A{uKfh8wN`a>v9F#+h_@UT_*J!=DlK$PgfjoYdBrmIPGehd}^fK z*|>hO@dRG+MAqFFAg{c;4kC zVR27vdVDQ_lr_Yh_MX-{zdBwzhpBs({d*!6*84QE7Yli5w#H_YhLriOIYZIF0^tg) zCAiVzsG0#OS*EW>S5c!}5^ylru^-^+s=A z-v7B4b6s8OMXjNITQT$yU(lsnYM*_%)TjXqrDI2>zE0NhmR6E8ydhF*xz$8{#dwddK9cJw|CA?%2>>@%q@lWlHz#&kVw9j}kUgEa4lsS7;4Y(d>7D zF?XsjDX#OJr&+Qn>h8gUTSMRN?8##1*?%*;d|9^{_?&ym=DqGpBz-iNkgH9Gri%{! zlWpcZz3ob+PB>;$YJA`2a_>tP{z4piIdqh-x#A@Ec?pk zKdYte6V>SOo_sFTm=l>DD^|u^!rzu}Dr^KO-GZ;2DYWlQ)VbeL)l+ud*Y#P-oTAE? z=D|N2y}P26+E}H~SGJd&b_QZ+`H$Or|DkD4mH%a}Pa4lLnRYijat+zPk3p%baV1 z0$moO>0|Eo>WZy%6{W|yv1hPQmv*f4FG;rg`JVW08+T!gdSAY|nvXfOvo&Pe3#A8T zPyXus60f$Cq&bdteY`M>>ua7Pq8{sdJ-=epp`d1bo>09-`yqY9y)@6|4p!1VP`WtOyI0^Ra>!UMj}+viUO6wRw%O|CzV(XuI*Nv%biuI9KN+th>H@i#|yg7wr~1mjEuVt8MPLp`JTP#nPawg92M-P;sL-H6h7BP`lsJ)MMT-|PX4JTmWB*5wA3=r` z8S7!Vt*(4pb?R2D5}76yJC8Xag&5;+amAWzk%lrKAd=Qe^vgRy7TDOv1ix5 zo%_w}LmSWh-kto|@#7<+FTdWXdiL+($CrQGz3BS$@y9&R^L~E+u`B-zP{08R%&b4n z4lGc?^u+5a!37~~DZ&XUtkA->PRmfk4LR)4!w*3`?WDpH0c_Ag5>fQ%!4z3+(Zvy~ zdQnEW+*@(Q8Ogg5#~pd>al06O3^J(tZq!jo>yAuP$tCBLjL9eUV{S+&DKwJGE3wRy zsK>PIQaCB6^in`8#VpgzGgYDrO*8wmlFT&`gj3Er>6}i@I;lL6%s27Gi_bm*4OB*! z{uGqE1m7&w(6SU=)TGj=GA&X_1Ecg&#VW=0((nw^v{OzU^VHE%(Hgb2#|Qar)YSG? zZPisQ*?RRwRF6_sR;6wQ&p%sp9dNE*Nwg6uUV*iQCUwZ=8p#EAgwN-S~9g^%5K4HQb%cj5iA-f4AX@G7u0vhA|J z?iG{Xfb%la)`1DWGvRzY%62fdaH{Olh%K|M(u*ICl;MT*Lc*;l=cY z>?+APRoCT}14~afl08O_vF4iB-BK=`Y2+DMeSvloD#e_-^CU~9gV^UeZ(dsGr%7{q zHmR9A`e^B1R(fTX71r2ms+R@3yHtA?n^m*Lvs!7Pg-#kPue#1SX0*|4nr<+QV%KhO z_jdJPn7slLNVwlFd~mn#7C3S0{(QIZW*=9!u*oNzI6TNOZTaNIndUsXLg|gXSkbd2 zU02UtG#z!06dhP~Szm`Tc3f9yarW9h)Ap|0P32ul-**BYcSezi|83rai{Gtw;qgws zLgtG<9(m_WL>+pXuBRSq?N>W^uk7gre@F3^=iXWKyC?p8^jTj%S@stsKXGE4mj6uq zwbXN8!{86U|K+0A7yK#if3!0RzxLO!0-kDt0({Hf2H2$t;;3;zTN}9=NWl!QZ)fq^ zAmZFt8~!xY8%$JqOJ>W zjfI5sVGL;)pd9*4Z=qS@lb#5pPa$!CSwkG#dWgWGO%8!=6C%2j*rYH%ur8vD;_pHT z!Y*EJi&ryZ0-@rz$8ar<64K%r*>lE`*@bj^6p|mS6gP?pE-Qc=A{K)tM)gY(T^(d>5Od>%N_>9=(Hgq*K2=lRwdPeZ-)RX6h;J&%by5oHQg``nbn z_IVhjg{q&D;wL~2Do@5K)LheZ4L%D5(URGbp+S@ZV0&ByYND|YxZtX?hq*<;bKi{8;JO@+y~)(lXzP*rSefpsvo8F4ZK#aLu+$x9f{ z@@qNURymQhIN18tvZou?Y%g`lEOrWRMcnNdPew(%Vso{86>iABnq953skp{H+fSj( z$W7IelvdPQW`Q!?09Mz!cjHw~x!c|8wg%f6z@l2x zd)q2O`Oddi$R(6`tGL`vGBUad{x5+2E5@XnC&4~lumL%oGBxEllwIM9ekFWf-`cLg zEq1Yi)jBMbLQ#GFGUyl4g-d{<7OhkLFgvp;sa(FWm$-cx=4@+1XaCx+I^fE%eAN5b zCx1zZ(p98{s2F7x{TRr`AzxpY=wumhS%IvxrHNj-;T7{(#caN^8>u=|E}PcNpk?Yp z(>vufp%j@`ZZlYn+^{QI7`<=SEgdOlVqYqF&M|(gpCijnGwafVT*RK69hv7b7aEj{ zE;FY=-AJbny2hApNfCWWxaQ*c&!lcNo$q?*QL7l22mEwz0xf7wr9Rr0h1et9>qv+LYT7CN`_peL|HPn`YfpK_a-%)@+3do5c23 z?i&|rVxsZc$03fl(P$c8@-7=z`L=eo_+4nHu+gJORCF&ler)L?Ja5_N=M^QKwFg7| zhwJutrYpYY9!ERX6fPvdO^rs6>pLd{&GEsfZDXTjudz|u|Cpo+iu8IcVy8Hb;q6o%XU^C}u5G(_&Lm~4bJlDIdcSX-u8r*nU$PcA z##8+8371{t9B*FB`~CI6O?cd*#Nyy=9?G-Jz0?lm*3gL_7EIpT@a-e>X`L?8kpG?P z(jNQZQ(pM3Ul#EyS-ZN;{p%GjMPj?uT-Ix!Wmj9=rSZjl`OphzBzuy-u|G6_i@dMf z!`|ezRe6!KHE`Q*G1#3CB;I|#$m~D<)L4gEV!8fZ4d-0X+4TMIMW1*PuR8gtep$L{ zNpHrZTmD%We8Ep%?&Lcg>J586$_pyVDrfnkj(^}Tsp$Hy>v(GSbdE3PuI|teV4`m3 z>Me6(j^-{9%iw614XdmutwNI zB?dcCEo@Nvl!^vN5C*TWy+Ew>#t-exb6kPh;IgQ5CgN&!LD!(1ukOd&%Uun?{iL2 zUXrj6{ZQc!j0~f1kC;#bUC+Q|PnHxB`UEicD(u(f1`=yf5gl=k431?O(EyVz4-aby z3vu(J}v=M2{yYPWDj}ToE^z!KN9E+t$ai}a06bEY-n-Iz% z&Hsp`rgBkEM#}nr%NJ=8P>M01l#%m-jQ{ZJ89lEQPpTQi#;smaTClNNR`DCbF&w)E z7pV~%9dH||s~q*}aMEuAgw?Sf-!bm^sQY9w9&v-@LJ!b_(H`9`0-p-P%#a@eEV_u! z90gJu%Q13hsTt|Ag0 zNiriZulK-4CE2G`3Q`_P5&`}3hNQ+NU-FakktS18AngVxmuw~l`B7x*(uUsB{MPF)`;zi%=(_%rg95WG2Qv^0bAApJ zFv(g-FnzKy9rH0MGcpx(GJ~=*Et4)WYbzI1=={7~jDO|XRKLduO{xhNuv^(Q-JzJ4J#FL1l2y~ScbU_)^6WuA2 zOr{LWhc2KE1;+?YNG&ng;4VV*s+k59NOu%Cq_jDCi~@}> z{&Eoi`s@3U4b`ADv$E7asI*G0G$w_VhH!6lxU}r(k=$VEGOUme=d?vPXixsE&O~)cE%YUqm06pWRI!vRSrm_i#aXL$8F95oiz@n7bn>M2 zQ(5U-b?vCcl|VW*PS7=7)fECy2~^!RL4y=q=k-S4SL0o0<30hF!0`1Hm33duwH6Il zncCz*6BZePsbK>&U%eG#^>mpimRqk>UN06ZwZmUG_A}X3V>ec!JoaNZ6ZjbRVtWTHa&~7W*fGra5iVdb6aT?W`huDH)SvjjJ>d~UAr`Krc50_}T_aX$Q&DT9s%n=eU{~=w{SIuEb7#kPM&EN*kkD2= zh1O}ZCuwj#&pZpAZi*VY}=CQ;r|z3A3&#rD?3rslvEAo;Z#pHa&W z7jXgiV5w#YA-C!p*I|E8*(R5A;}$6wH^q?jhGDsD2$G*$lNM+=+5wSVfS%ylryXBRCibVWNF*Nu6I3-6qA8BcrEu>ZxV#=w2@NP zkd#k%15Z}xtQemcdh?P;dBz5-w|EQn$_RCP#kYG^5PS(n@6uKS9ghuJRq}dnhJQGTV+)Cyn2Gu%gx{7dpExZ+u8M<&hqZX=uozE-Q;MCl zUc30(7Mul)9TJtySY@qojAOQ}*f@&O@Qndf>6DPUr19JSPkq-{j+bzr__%H%Fcx!E zRG~|d|2P|4C5;QW3rp4AqC+f$?~oCh?j$)s8kyFL)zSj3O92r15be37OQ< zHTkYRX_faLnl%)8K0B77PdJ;8S#5`Rk2BVTyK|!}ciFthnb8=d?K!>VkoqLC{iaVz ziLHL+=0zoz51I7&T3Y&Yi*fnJbv6Z`zLC zxsBMb#0oj8o%)c2TBv(-pW7_F7%l`W)x4;era$_rRcH=@S*(efd?~g#WVKq1x!SCQ zr>NZ$m`yc(A*{l>`kWoauD1?a^_s+FnyJ%Sl6RSG=en=KW2G5{;qrQ#3%gtiwx*%_ zYaR@;?{BINo3c4_u|d0UhZ?NOIi?M6tT!;FE!(RDFMr>NOyT+TJi4+&yS6RFb%YF9 zeYN;1@pLcKuh%8Fd%IY9dv%BGw{1JQm$pr7_^>b3g_S$HmwRtD%DFeIxurY1z0i0( zdlw_Rd%D{=wR^mMg^aEHhVjWey=Ul(S-VauTD{lvi?e!?;k&+1nHlFBz3qFy5woN;P!R20T+hF5?%wfLA-i!BF#HoJR%QBqtoh4Sa%E{Kq?SOSAV$ z0nkYY*iw(QiVnC*7m~JyyVzd(_#kq=VzE%=&(`vIlY^!*h|kD@O?91ofn9p1J6RNg z{LF)#Q}L0QK{*Q7uw^a~{b=oCGXV}G+49WV8VjGMz{6R|PxaG-NP9aSwaqT9p)J!>d(l;$ zxrJP2mU{avT?aXv&Na2tda$&~nq#Y$o?}~iqxlWNIr2#Tu5%pMu~*kuJ=u*@$K@2# ziGbgeQgIl(e68>&sin zPMiF=J4v|3T&IuhNP!jGZxz>`(8~|#;or{a20E8)kK=2J5;J~GM_%Po4&fCke&$s> zza2E6pPCbKp5}QTx#{}m6E|7iR^NNR=t1_lz^9H~9Im-3yf<~&=%GGn^_!W!IO?tb zH1YeqVfgB~{$CUO>vb8I!G7#%x$DjT?9o2$)qd^SzU|%q?cqM|Avpm{_gQU N@AZD~M + * + *

    Introduction

    + *

    The Tiles framework allows building pages by assembling reusable Tiles. + * As an example, the page in the next figure can be build by assembling a + * header, a footer, a menu and a body.

    + *

    doc-files/image001

    + *

    Each Tiles (header, menu, body, ...) is a JSP page and can itself be build + * by assembling other Tiles.

    + *

    Using Tiles can be compared as using Java methods: You need to define the Tiles (the method body), and then you can "call" this body anywhere you want, passing it some parameters. In Tiles, parameters are called "attributes" in order to avoid confusion with the request parameters.

    + *

    The Tiles body can be a simple JSP page, a Struts action or any URI pointing + * to a resource inside the current web site.

    + *

    Inserting the body, or calling it, is done with the tag <tiles:insert + * ...> anywhere in a JSP page. Insertion can also be done by specifying + * a definition name as the path of a Struts forward or as input, + * forward or include attributes of a Struts action.

    + *

    Tiles bodies are used to create layouts, reusable parts, ... Tiles insertions + * are used to insert Tiles. The same Tiles can be reused several times in + * the same site, or even in the same page.

    + *

    Insertion of a Tiles body can be associated to a logical name in what Tiles calls a "definition". A definition contains a logical name, a page used as body and some attribute values. The definition declaration doesn't insert the associated Tiles body. It just associates it with the name. A definition name can be used anywhere insertion of a Tiles body can occur. The associated Tiles body is then inserted with associated attributes.

    + *

    The definition declarations can be done in JSP pages or in one or more + * centralized files. A definition can extend another one, overload some attributes, + * add new attributes ... This allows the declaration of a "master" definition + * declaring the common layout, header, menu and footer. All other definitions + * extend this master layout thereby making it possible to change the entire + * site look & feel simply by changing the master definition.

    + * + *

    Simple Examples

    + * + *

    Insert a JSP page

    + * 
    <tiles:insert page="/layouts/commonLayout.jsp" flush="true" />
    + *

    This example inserts the specified page in place of the tag. The page attribute is any valid URL pointing to a resource inside the current site.

    + * + * + *

    Insert a Tiles passing some attributes

    + * 
    <tiles:insert page="/layouts/classicLayout.jsp" flush=&quot;true">
+ *  <tiles:put name="title"  value="Page Title" />
+ *  <tiles:put name="header" value="/common/header.jsp" />
+ *  <tiles:put name="footer" value="/common/footer.jsp" />
+ *  <tiles:put name="menu"   value="/common/menu.jsp" />
+ *  <tiles:put name="body"   value="/tiles/mainBody.jsp" />
    </tiles:insert>
    + * + *

    This example inserts the specified page, passing it the attributes. Attributes + * are stored in a Tiles context which is passed to the inserted pag and + * can then be accesssed by their names.

    + * + *

    Retrieve an attribute value as String

    + * 
    <tiles:getAsString name="title" />
    + *

    This example retrieves the value of the attribute "title" and prints it as a String in the current output stream. The method toString() is applied on the attribute value, allowing to pass any kind of object as value.

    + * + *

    Insert Tiles referenced by an attribute

    + * 
    <tiles:insert attribute='menu' />
    + *

    This inserts the Tiles referenced by the attribute "menu" value. The + * specified attribute value is first retrieved from current Tiles's context, + * and then the value is used as a page target to insert.

    + * + *

    Classic Layout

    + *

    This example is a layout assembling a page in the classic header-footer-menu-body + * fashion.

    + * 
    <%@ taglib uri="/WEB-INF/struts-tiles.tld" prefix="tiles" %>
    <HTML>
+ *  <HEAD>
+ *    <link rel="stylesheet" href="<%=request.getContextPath()%>/layouts/stylesheet.css"
+ *                  type="text/css"/>
+ *    <title><tiles:getAsString name="title"/></title>
+ *  </HEAD>
    <body>
    <table border="0" width="100%" cellspacing="5">
    <tr>
+ *  <td colspan="2"><tiles:insert attribute="header" /></td>
    </tr>
    <tr>
+ *  <td width="140" valign="top">
+ *    <tiles:insert attribute='menu' />
+ *  </td>
+ *  <td valign="top"  align="left">
+ *    <tiles:insert attribute='body' />
+ *  </td>
    </tr>
    <tr>
+ *  <td colspan="2">
+ *    <tiles:insert attribute="footer" />
+ *  </td>
    </tr>
    </table>
    </body>
    </html>
    + * + *

    The layout is declared in a JSP page (ex: /layouts/classicLayout.jsp). + * It can be used in conjunction with the tag described in "Insert + * a page passing some attributes".

    + * + *

    Definitions

    + *

    A definition associates a logical name with the URL of a Tiles to be inserted + * and some attribute values. A definition doesn't insert the Tiles. This is + * done later using the definition name. A definition name can be inserted + * as often as you want in your site, making it easy to reuse a Tiles.

    + *

    A definition can extend another definition and overload some attributes + * or add new ones. This makes easy factorization of definitions differing + * by some attributes. For example, you can define a master definition declaring + * the main header, menu, footer, and a default title. Then let each of your + * page definitions extend this master definition and overload the title and + * the body.

    + *

    Definitions can be declared in a JSP page, or in one or more centralized + * files. To enable the definitions from centralized files, you need to initialize + * the "definitions factory" which will parse the definitions from the files + * and provide them to the Tiles framework.

    + * + *

    Enabling Definition Factory

    + *

    To enable Tiles definitions described in one or more files, you need to write these files and to initialize the definition factory.

    + *

    Initialization is different depending on the Struts version you use, + * or if you do not use Struts at all.

    + * + *

    Struts1.1

    + *

    Use the Tiles plug-in to enable Tiles definitions. This plug-in creates + * the definition factory and passese it a configuration object populated + * with parameters. Parameters can be specified in the web.xml file or + * as plug-in parameters. The plug-in first reads parameters from web.xml, + * and then overloads them with the ones found in the plug-in. All parameters + * are optional and can be omitted. The plug-in should be declared in each + * struts-config file:

    + * 
    + *  <plug-in className="org.apache.struts.tiles.TilesPlugin" >
+ *    <set-property property="definitions-config"
+ *                     value="/WEB-INF/tiles-defs.xml,
+ *                            /WEB-INF/tiles-tests-defs.xml,/WEB-INF/tiles-tutorial-defs.xml,
+ *                            /WEB-INF/tiles-examples-defs.xml" />
+ *    <set-property property="moduleAware" value="true" />
+ *    <set-property property="definitions-parser-validate" value="true" />
+ *  </plug-in>
    + * + *
      + *
    • definitions-config: (optional) + *
        + *
      • Specify configuration file names. There can be several comma separated file names (default: ?? )
        • + *
      + *
      • + *
    • definitions-parser-validate: (optional) + *
        + *
      • Specify if XML parser should validate the Tiles configuration + * file + *
          + *
        • true : validate. DTD should be specified in file header (default)
          • + *
        • false : no validation
          • + *
        + *
        • + *
      + *
      • + * + *
    • moduleAware: (optional) + *
        + *
      • Specify if the Tiles definition factory is module aware. If true (default), + * there will be one factory for each Struts module. + * If false, there will be one common factory for all module. In this later case, + * it is still needed to declare one plugin per module. The factory will be + * initialized with parameters found in the first initialized plugin (generally the + * one associated with the default module). + *
          + *
        • true : Tiles framework is module aware
          • + *
        • false :Tiles framework has one single factoy shared among modules (default)
          • + *
        + *
        • + *
      + *
      • + * + *
    • tilesUtilImplClassname: (optional - for advanced user) + *
        + *
      • Specify The classname of the TilesUtil implementation to use. The specified class should + * be a subclass of TilesUtilStrutsImpl. This option disable the moduleAware option. + *
        + * Specifying "TilesUtilStrutsImpl" is equivalent to moduleAware = false.
        + *
        + * Specifying "TilesUtilStrutsModuleImpl" is equivalent to moduleAware = true.
        + * This option is taken into account only once, when it is first encountered. To avoid problems, + * it is advice to specify the same values in all TilesPlugin declaration. + *
        • + *
      + *
      • + * + *
    + * + *

    The TilesPlugin class creates one definition factory for each struts module. + *

    + *

    + * If the flag moduleAware is false, only one shared factory is created for all modules. + * In this later case, the factory is initialized with parameters found in the first plugin. + * The plugins should be declared in all modules, and the moduleAware flag should be + * the same for the entire application.

    + *

    + * Paths found in Tiles definitions are relative to the main context.

    + *

    You don't need to specify a TilesRequestProcessor, this is automatically + * done by the plug-in. If, however, you want to specify your own RequestProcessor, + * it should extend the TilesRequestProcessor. The plug-in checks this + * constraint.

    + * + *

    Struts1.0.x

    + *

    You need to use a special servlet extending the Struts servlet. This is specified in the web.xml file of your application:

    + * 
    + *  <servlet>
+ *    <servlet-name>action</servlet-name>
+ *    <servlet-class>org.apache.struts.tiles.ActionComponentServlet</servlet-class>
+ *        <!-- Tiles Servlet parameter
+ *          Specify configuration file names. There can be several comma
+ *          separated file names
+ *        -->
+ *    <init-param>
+ *      <param-name>definitions-config</param-name>
+ *      <param-value>/WEB-INF/tiles-defs.xml</param-value>
+ *    </init-param>
+ *        <!-- Tiles Servlet parameter
+ *        Specify if XML parser should validate the Tiles configuration file(s).
+ *        true : validate. DTD should be specified in file header.
+ *        false : no validation
+ *        -->
+ *    <init-param>
+ *      <param-name>definitions-parser-validate</param-name>
+ *      <param-value>true</param-value>
+ *    </init-param>
+ *     ...
+ *  </servlet>
    + * + *

    Without Struts

    + *

    Tiles can be used without Struts. To initialize the definition factory, you can use the provided servlet. Declare it in the web.xml file of your application:

    + * 
    + *  <servlet>
+ *    <servlet-name>action</servlet-name>
+ *    <servlet-class>org.apache.struts.tiles.TilesServlet</servlet-class>
+ *
+ *
+ *    <init-param>
+ *      <param-name>definitions-config</param-name>
+ *      <param-value>/WEB-INF/tiles-defs.xml</param-value>
+ *    </init-param>
+ *    <init-param>
+ *      <param-name>definitions-parser-validate</param-name>
+ *      <param-value>true</param-value>
+ *    </init-param>
+ *   ...
    + * + *

    The parameters are the same as for Struts1.1 or 1.0.

    + * + *

    Definition File Syntax

    + *

    The definition file syntax can be found in the + * tiles-config_1_4.dtd file. + *

    + *

    Following is a simple example:

    + * 
    <!DOCTYPE tiles-definitions PUBLIC
+ *       "-//Apache Software Foundation//DTD Tiles Configuration 1.4//EN"
+ *       "http://struts.apache.org/dtds/tiles-config_1_4.dtd">

    <!-- Definitions for Tiles documentation   -->
    <tiles-definitions>
+ *
+ *  <!-- ========================================================== -->
+ *  <!-- Master definition                                          -->
+ *  <!-- ========================================================== -->
+ *  <!-- Main page layout used as a root for other page definitions -->
+ *
+ *  <definition name="site.mainLayout" path="/layouts/classicLayout.jsp">
+ *      <put name="title"  value="Tiles Blank Site" />
+ *      <put name="header" value="/tiles/common/header.jsp" />
+ *      <put name="menu"   value="site.menu.bar" />
+ *      <put name="footer" value="/tiles/common/footer.jsp" />
+ *      <put name="body"   value="/tiles/body.jsp" />
+ *  </definition>
+ *
+ *  <!-- ========================================================== -->
+ *  <!-- Index page definition                                      -->
+ *  <!-- ========================================================== -->
+ *    <!-- This definition inherits from the main definition.
+ *      It overloads the page title and the body used.
+ *      Use the same mechanism to define new pages sharing common
+ *      properties (here header, menu, footer, layout)
+ *    -->
+ *
+ *  <definition name="site.index.page" extends="site.mainLayout" >
+ *      <put name="title"  value="Tiles Blank Site Index" />
+ *      <put name="body"   value="/tiles/body.jsp" />
+ *  </definition>

    </tiles-definition>
    + * + *

    Debugging

    + *

    To debug a page made of Tiles, you can use following advices:

    + *
      + *
    • Check each Tiles separatly. Try to access nested Tiles directly to test + * if thes work properly.
      • + *
    • Enable Tiles logging. See the commons-logging package help.
      • + *
    + */ +package org.apache.struts.tiles2; \ No newline at end of file diff --git a/tiles2/src/main/java/org/apache/struts/tiles2/package.html b/tiles2/src/main/java/org/apache/struts/tiles2/package.html new file mode 100644 index 000000000..8a42a470e --- /dev/null +++ b/tiles2/src/main/java/org/apache/struts/tiles2/package.html @@ -0,0 +1,341 @@ + + + +Tiles Package + + +
    + The Tiles taglib and framework allows building web pages by assembling reusable + pieces of pages, called Tiles. A Tiles is usually a simple JSP page. +TagLib Tiles UML + +
    +

    Introduction

    +

    The Tiles framework allows building pages by assembling reusable Tiles. + As an example, the page in the next figure can be build by assembling a + header, a footer, a menu and a body.

    +

    doc-files/image001

    +

    Each Tiles (header, menu, body, ...) is a JSP page and can itself be build + by assembling other Tiles.

    +

    Using Tiles can be compared as using Java methods: You need to define the Tiles (the method body), and then you can "call" this body anywhere you want, passing it some parameters. In Tiles, parameters are called "attributes" in order to avoid confusion with the request parameters.

    +

    The Tiles body can be a simple JSP page, a Struts action or any URI pointing + to a resource inside the current web site.

    +

    Inserting the body, or calling it, is done with the tag <tiles:insert + ...> anywhere in a JSP page. Insertion can also be done by specifying + a definition name as the path of a Struts forward or as input, + forward or include attributes of a Struts action.

    +

    Tiles bodies are used to create layouts, reusable parts, ... Tiles insertions + are used to insert Tiles. The same Tiles can be reused several times in + the same site, or even in the same page.

    +

    Insertion of a Tiles body can be associated to a logical name in what Tiles calls a "definition". A definition contains a logical name, a page used as body and some attribute values. The definition declaration doesn't insert the associated Tiles body. It just associates it with the name. A definition name can be used anywhere insertion of a Tiles body can occur. The associated Tiles body is then inserted with associated attributes.

    +

    The definition declarations can be done in JSP pages or in one or more + centralized files. A definition can extend another one, overload some attributes, + add new attributes ... This allows the declaration of a "master" definition + declaring the common layout, header, menu and footer. All other definitions + extend this master layout thereby making it possible to change the entire + site look & feel simply by changing the master definition.

    +
    +
    +

    Simple Examples

    +
    +

    Insert a JSP page

    + 
    <tiles:insert page="/layouts/commonLayout.jsp" flush="true" />
+
    +

    This example inserts the specified page in place of the tag. The page attribute is any valid URL pointing to a resource inside the current site.

    +
    +
    + +

    Insert a Tiles passing some attributes

    +
    +<tiles:insert page="/layouts/classicLayout.jsp" flush=&quot;true">
+  <tiles:put name="title"  value="Page Title" />
+  <tiles:put name="header" value="/common/header.jsp" />
+  <tiles:put name="footer" value="/common/footer.jsp" />
+  <tiles:put name="menu"   value="/common/menu.jsp" />
+  <tiles:put name="body"   value="/tiles/mainBody.jsp" />
+</tiles:insert>
+
    +

    This example inserts the specified page, passing it the attributes. Attributes + are stored in a Tiles context which is passed to the inserted pag and + can then be accesssed by their names.

    +
    +
    +

    Retrieve an attribute value as String

    +
    +<tiles:getAsString name="title" />
+
    +

    This example retrieves the value of the attribute "title" and prints it as a String in the current output stream. The method toString() is applied on the attribute value, allowing to pass any kind of object as value.

    +
    +
    +

    Insert Tiles referenced by an attribute

    +
    +<tiles:insert attribute='menu' />
+
    +

    This inserts the Tiles referenced by the attribute "menu" value. The + specified attribute value is first retrieved from current Tiles's context, + and then the value is used as a page target to insert.

    +
    +
    +

    Classic Layout

    +

    This example is a layout assembling a page in the classic header-footer-menu-body + fashion.

    + 
    +<%@ taglib uri="/WEB-INF/struts-tiles.tld" prefix="tiles" %>
+<HTML>
+  <HEAD>
+    <link rel="stylesheet" href="<%=request.getContextPath()%>/layouts/stylesheet.css" 
+                  type="text/css"/>
+    <title><tiles:getAsString name="title"/></title>
+  </HEAD>
+<body>
+<table border="0" width="100%" cellspacing="5">
+<tr>
+  <td colspan="2"><tiles:insert attribute="header" /></td>
+</tr>
+<tr>
+  <td width="140" valign="top">
+    <tiles:insert attribute='menu' />
+  </td>
+  <td valign="top"  align="left">
+    <tiles:insert attribute='body' />
+  </td>
+</tr>
+<tr>
+  <td colspan="2">
+    <tiles:insert attribute="footer" />
+  </td>
+</tr>
+</table>
+</body>
+</html>
+
    +

    The layout is declared in a JSP page (ex: /layouts/classicLayout.jsp). + It can be used in conjunction with the tag described in "Insert + a page passing some attributes".

    +
    +
    +
    +

    Definitions

    +

    A definition associates a logical name with the URL of a Tiles to be inserted + and some attribute values. A definition doesn't insert the Tiles. This is + done later using the definition name. A definition name can be inserted + as often as you want in your site, making it easy to reuse a Tiles.

    +

    A definition can extend another definition and overload some attributes + or add new ones. This makes easy factorization of definitions differing + by some attributes. For example, you can define a master definition declaring + the main header, menu, footer, and a default title. Then let each of your + page definitions extend this master definition and overload the title and + the body.

    +

    Definitions can be declared in a JSP page, or in one or more centralized + files. To enable the definitions from centralized files, you need to initialize + the "definitions factory&&quot; which will parse the definitions from the files + and provide them to the Tiles framework.

    +
    +

    Enabling Definition Factory

    +

    To enable Tiles definitions described in one or more files, you need to write these files and to initialize the definition factory.

    +

    Initialization is different depending on the Struts version you use, + or if you do not use Struts at all.

    +
    +

    Struts1.1

    +

    Use the Tiles plug-in to enable Tiles definitions. This plug-in creates + the definition factory and passese it a configuration object populated + with parameters. Parameters can be specified in the web.xml file or + as plug-in parameters. The plug-in first reads parameters from web.xml, + and then overloads them with the ones found in the plug-in. All parameters + are optional and can be omitted. The plug-in should be declared in each + struts-config file:

    +
    +  <plug-in className=&&quot;org.apache.struts.tiles.TilesPlugin&&quot; >
+    <set-property property=&&quot;definitions-config&&quot; 
+	                 value=&&quot;/WEB-INF/tiles-defs.xml,
+                            /WEB-INF/tiles-tests-defs.xml,/WEB-INF/tiles-tutorial-defs.xml,
+                            /WEB-INF/tiles-examples-defs.xml&&quot; />
+    <set-property property=&&quot;moduleAware&&quot; value=&&quot;true&&quot; />
+    <set-property property=&&quot;definitions-parser-validate&&quot; value=&&quot;true&&quot; />
+  </plug-in>
+
    +
      +
    • definitions-config: (optional)
        +
      • Specify configuration file names. There can be several comma separated file names (default: ?? )
        • +
      +
      • +
    • definitions-parser-validate: (optional) +
        +
      • Specify if XML parser should validate the Tiles configuration + file +
          +
        • true : validate. DTD should be specified in file header (default)
          • +
        • false : no validation
          • + +
        +
        • +
      +
      • + +
    • moduleAware: (optional) +
        +
      • Specify if the Tiles definition factory is module aware. If true (default), + there will be one factory for each Struts module. + If false, there will be one common factory for all module. In this later case, + it is still needed to declare one plugin per module. The factory will be + initialized with parameters found in the first initialized plugin (generally the + one associated with the default module). +
          +
        • true : Tiles framework is module aware
          • +
        • false :Tiles framework has one single factoy shared among modules (default)
          • +
        +
        • +
      +
      • + +
    • tilesUtilImplClassname: (optional - for advanced user) +
        +
      • Specify The classname of the TilesUtil implementation to use. The specified class should + be a subclass of TilesUtilStrutsImpl. This option disable the moduleAware option. +
        Specifying &&quot;TilesUtilStrutsImpl&&quot; is equivalent to moduleAware = false.
        +
        Specifying &&quot;TilesUtilStrutsModuleImpl&&quot; is equivalent to moduleAware = true.
        + This option is taken into account only once, when it is first encountered. To avoid problems, + it is advice to specify the same values in all TilesPlugin declaration. +
        • +
      +
      • + +
    +

    The TilesPlugin class creates one definition factory for each struts module. +

    +

    + If the flag moduleAware is false, only one shared factory is created for all modules. + In this later case, the factory is initialized with parameters found in the first plugin. + The plugins should be declared in all modules, and the moduleAware flag should be + the same for the entire application.

    +

    + Paths found in Tiles definitions are relative to the main context.

    +

    You don't need to specify a TilesRequestProcessor, this is automatically + done by the plug-in. If, however, you want to specify your own RequestProcessor, + it should extend the TilesRequestProcessor. The plug-in checks this + constraint.

    +
    +
    +

    Struts1.0.x

    +

    You need to use a special servlet extending the Struts servlet. This is specified in the web.xml file of your application:

    + 
    +  <servlet>
+    <servlet-name>action</servlet-name>
+	<servlet-class>org.apache.struts.tiles.ActionComponentServlet</servlet-class>   
+        <!-- Tiles Servlet parameter 
+		  Specify configuration file names. There can be several comma 
+		  separated file names
+		--> 	
+	<init-param>
+      <param-name>definitions-config</param-name>
+      <param-value>/WEB-INF/tiles-defs.xml</param-value>
+    </init-param>
+        <!-- Tiles Servlet parameter 
+		Specify if XML parser should validate the Tiles configuration file(s).
+		true : validate. DTD should be specified in file header.
+		false : no validation
+		--> 	
+    <init-param>
+      <param-name>definitions-parser-validate</param-name>
+      <param-value>true</param-value>
+    </init-param>
+     ...
+  </servlet>
+
    +
    +
    +

    Without Struts

    +

    Tiles can be used without Struts. To initialize the definition factory, you can use the provided servlet. Declare it in the web.xml file of your application:

    +
    +  <servlet>
+    <servlet-name>action</servlet-name>
+    <servlet-class>org.apache.struts.tiles.TilesServlet</servlet-class>
+
+
+	<init-param>
+      <param-name>definitions-config</param-name>
+      <param-value>/WEB-INF/tiles-defs.xml</param-value>
+    </init-param>
+    <init-param>
+      <param-name>definitions-parser-validate</param-name>
+      <param-value>true</param-value>
+    </init-param>
+   ...
+
    +

    The parameters are the same as for Struts1.1 or 1.0.

    +
    +
    +
    +

    Definition File Syntax

    +

    The definition file syntax can be found in the +tiles-config_1_1.dtd file. +

    +

    Following is a simple example:

    + 
    +<!DOCTYPE tiles-definitions PUBLIC
+       &&quot;-//Apache Software Foundation//DTD Tiles Configuration//EN&&quot;
+       &&quot;http://struts.apache.org/dtds/tiles-config_1_1.dtd&&quot;>
+
+<!-- Definitions for Tiles documentation   -->
+<tiles-definitions>
+
+  <!-- ========================================================== -->
+  <!-- Master definition                                          -->
+  <!-- ========================================================== -->
+  <!-- Main page layout used as a root for other page definitions -->
+
+  <definition name=&&quot;site.mainLayout&&quot; path=&&quot;/layouts/classicLayout.jsp&&quot;>
+	  <put name=&&quot;title&&quot;  value=&&quot;Tiles Blank Site&&quot; />
+	  <put name=&&quot;header&&quot; value=&&quot;/tiles/common/header.jsp&&quot; />
+	  <put name=&&quot;menu&&quot;   value=&&quot;site.menu.bar&&quot; />
+	  <put name=&&quot;footer&&quot; value=&&quot;/tiles/common/footer.jsp&&quot; />
+	  <put name=&&quot;body&&quot;   value=&&quot;/tiles/body.jsp&&quot; />
+  </definition>
+
+  <!-- ========================================================== -->
+  <!-- Index page definition                                      -->
+  <!-- ========================================================== -->
+    <!-- This definition inherits from the main definition.
+	  It overloads the page title and the body used.
+	  Use the same mechanism to define new pages sharing common 
+	  properties (here header, menu, footer, layout)
+	-->
+
+  <definition name=&&quot;site.index.page&&quot; extends=&&quot;site.mainLayout&&quot; >
+	  <put name=&&quot;title&&quot;  value=&&quot;Tiles Blank Site Index&&quot; />
+	  <put name=&&quot;body&&quot;   value=&&quot;/tiles/body.jsp&&quot; />
+  </definition>
+
+</tiles-definition>
+
    +
    +
    +

    Debugging

    +

    To debug a page made of Tiles, you can use following advices:

    +
      +
    • Check each Tiles separatly. Try to access nested Tiles directly to test + if thes work properly.
      • +
    • Enable Tiles logging. See the commons-logging package help.
      • +
    +
    +
    +
    + + diff --git a/tiles2/src/main/java/org/apache/struts/tiles2/preparer/ActionPreparer.java b/tiles2/src/main/java/org/apache/struts/tiles2/preparer/ActionPreparer.java new file mode 100644 index 000000000..58fe88c5a --- /dev/null +++ b/tiles2/src/main/java/org/apache/struts/tiles2/preparer/ActionPreparer.java @@ -0,0 +1,68 @@ +/* + * $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. + */ + +package org.apache.struts.tiles2.preparer; + +import org.apache.struts.action.Action; +import org.apache.tiles.AttributeContext; +import org.apache.tiles.context.TilesRequestContext; +import org.apache.tiles.preparer.PreparerException; +import org.apache.tiles.preparer.ViewPreparerSupport; +import org.apache.tiles.servlet.context.ServletTilesRequestContext; + +/** + * Struts wrapper implementation of Controller. This implementation wraps an + * Action in a Controller. + */ +public class ActionPreparer extends ViewPreparerSupport { + + /** + * Struts action wrapped. + */ + private Action action = null; + + /** + * Constructor. + * + * @param action Action to be wrapped. + */ + public ActionPreparer(Action action) { + this.action = action; + } + + /** {@inheritDoc} */ + public void execute(TilesRequestContext tilesContext, + AttributeContext attributeContext) throws PreparerException { + if (tilesContext instanceof ServletTilesRequestContext) { + ServletTilesRequestContext servletTilesContext = + (ServletTilesRequestContext) tilesContext; + try { + this.action.execute(null, null, servletTilesContext.getRequest(), + servletTilesContext.getResponse()); + } catch (Exception e) { + throw new PreparerException( + "The enclosed action threw an exception", e); + } + } else { + throw new PreparerException("Not using a ServletTilesRequestContext"); + } + } +} diff --git a/tiles2/src/main/java/org/apache/struts/tiles2/preparer/StrutsPreparerFactory.java b/tiles2/src/main/java/org/apache/struts/tiles2/preparer/StrutsPreparerFactory.java new file mode 100644 index 000000000..c73782ad0 --- /dev/null +++ b/tiles2/src/main/java/org/apache/struts/tiles2/preparer/StrutsPreparerFactory.java @@ -0,0 +1,55 @@ +/* + * $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. + * + */ +package org.apache.struts.tiles2.preparer; + +import org.apache.struts.action.Action; +import org.apache.tiles.TilesException; +import org.apache.tiles.preparer.BasicPreparerFactory; +import org.apache.tiles.preparer.ViewPreparer; +import org.apache.tiles.util.ClassUtil; + +/** + * Factory used to instantiate preparers in a Struts 1 / Tiles 2 environment. + * + * @version $Rev$ $Date$ + */ +public class StrutsPreparerFactory extends BasicPreparerFactory { + + /** {@inheritDoc} */ + protected ViewPreparer createPreparer(String name) throws TilesException { + ViewPreparer retValue; + + if (name.startsWith("/")) { + retValue = new UrlPreparer(name); + } else { + Object instance = ClassUtil.instantiate(name, true); + if (instance instanceof Action) { + retValue = new ActionPreparer((Action) instance); + } else { + retValue = super.createPreparer(name); + } + } + + return retValue; + } + +} diff --git a/tiles2/src/main/java/org/apache/struts/tiles2/preparer/UrlPreparer.java b/tiles2/src/main/java/org/apache/struts/tiles2/preparer/UrlPreparer.java new file mode 100644 index 000000000..62d77f068 --- /dev/null +++ b/tiles2/src/main/java/org/apache/struts/tiles2/preparer/UrlPreparer.java @@ -0,0 +1,87 @@ +/* + * $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. + * + */ +package org.apache.struts.tiles2.preparer; + +import java.io.IOException; + +import javax.servlet.RequestDispatcher; +import javax.servlet.ServletException; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; + +import org.apache.tiles.AttributeContext; +import org.apache.tiles.context.TilesRequestContext; +import org.apache.tiles.preparer.PreparerException; +import org.apache.tiles.preparer.ViewPreparer; +import org.apache.tiles.servlet.context.ServletTilesRequestContext; + +/** + * @version $Rev$ $Date$ + */ +public class UrlPreparer implements ViewPreparer { + + /** + * The URL to be used as a preparer. + */ + private String url; + + /** + * Constructor. + * + * @param url The URL to be used as a preparer. + */ + public UrlPreparer(String url) { + this.url = url; + } + + /** {@inheritDoc} */ + public void execute(TilesRequestContext tilesContext, + AttributeContext attributeContext) throws PreparerException { + + if (tilesContext instanceof ServletTilesRequestContext) { + ServletTilesRequestContext servletTilesContext = + (ServletTilesRequestContext) tilesContext; + HttpServletRequest request = servletTilesContext.getRequest(); + HttpServletResponse response = servletTilesContext.getResponse(); + RequestDispatcher rd = request.getSession().getServletContext() + .getRequestDispatcher(url); + if (rd == null) { + throw new PreparerException( + "Controller can't find url '" + url + "'."); + } + + try { + rd.include(request, response); + } catch (ServletException e) { + throw new PreparerException( + "The request dispatcher threw an exception", e); + } catch (IOException e) { + throw new PreparerException( + "The request dispatcher threw an I/O exception", e); + } + } else { + throw new PreparerException("Cannot dispatch url '" + url + + "' since this preparer has not been called under a servlet environment"); + } + } + +} diff --git a/tiles2/src/main/java/org/apache/struts/tiles2/util/PlugInConfigContextAdapter.java b/tiles2/src/main/java/org/apache/struts/tiles2/util/PlugInConfigContextAdapter.java new file mode 100644 index 000000000..7bd27277d --- /dev/null +++ b/tiles2/src/main/java/org/apache/struts/tiles2/util/PlugInConfigContextAdapter.java @@ -0,0 +1,393 @@ +/* + * $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. + */ + +package org.apache.struts.tiles2.util; + +import org.apache.struts.config.PlugInConfig; +import org.apache.tiles.servlet.context.ServletTilesApplicationContext; + +import javax.servlet.*; +import javax.servlet.descriptor.JspConfigDescriptor; +import java.io.InputStream; +import java.net.MalformedURLException; +import java.net.URL; +import java.util.*; + +/** + * Adapts a {@link PlugInConfig} object to become a ServletContext object, + * exposing init parameters methods. + */ +public class PlugInConfigContextAdapter extends ServletTilesApplicationContext implements ServletContext { + + /** + * The internal plugin config object. + */ + private final PlugInConfig plugInConfigObject; + + /** + * The Map of context initialization parameters. + */ + private final Map initParam; + + /** + * Constructor. + * + * @param plugInConfigObject The plugin config object to use. + * @param servletContext The servlet context to use. + */ + public PlugInConfigContextAdapter(PlugInConfig plugInConfigObject, + ServletContext servletContext) { + super(servletContext); + this.plugInConfigObject = plugInConfigObject; + + HashMap initParam_ = new HashMap<>(super.getInitParams()); + for (Map.Entry entry : plugInConfigObject.getProperties().entrySet()) { + initParam_.put(entry.getKey(), entry.getValue().toString()); + } + initParam = Collections.unmodifiableMap(initParam_); + } + + @Override + public Map getInitParams() { + return initParam; + } + + /** + * Returns the internal plugin config object. + * + * @return the internal plugin config object + */ + public PlugInConfig getPlugInConfigObject() { + return plugInConfigObject; + } + + @Override + public String getContextPath() { + return getServletContext().getContextPath(); + } + + @Override + public ServletContext getContext(String uripath) { + return getServletContext().getContext(uripath); + } + + @Override + public int getMajorVersion() { + return getServletContext().getMajorVersion(); + } + + @Override + public int getMinorVersion() { + return getServletContext().getMinorVersion(); + } + + @Override + public int getEffectiveMajorVersion() { + return getServletContext().getEffectiveMajorVersion(); + } + + @Override + public int getEffectiveMinorVersion() { + return getServletContext().getEffectiveMinorVersion(); + } + + @Override + public String getMimeType(String file) { + return getServletContext().getMimeType(file); + } + + @Override + public Set getResourcePaths(String path) { + return getServletContext().getResourcePaths(path); + } + + @Override + public InputStream getResourceAsStream(String path) { + return getServletContext().getResourceAsStream(path); + } + + @Override + public RequestDispatcher getRequestDispatcher(String path) { + return getServletContext().getRequestDispatcher(path); + } + + @Override + public RequestDispatcher getNamedDispatcher(String name) { + return getServletContext().getNamedDispatcher(name); + } + + @Override + public Servlet getServlet(String name) throws ServletException { + return getServletContext().getServlet(name); + } + + @Override + public Enumeration getServlets() { + return getServletContext().getServlets(); + } + + @Override + public Enumeration getServletNames() { + return getServletContext().getServletNames(); + } + + @Override + public void log(String msg) { + getServletContext().log(msg); + } + + @Override + public void log(Exception exception, String msg) { + getServletContext().log(exception, msg); + } + + @Override + public void log(String message, Throwable throwable) { + getServletContext().log(message, throwable); + } + + @Override + public String getRealPath(String path) { + return getServletContext().getRealPath(path); + } + + @Override + public String getServerInfo() { + return getServletContext().getServerInfo(); + } + + /** + * Returns an initialization parameter. + * + * @param parameterName The name of the parameter. + * @return The value of the parameter. + */ + public String getInitParameter(String parameterName) { + String retValue; + + retValue = (String) plugInConfigObject.getProperties() + .get(parameterName); + if (retValue == null) { + retValue = getServletContext().getInitParameter(parameterName); + } + + return retValue; + } + + /** + * Returns the names of all initialization parameters. + * + * @return The names of all initialization parameters. + */ + public Enumeration getInitParameterNames() { + return getServletContext().getInitParameterNames(); + } + + @Override + public boolean setInitParameter(String name, String value) { + return getServletContext().setInitParameter(name, value); + } + + @Override + public Object getAttribute(String name) { + return getServletContext().getAttribute(name); + } + + @Override + public Enumeration getAttributeNames() { + return getServletContext().getAttributeNames(); + } + + @Override + public void setAttribute(String name, Object object) { + getServletContext().setAttribute(name, object); + } + + @Override + public void removeAttribute(String name) { + getServletContext().removeAttribute(name); + } + + @Override + public String getServletContextName() { + return getServletContext().getServletContextName(); + } + + @Override + public ServletRegistration.Dynamic addServlet(String servletName, String className) { + return getServletContext().addServlet(servletName, className); + } + + @Override + public ServletRegistration.Dynamic addServlet(String servletName, Servlet servlet) { + return getServletContext().addServlet(servletName, servlet); + } + + @Override + public ServletRegistration.Dynamic addServlet(String servletName, Class servletClass) { + return getServletContext().addServlet(servletName, servletClass); + } + + @Override + public ServletRegistration.Dynamic addJspFile(String servletName, String jspFile) { + return getServletContext().addJspFile(servletName, jspFile); + } + + @Override + public T createServlet(Class clazz) throws ServletException { + return getServletContext().createServlet(clazz); + } + + @Override + public ServletRegistration getServletRegistration(String servletName) { + return getServletContext().getServletRegistration(servletName); + } + + @Override + public Map getServletRegistrations() { + return getServletContext().getServletRegistrations(); + } + + @Override + public FilterRegistration.Dynamic addFilter(String filterName, String className) { + return getServletContext().addFilter(filterName, className); + } + + @Override + public FilterRegistration.Dynamic addFilter(String filterName, Filter filter) { + return getServletContext().addFilter(filterName, filter); + } + + @Override + public FilterRegistration.Dynamic addFilter(String filterName, Class filterClass) { + return getServletContext().addFilter(filterName, filterClass); + } + + @Override + public T createFilter(Class clazz) throws ServletException { + return getServletContext().createFilter(clazz); + } + + @Override + public FilterRegistration getFilterRegistration(String filterName) { + return getServletContext().getFilterRegistration(filterName); + } + + @Override + public Map getFilterRegistrations() { + return getServletContext().getFilterRegistrations(); + } + + @Override + public SessionCookieConfig getSessionCookieConfig() { + return getServletContext().getSessionCookieConfig(); + } + + @Override + public void setSessionTrackingModes(Set sessionTrackingModes) { + getServletContext().setSessionTrackingModes(sessionTrackingModes); + } + + @Override + public Set getDefaultSessionTrackingModes() { + return getServletContext().getDefaultSessionTrackingModes(); + } + + @Override + public Set getEffectiveSessionTrackingModes() { + return getServletContext().getEffectiveSessionTrackingModes(); + } + + @Override + public void addListener(String className) { + getServletContext().addListener(className); + } + + @Override + public void addListener(T t) { + getServletContext().addListener(t); + } + + @Override + public void addListener(Class listenerClass) { + getServletContext().addListener(listenerClass); + } + + @Override + public T createListener(Class clazz) throws ServletException { + return getServletContext().createListener(clazz); + } + + @Override + public JspConfigDescriptor getJspConfigDescriptor() { + return getServletContext().getJspConfigDescriptor(); + } + + @Override + public ClassLoader getClassLoader() { + return getServletContext().getClassLoader(); + } + + @Override + public void declareRoles(String... roleNames) { + getServletContext().declareRoles(roleNames); + } + + @Override + public String getVirtualServerName() { + return getServletContext().getVirtualServerName(); + } + + @Override + public int getSessionTimeout() { + return getServletContext().getSessionTimeout(); + } + + @Override + public void setSessionTimeout(int sessionTimeout) { + getServletContext().setSessionTimeout(sessionTimeout); + } + + @Override + public String getRequestCharacterEncoding() { + return getServletContext().getRequestCharacterEncoding(); + } + + @Override + public void setRequestCharacterEncoding(String encoding) { + getServletContext().setRequestCharacterEncoding(encoding); + } + + @Override + public String getResponseCharacterEncoding() { + return getServletContext().getResponseCharacterEncoding(); + } + + @Override + public void setResponseCharacterEncoding(String encoding) { + getServletContext().setResponseCharacterEncoding(encoding); + } + + @Override + public URL getResource(String path) throws MalformedURLException { + return getServletContext().getResource(path); + } +} \ No newline at end of file diff --git a/tiles2/src/main/resources/LICENSE.txt b/tiles2/src/main/resources/LICENSE.txt new file mode 100644 index 000000000..dd5b3a58a --- /dev/null +++ b/tiles2/src/main/resources/LICENSE.txt @@ -0,0 +1,174 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. diff --git a/tiles2/src/main/resources/NOTICE.txt b/tiles2/src/main/resources/NOTICE.txt new file mode 100644 index 000000000..db75b1f6c --- /dev/null +++ b/tiles2/src/main/resources/NOTICE.txt @@ -0,0 +1,10 @@ +Apache Struts Tiles +Copyright 2000-2007 The Apache Software Foundation + +This product includes software developed by +The Apache Software Foundation (http://www.apache.org/). + +This product includes the ANTLR parsing library, +developed by JGuru.com (http://www.antlr.org and +http://www.jguru.com). + diff --git a/tiles2/src/main/resources/org/apache/struts/tiles2/chain-config.xml b/tiles2/src/main/resources/org/apache/struts/tiles2/chain-config.xml new file mode 100644 index 000000000..a4b23c4ef --- /dev/null +++ b/tiles2/src/main/resources/org/apache/struts/tiles2/chain-config.xml @@ -0,0 +1,256 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/tiles2/src/site/fml/faq.fml b/tiles2/src/site/fml/faq.fml new file mode 100644 index 000000000..45bac7599 --- /dev/null +++ b/tiles2/src/site/fml/faq.fml @@ -0,0 +1,43 @@ + + + + + + Can I use Tiles without Struts? + +

    + Yes. Stand-alone Tiles is currently in the Struts Sandbox, and + nightly builds are available + here. +

    +     +     + + Why are there two versions? + +

    + Stand-alone Tiles is still under development. Until it emerges + from the Sandbox, the Struts Action Framework will continue to depend + on Struts Tiles. +

    +     +     +     +     diff --git a/tiles2/src/site/resources/images/struts-power.gif b/tiles2/src/site/resources/images/struts-power.gif new file mode 100644 index 0000000000000000000000000000000000000000..5f4e9d426757b4416401ea4f7083e08480fac11b GIT binary patch literal 1798 zcmchW`BPI@6vuDEPL)O!su3_ifI?i*TU(Yv*&$dosV0ITNWm*{K~O750YL!=rW9F1 zy$m9yfJ(H`DQ*NUqA()Q1qM`?yA}(SWmZ2;|SO&8U;*ykMDP<{PDP}3+Y6-&<$`Zm7%o4=4 zVur<(#e~I}#R!yG#IT66h_DE=2m;UsY0!dZs7Blz?ooyz41*a4abqE(l%a&7n4yTH zfFz*|Aq>F`K^zp+V#;8`V9a0yjL^y;${@lZ%pjNw)F1}XKnYlogTbH;(x3&+h+Bw@ z;SowPrHI=P#zI60C72S#tqT;8#Dro@F@o&@3Ti1L6k&>BJ@5lCp&RUg{Q&|t1Zofi zXrP2r;DEuP4bq^6IOn)D#PBd7h%*xQgRu}{OfUjpVO^krBte)U@DZE_1Aq(4!D!eP ztOP#*6S~0;V1k8VL!bsRfQC-M0uC4q+8~X%6LHm$h8P}#i-D1_AB=?vBktqieAVBZ zOX^R^*{r_`SF1Ogb6xKp*Q&RJJA!^gPDu~V-9*p93G1cdbAT&>d9agyl>STn-+%0< zEyCjxHj7eKdlE$<(r_7C2sDWMcOcVg#51)CZLYa|&~&z2^tI-nuN)FMI%Mz@J1<+M zH-<(})R~7ATLvU$1ivo0tPu00r~C`WCo42x7glwTOS=!c2Hejevjoyg-`Pt0c?Kic z$3A{&NY$5JU2)5ef1=hzASzNI`y1(2?dHeiQq#Jr=LL4v{I@k?C%h=EbaN5^dfD~? z(U6hj9*uOA+i`_A_*L-p?-DP`2aMT;+>RsEG9rRu~ zCg-8&zGH2gh~I?jv#RsSis@Zns+N5*HM){lw|LZZbbNBldY(u{dv4t;g zHuBZOF@7yajeWC>a-6Jpy>J~V%Ru*(gP7+VGAAcH^U%8F*flV%?p z{B3wB`qAu`b_KjjW{g5zBumCwu!70~QQ;igSHRC+p2^ zlNtqP^?g?(^F7Z_#iUO+ILz4~`-wleb&I@1D9Jy0)6lNLX2lgdSvz_*QnZIJ6 zppH;O_2Ge%&Uay(l!g3S)%Us=DuL>c1Lx+iD&W_29ClWuxR$RCZyZW|SSUGMH__@9 zd%iAh{??0s=0yeV$$RYkZ=a=(>9P*UX&t&+4!9W~iE%T27Aj+(KT0u#X)*OSEl~64}

    a1+>C+=E}g~yqGRj0%yfM+92a`l?u zqbXi)U8Nb6FPI!3YO2>=lMS}+-6$Ij{4~(RFJAlkS2?yW&r+Ku+B+KE>iwCr;rs_j z-|Li(&8dC#k=|&#H-S!7tONL zLSqMdj~hCC)L0cSu-)nEJmLM^*Esvwt7{})7(H&%K4$wEWnJ%4T$)^@Nl@)$g}osj i->jUKVkC}vXd1Hcsk_Ov^jjj=nWP5!`xzM`@BaX)9*BDY literal 0 HcmV?d00001 diff --git a/tiles2/src/site/site.xml b/tiles2/src/site/site.xml new file mode 100644 index 000000000..2c210a5ad --- /dev/null +++ b/tiles2/src/site/site.xml @@ -0,0 +1,81 @@ + + + + + Apache Software Foundation + http://www.apache.org/images/asf-logo.gif + http://www.apache.org/ + + + Apache Struts + http://struts.apache.org/images/struts.gif + http://struts.apache.org/ + + + + + + + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ${reports} + + diff --git a/tiles2/src/site/xdoc/examples.xml b/tiles2/src/site/xdoc/examples.xml new file mode 100644 index 000000000..bc74ff677 --- /dev/null +++ b/tiles2/src/site/xdoc/examples.xml @@ -0,0 +1,294 @@ + + + + + + Examples + + + + +
    + +

    The following examples illustrate Tiles' templating features using a + basic template. The template contains three elements: a title, a header, + and a body displayed vertically. These elements will be manipulated in + various ways in each example. Tiles' flexibility will be demonstrated by + defining the template "inline" in a JSP page and by loading it from a + "factory" defined in an XML file.

    + + + +

    The first example shows the basic template. There are three ways to + define the template. First, it can be defined anonymously in a JSP page + by using the Tiles insert tag. Secondly, it can be defined in a JSP + using the Tiles definition tag. Finally, it can be defined in an XML + file and loaded from a factory using the Tiles insert tag. This example + will illustrate all three methods. First, let's look at the output of + the example. Then we will examine each method.

    + + Example Output +
    + + + + + + + + + + +
    This is the title.
    This is the header + +
    This is the body
    +
    +
    + +

    First let's look at the template. The layout.jsp file contains the + template code. This file does not change no matter whether the Tile + is defined anonymously, in a JSP, or in an XML definitions file.

    + + file: layout.jsp + + + + + + + + + + + + + +
    + ]]> + +

    Next we show the template being inserted anonymously using the Tiles + insert tag. The insert tag is used to define the Tile and insert it in + a single action. The Tile is not placed in the Definitions Factory and + is not available for later use. The template is invoked and the + attributes are filled in. Notice that the title is inserted directly and + the header and body values are included JSP pages.

    + + file: somepage.jsp + + + + + + + + ]]> + + file: header.jsp + This is the header + + ]]> + + file: body.jsp + This is a body + ]]> + +

    Now we will see the same example in a different way. In this version the + Tile is defined in a JSP using the Tiles definition tag. This works very + similarly to the anonymous version. The only difference is that it is not + anonymous. Using this method the template is included and populated and + the Tile is inserted into the Definitions Factory so that it can be used + by other JSP pages.

    + + file: somepage.jsp + + + + + + + + + ]]> + +

    Using this method of defining Tiles can be very tricky. If you define a + Tile like this and then insert it in another page using the Tiles insert + tag, you must make sure that JSP page will never be invoked before the + page that defines the Tile. The Tiles Definitions Factory is stored in + application scope. So if the server is restarted or the Definitions + Factory is reloaded for any reason, a Tile defined in a JSP page is not + reloaded until that JSP page is invoked.

    + +

    The scenario above can be avoided by defining Tiles in an XML configuration + file. The file is loaded at servlet startup using the Tiles Servlet or + a plugin. The example below defines the Tile in an XML file and + uses the Tiles insert tag in a JSP to invoke it.

    + + file: WEB-INF/tiles-defs.xml + + + + + +... + ]]> + + file: somepage.jsp + + + + ]]> + +

    This is the preferred method of defining Tiles. It ensures that all + definitions are loaded at application startup and reduces the coupling + between JSP pages.

    + +     + + + +

    The previous examples used the put tag to set + attributes in a Tiles definition. In those examples Tiles inferred they + attribute type. In most cases this is fine as long as you understand the + rules of how value types are inferred. More on that later. This example + shows that you can specify the attribute type to give Tiles a hint about + what to do with the value.

    + + file: WEB-INF/tiles-defs.xml + + + + + +... + ]]> + +

    The above code is really no different from the first example. Tiles + would've inferred the types we specified. There are several valid + settings for the type attribute. However, they all resolve to just + three different types. The type will be interpreted in one of the + following ways.

    + +
      +
    • String. Value will be inserted directly in the + page as text.
      • +
    • Definition. Value points to a valid Tiles definition + that will be processed and inserted in the page.
      • +
    • Page. Value points to a JSP page that will be + included in the current page.
      • +
    + +

    In most cases Tiles will determine the appropriate type. When would you + need to specify it? Perhaps you have an attribute that is a logo that is + either reused or overriden for a Tile. Tiles might interpret this value + as a path and try to process it as a JSP page. If you specify it as a + String it will be inserted directly into the page. It would also be + useful to specify the type if the value points to a Tiles definition + and you want to make sure Tiles doesn't interpret it as a direct + String.

    + +     + + + + Example Output +
    + + + + + + + + + + +
    Test with tag body.
    + This header is inserted as body of tag +
    This is the body
    +
    +
    + + file: WEB-INF/tiles-defs.xml + + + + This header is inserted as body of tag + + + +... + ]]> +     + +
    + + + + +     diff --git a/tiles2/src/site/xdoc/index.xml b/tiles2/src/site/xdoc/index.xml new file mode 100644 index 000000000..c17bc52f4 --- /dev/null +++ b/tiles2/src/site/xdoc/index.xml @@ -0,0 +1,166 @@ + + + + + + Welcome + + + + +
    +

    + Welcome to the Struts Tiles component.Tiles is a templating + system. (Include on steriods.) It can be used to create a common look + and feel for a web application. Tiles can also be used to create + reusable view components. This site will help + you get started with Tiles. +

    +

    + Tiles can also be used without Struts. A new release of Tiles, + Tiles 2, is being prepared. If you would like to use Tiles without + Struts, see the new Tiles 2 subproject. + The focus of this site is using Tiles with Struts. +

    +
    + +
    +
      +
    • Screen definitions +
        +
      • Create a screen by assembling + Tiles : header, footer, + menu, body, etc. +
        • +
      • + Definitions can take place : +
          +
        • in a centralized XML file
          • +
        • directly in JSP pages
          • +
        • programatically in Actions
          • +
        +
        • +
      • + Definitions provide an inheritance + mechanism : a definition can extend another one, + and override parameters. +
        • +
      +
      • +
    • + Layouts +
        +
      • + Define common page layouts and reuse + them across your website. +
        • +
      • + Define menu layouts, and use them by + passing lists of items and links. +
        • +
      • + Define a portal layout, use it by + passing a list of Tiles + (pages) to show. +
        • +
      • + Reuse existing layouts, or define + your own. +
        • +
      +
      • +
    • + Dynamic page building +
        +
      • + Tiles can be gathered dynamically during + page reload. It is possible to change any attribute: + layout, list of Tiles in portal, list of menu + items, etc. +
        • +
      +
      • +
    • + Reuse of Tiles / + Components +
        +
      • + If well defined, a + Tile can be reused across multiple + applications. +
        • +
      • + Dynamic attributes are used to + parameterize Tiles. +
        • +
      • + It is possible to define a library of + reusable Tiles. +
        • +
      • + Build a page by assembling predefined + components, giving them appropriate parameters. +
        • +
      +
      • +
    • + Internationalization (i18n) +
      • +
        +
      • + It is possible to load different tiles + according to Locale. +
        • +
      • + A mechanism similar to Java properties + files is used for definitions files: you can have one + definition file per Locale. The appropriate definition is + loaded according to the current Locale. +
        • +
      +
    • + Multi-channels +
      • +
        +
      • + It is possible to load different Tiles + according to a key. +
        • + +
      • + For example, the key could represent user privileges, + browser type, arbitrary name stored in session, etc. +
        • + +
      • + A mechanism similar to Java properties + files is used for definitions files: you can have one + definition file per key. The appropriate definition is + loaded according to the key. +
        • +
      +
    + +
    + + +     diff --git a/tiles2/src/site/xdoc/installation.xml b/tiles2/src/site/xdoc/installation.xml new file mode 100644 index 000000000..1d8f222a9 --- /dev/null +++ b/tiles2/src/site/xdoc/installation.xml @@ -0,0 +1,114 @@ + + + + + + Installation + + + + +
    +
      +
    • + Create a new web application based on the Struts Blank example. +
      • +
    • + Edit the struts-config and uncomment the section that refers + to the "Tiles PlugIn".
      • +
    • + Create one or more Tiles Definitions XML files in the /WEB-INF + directory of the new application. +
      • +
    • + Deploy the new application. +
      • +
    + +
    + + +
    + +

    + Here's how to use Tiles in your own application: +

    + +
      +
    • + Ensure that a struts-tiles.jar is available in + the WEB-INF/lib directory of your web application. +
      • +
    • +

      + Add this init-param to the Action + Servlet definition in web.xml:

      + + chainConfig + org/apache/struts/tiles/chain-config.xml + + ]]> + +
      • +
    • + Configure the Tiles Plugin to load your definitions. + + + + ]]> +
      • +
    • + At the top of each JSP page that will use the Tiles custom tags, + add a line that declares the Tiles custom tag library. + + + ]]> +
      • +
    + +
    + +
    +

    WARNING - Do NOT add + tiles.jar to the classpath of your servlet container in + an attempt to avoid placing it in the /WEB-INF/lib + directory of each individual web app! Doing so will cause problems with + ClassNotFoundException exceptions.

    + +

    For most containers, you need only to:

    +
      +
    • Copy the WAR files in your Tiles /webapp directory + to your containers webapps directory.
      • +
    • In some cases, you may need to restart your container if it + is running.
      • +
    + +
    + + +     diff --git a/tiles2/src/site/xdoc/userGuide.xml b/tiles2/src/site/xdoc/userGuide.xml new file mode 100644 index 000000000..a5ce8b419 --- /dev/null +++ b/tiles2/src/site/xdoc/userGuide.xml @@ -0,0 +1,438 @@ + + + + + + User Guide + + + + +
    + +

    + One Tiles is installed and the XML Definitions are being loaded, + the better part of using Tiles is managing the XML Definitions. +

    + + + +

    This section provides an overview of the Tiles XML configuration mechanism. +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ]]> + +

    The XML example above is representative of real-life usage. But it does + not illustrate every aspect of the Tiles configuration file. We will + now examine each portion of the configuration file in detail.

    + +     + + +

    A definition can define a template or a "tile." If it is defining + a template its path will point to a JSP page that contains the layout + of the template. The definition's attributes will point to various + sections of the template that can be either used as is or overriden.

    + +

    If a definition defines a tile it may refer to a named portion of a + page such as the header, or it may refer to a reusable component, such + as a customer form.

    + +

    A template definition would be similar to the mainLayout + definition above. It defines a template containing a layout and 5 named + attributes. The "title" attribute is a String attribute that can be + overridden. The "header" and "footer" attributes are pages that are + included in the template. The "menu" and "body" attributes are + definitions that would be defined elsewhere in the file.

    + +

    A tile definition would be similar to the mainMenu + definition above. This configures a menu tile that can be included + anywhere on a page.

    + +

    The following list shows the attributes of the Definition tag.

    + +
      +
    • controllerClass + The fully qualified Java class name of the controller + subclass to call immediately before the tiles is inserted. + Only one of controllerClass or controllerUrl should be + specified.
      • + +
    • controllerUrl + The context-relative path to the resource used as controller + called immediately before the tiles is inserted. + Only one of controllerClass or controllerUrl should be + specified.
      • + +
    • extends + Name of a definition that is used as ancestor of this definition. + All attributes from the ancestor are available to the new + definition. Any attribute inherited from the ancestor can + be overloaded by providing a new value.
      • + +
    • name (Required). + The unique identifier for this definition.
      • + +
    • page + Same as path.
      • + +
    • path + The context-relative path to the resource used as tiles to + insert. This tiles will be inserted and a tiles context + containing appropriate attributes will be available.
      • + +
    • role + Security role name that is allowed access to this definition + object. The definition is inserted only if the role name is + allowed.
      • + +
    • template + Same as path. For compatibility with the template tag library.
      • +
    +     + + +

    The "put" element describes an attribute of a definition. Definition + attributes have a name and a value. The value can be specified as an + xml attribute, or in the body of the <put>tag.

    + +

    A definition attribute can be one of three basic types. It can be + a String value that is inserted into a page. This value can be a + simple String specified in the "value" attribute of the "put" tag or + it can be complex HTML content specified as the body of the "put" tag. + The attribute can also be the URL of a page to be included in another + page. Thirdly, it can be the name of another Tiles definition to + be inserted in a page.

    + +

    The following list shows the attributes of the Put tag.

    + +
      +
    • content + Same as value.
      • + +
    • direct + Same as type="string".
      • + +
    • name (Required) + The unique identifier for this put.
      • + +
    • type + The type of the value. Can be: string, page, template or + definition. By default, no type is associated to a value. If a + type is associated, it will be used as a hint to process the + value when the attribute will be used in the inserted tiles. A + type of "string" indicates that the value should be inserted + directly into the content of the page. A type of "page" or + "template" indicates that the value is the URL of a page that + should be included. A type of "definition" indicates that the + value is the name of another Tiles definition that should be + included in the page.
      • + +
    • value + The value associated to this tiles attribute. The "value" + attribute is required if the value is not specified in the + content of the "put" tag. +
      • +
    + +     + + +

    The PutList tag is similar to the Put tag except that it allows you + to specify a list of attributes for a Tiles Definition. It specifies + an attribute that is a Java List containing any kind of values. In + the config file, the list elements are specified by nested + add, item or + putList elements.

    + +

    The following list shows the attributes of the PutList tag.

    + +
      +
    • name (Required). + The unique identifier for this put list.
      • +
    +     + + +

    The add element describes an element of a list. It + is similar to the put element except that it is only + used in lists. It supports the following attributes.

    + +
      +
    • content + Same as value.
      • + +
    • direct + Same as type="string".
      • + +
    • name (Required) + The unique identifier for this put.
      • + +
    • type + The type of the value. Can be: string, page, template or + definition. By default, no type is associated to a value. If a + type is associated, it will be used as a hint to process the + value when the attribute will be used in the inserted tiles. A + type of "string" indicates that the value should be inserted + directly into the content of the page. A type of "page" or + "template" indicates that the value is the URL of a page that + should be included. A type of "definition" indicates that the + value is the name of another Tiles definition that should be + included in the page.
      • + +
    • value + The value associated to this tiles attribute. The "value" + attribute is required if the value is not specified in the + content of the "add" tag. +
      • +
    + +     + + +

    The bean element describes an element of a list. It + causes a bean of the specified java classtype to be created. This + bean is initialized with appropriate nested + set-property elements.

    + +
      +
    • classtype (Required). + The fully qualified classname for this bean.
      • +
    +     + + +

    The set-property element specifies the method name + and initial value of a bean property. When the object representing + the surrounding element is instantiated, the accessor for the + indicated property is called and passed the indicated value.

    + +
      +
    • property (Required). + Name of the JavaBeans property whose setter method will be + called.
      • + +
    • value (Required). + String representation of the value to which this property will + be set, after suitable type conversion
      • +
    + +     + + +

    The item element describes an element of a list. + It causes a bean of the specified classtype to be created and added + to the list. Each bean can contain different properties: value, link, + icon, tooltip. These properties are to be interpreted by the jsp + page using them.

    + +

    Using the Item element is a good way to build menus. By default the + bean is of type + org.apache.struts.tiles.beans.SimpleMenuItem. The + following attributes are supported.

    + +
      +
    • classtype + The fully qualified classtype for this bean. If specified, the + classtype must be a subclass of the interface + org.apache.struts.tiles.beans.MenuItem.
      • + +
    • icon + Link to the icon for the menu item.
      • + +
    • link (Required). + URL of the location pointed to by the menu item.
      • + +
    • tooltip + Alternative text describing the menu item.
      • + +
    • value (Required) + The String to be displayed on the menu.
      • +
    +     + + +

    The description element contains descriptive + (paragraph length) text about the surrounding element, suitable for + use in GUI tools.

    +     + + +

    The display-name element contains a short (one line) + description of the surrounding element, suitable for use in GUI + tools.

    +     + + +

    The icon element contains a small-icon and + large-icon element which specify the location, relative to the + Tiles configuration file, for small and large images used to + represent the surrounding element in GUI tools.

    +     + + +

    The large-icon element specifies the location, + relative to the Struts configuration file, of a resource containing + a large (32x32 pixel) icon image.

    +     + + +

    The large-icon element specifies the location, + relative to the Struts configuration file, of a resource containing + a large (16x16 pixel) icon image.

    +     +
    + + + +
    + +

    +Tiles has been covered by many books and articles. +

    + + + + + + + + + + + +

    +For a comprehensive listing of Struts resources, visit +Struts Central. +

    + +     + +
    + + +     diff --git a/tiles2/src/test/java/org/apache/struts/tiles2/TestTilesPlugin.java b/tiles2/src/test/java/org/apache/struts/tiles2/TestTilesPlugin.java new file mode 100644 index 000000000..c242b185a --- /dev/null +++ b/tiles2/src/test/java/org/apache/struts/tiles2/TestTilesPlugin.java @@ -0,0 +1,296 @@ +/* + * $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. + */ + +package org.apache.struts.tiles2; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertNotSame; +import static org.junit.jupiter.api.Assertions.assertSame; +import static org.junit.jupiter.api.Assertions.fail; + +import java.lang.reflect.InvocationTargetException; + +import javax.servlet.ServletException; + +import org.apache.commons.beanutils.BeanUtils; +import org.apache.struts.Globals; +import org.apache.struts.action.PlugIn; +import org.apache.struts.config.ModuleConfig; +import org.apache.struts.config.ModuleConfigFactory; +import org.apache.struts.config.PlugInConfig; +import org.apache.struts.mock.MockActionServlet; +import org.apache.struts.mock.TestMockBase; +import org.apache.struts.util.RequestUtils; +import org.apache.tiles.TilesContainer; +import org.apache.tiles.access.TilesAccess; +import org.apache.tiles.definition.DefinitionsFactory; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * Tests the Tiles plugin. + * + * @version $Rev$ $Date$ + */ +public class TestTilesPlugin extends TestMockBase { + + /** + * The first module to configure. + */ + protected ModuleConfig module1; + + /** + * The second module to configure. + */ + protected ModuleConfig module2; + + /** + * A testing action servlet. + */ + protected MockActionServlet actionServlet; + + /** + * The {@code Log} instance for this class. + */ + private final Logger log = + LoggerFactory.getLogger(TestTilesPlugin.class); + + // ----------------------------------------------------- Setup and Teardown + + /** {@inheritDoc} */ + @BeforeEach + public void setUp() { + + super.setUp(); + actionServlet = new MockActionServlet(context, config); + } + + /** {@inheritDoc} */ + @AfterEach + public void tearDown() { + + super.tearDown(); + + } + + // ------------------------------------------------------- Individual Tests + + // ---------------------------------------------------------- absoluteURL() + + /** + * Test multi factory creation when moduleAware=true. + * + * @throws ServletException + * If something goes wrong during initialization. + * @throws InvocationTargetException + * Bean properties problems. + * @throws InstantiationException + * Bean properties problems. + * @throws IllegalAccessException + * Bean properties problems. + * @throws ClassNotFoundException + * Bean properties problems. + */ + @Test + public void testMultiFactory() throws ClassNotFoundException, + IllegalAccessException, InstantiationException, + InvocationTargetException, ServletException { + // init TilesPlugin + module1 = createModuleConfig("/module1", "tiles-defs.xml", true); + module2 = createModuleConfig("/module2", "tiles-defs.xml", true); + initModulePlugIns(module1); + initModulePlugIns(module2); + + // mock request context + request.setAttribute(Globals.MODULE_KEY, module1); + request.setPathElements("/myapp", "/module1/foo.do", null, null); + + // Retrieve TilesContainer + TilesContainer container = TilesAccess.getContainer(actionServlet + .getServletContext()); + assertSame(TilesPluginContainer.class.getName(), + container.getClass().getName()); + + // Retrieve factory for module1 + DefinitionsFactory factory1 = ((TilesPluginContainer) container) + .getProperDefinitionsFactory("/module1"); + + assertNotNull(factory1, "factory found"); + + // mock request context + request.setAttribute(Globals.MODULE_KEY, module2); + request.setPathElements("/myapp", "/module2/foo.do", null, null); + // Retrieve factory for module2 + DefinitionsFactory factory2 = ((TilesPluginContainer) container) + .getProperDefinitionsFactory("/module2"); + assertNotNull(factory2, "factory found"); + + // Check that factory are different + // FIXME This assert fails! + assertNotSame(factory1, factory2, "Factory from different modules"); + } + + /** + * Tests if the TilesPlugin does a fail-fast on multiple configuration of + * the same module. + * + * @throws ServletException If something goes wrong during initialization. + * @throws InvocationTargetException Bean properties problems. + * @throws InstantiationException Bean properties problems. + * @throws IllegalAccessException Bean properties problems. + * @throws ClassNotFoundException Bean properties problems. + */ + @Test + public void testMultiModuleFailFast() throws ClassNotFoundException, + IllegalAccessException, InstantiationException, + InvocationTargetException, ServletException { + // init TilesPlugin + module1 = createModuleConfig("/module1", "tiles-defs.xml", true); + + // The name is "/module1" on purpose + module2 = createModuleConfig("/module1", "tiles-defs.xml", true); + initModulePlugIns(module1); + try { + initModulePlugIns(module2); + fail("An exception should have been thrown"); + } catch (ServletException e) { + // It is ok + log.debug("Intercepted a ServletException, it is ok", e); + } + } + + /** + * Test single factory creation when moduleAware=false. + * + * @throws ServletException If something goes wrong during initialization. + * @throws InvocationTargetException Bean properties problems. + * @throws InstantiationException Bean properties problems. + * @throws IllegalAccessException Bean properties problems. + * @throws ClassNotFoundException Bean properties problems. + */ + @Test + public void testSingleSharedFactory() throws ClassNotFoundException, + IllegalAccessException, InstantiationException, + InvocationTargetException, ServletException { + // init TilesPlugin + module1 = createModuleConfig("/module1", "tiles-defs.xml", false); + module2 = createModuleConfig("/module2", "tiles-defs.xml", false); + initModulePlugIns(module1); + try { + initModulePlugIns(module2); + fail("An exception should have been thrown"); + } catch (ServletException e) { + // It is ok + log.debug("Intercepted a ServletException, it is ok", e); + } + + // mock request context + request.setAttribute(Globals.MODULE_KEY, module1); + request.setPathElements("/myapp", "/module1/foo.do", null, null); + // Retrieve TilesContainer + TilesContainer container = TilesAccess.getContainer(actionServlet + .getServletContext()); + assertSame(TilesPluginContainer.class.getName(), container.getClass() + .getName()); + + // Retrieve factory for module1 + DefinitionsFactory factory1 = ((TilesPluginContainer) container) + .getDefinitionsFactory(); + assertNotNull(factory1, "factory found"); + + // mock request context + request.setAttribute(Globals.MODULE_KEY, module2); + request.setPathElements("/myapp", "/module2/foo.do", null, null); + // Retrieve factory for module2 + DefinitionsFactory factory2 = ((TilesPluginContainer) container) + .getDefinitionsFactory(); + assertNotNull(factory2, "factory found"); + + // Check that factory are different + assertEquals(factory1, factory2, "Same factory"); + } + + /** + * Create a module configuration. + * + * @param moduleName The name of the module. + * @param configFileName The name of the configuration file. + * @param moduleAware true if the configuration must be + * module-aware. + * @return The configuration object. + */ + private ModuleConfig createModuleConfig(String moduleName, + String configFileName, boolean moduleAware) { + + ModuleConfig moduleConfig = ModuleConfigFactory.createFactory() + .createModuleConfig(moduleName); + + context.setAttribute(Globals.MODULE_KEY + moduleName, moduleConfig); + + // Set tiles plugin + PlugInConfig pluginConfig = new PlugInConfig(); + pluginConfig.setClassName("org.apache.struts.tiles2.TilesPlugin"); + + pluginConfig.addProperty("moduleAware", + (moduleAware ? "true" : "false")); + + pluginConfig.addProperty("definitions-config", + "/org/apache/struts/tiles2/config/" + configFileName); + + moduleConfig.addPlugInConfig(pluginConfig); + return moduleConfig; + } + + /** + * Fake call to init module plugins. + * + * @param moduleConfig The configuration of the module. + * @throws ServletException If something goes wrong during initialization. + * @throws InvocationTargetException Bean properties problems. + * @throws InstantiationException Bean properties problems. + * @throws IllegalAccessException Bean properties problems. + * @throws ClassNotFoundException Bean properties problems. + */ + private void initModulePlugIns(ModuleConfig moduleConfig) + throws ClassNotFoundException, IllegalAccessException, + InstantiationException, InvocationTargetException, ServletException { + PlugInConfig[] plugInConfigs = moduleConfig.findPlugInConfigs(); + PlugIn[] plugIns = new PlugIn[plugInConfigs.length]; + + context.setAttribute(Globals.PLUG_INS_KEY + moduleConfig.getPrefix(), + plugIns); + for (int i = 0; i < plugIns.length; i++) { + plugIns[i] = (PlugIn) RequestUtils + .applicationInstance(plugInConfigs[i].getClassName()); + BeanUtils.populate(plugIns[i], plugInConfigs[i].getProperties()); + // Pass the current plugIn config object to the PlugIn. + // The property is set only if the plugin declares it. + // This plugin config object is needed by Tiles + BeanUtils.copyProperty(plugIns[i], "currentPlugInConfigObject", + plugInConfigs[i]); + plugIns[i].init(actionServlet, moduleConfig); + } + } +} \ No newline at end of file diff --git a/tiles2/src/test/resources/org/apache/struts/tiles2/config/tiles-defs.xml b/tiles2/src/test/resources/org/apache/struts/tiles2/config/tiles-defs.xml new file mode 100644 index 000000000..0988b5507 --- /dev/null +++ b/tiles2/src/test/resources/org/apache/struts/tiles2/config/tiles-defs.xml @@ -0,0 +1,133 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + From 9acce256a06c6f49d2c1b24b0698f32186c633d9 Mon Sep 17 00:00:00 2001 From: tdferreira <49493150+tdferreira@users.noreply.github.com> Date: Wed, 23 Oct 2024 01:25:24 +0200 Subject: [PATCH 3/5] Update userGuide tags to comply with Tiles 2+ --- tiles2/src/site/xdoc/userGuide.xml | 36 +++++++++++++++--------------- 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/tiles2/src/site/xdoc/userGuide.xml b/tiles2/src/site/xdoc/userGuide.xml index a5ce8b419..4d5a9312f 100644 --- a/tiles2/src/site/xdoc/userGuide.xml +++ b/tiles2/src/site/xdoc/userGuide.xml @@ -43,31 +43,31 @@ + "-//Apache Software Foundation//DTD Tiles Configuration 2.1//EN" + "http://struts.apache.org/dtds/tiles-config_2_1.dtd"> - - - - - - + + + + + + - - - - - - - + + + + + + + - + - - + + From 1647dfe87307b0d3d1d6bb150cc849dce4947e71 Mon Sep 17 00:00:00 2001 From: tdferreira <49493150+tdferreira@users.noreply.github.com> Date: Wed, 23 Oct 2024 01:25:43 +0200 Subject: [PATCH 4/5] Cleanup --- tiles2/pom.xml | 38 +++---------------- .../tiles2/RedeployableActionServlet.java | 2 +- 2 files changed, 7 insertions(+), 33 deletions(-) diff --git a/tiles2/pom.xml b/tiles2/pom.xml index 4c9918816..2904b46b0 100644 --- a/tiles2/pom.xml +++ b/tiles2/pom.xml @@ -32,48 +32,16 @@ struts-tiles2 jar Struts Tiles 2 integration - http://struts.apache.org - - - scm:svn:http://svn.apache.org/repos/asf/struts/struts1/trunk/tiles2/ - scm:svn:https://svn.apache.org/repos/asf/struts/struts1/trunk/tiles2/ - http://svn.apache.org/repos/asf/struts/struts1/trunk/tiles2/ - - - - - apache-site - scp://people.apache.org/www/struts.apache.org/1.x/struts-tiles2 - - org.apache.struts.tiles2 2.2.2 - - - - src/main/resources - - - - - - src/test/java - - **/*.xml - - - - - ${project.groupId} struts-core - ${project.version} ${project.groupId} @@ -99,6 +67,12 @@ org.apache.tiles tiles-core ${tiles2Version} + + + org.slf4j + jcl-over-slf4j + + org.apache.tiles diff --git a/tiles2/src/main/java/org/apache/struts/tiles2/RedeployableActionServlet.java b/tiles2/src/main/java/org/apache/struts/tiles2/RedeployableActionServlet.java index be59be509..26d34989b 100644 --- a/tiles2/src/main/java/org/apache/struts/tiles2/RedeployableActionServlet.java +++ b/tiles2/src/main/java/org/apache/struts/tiles2/RedeployableActionServlet.java @@ -48,7 +48,7 @@ *

    *

    * For background discussion see - * http://issues.apache.org/bugzilla/show_bug.cgi?id=26322 + * STR-1937. *

    * @version $Rev$ $Date$ * @since 1.2.1 From 187230203df131b3fe67de95aa2c78bed18e01ec Mon Sep 17 00:00:00 2001 From: tdferreira <49493150+tdferreira@users.noreply.github.com> Date: Wed, 23 Oct 2024 01:26:36 +0200 Subject: [PATCH 5/5] Cleanup --- .../org/apache/struts/tiles3/TilesPlugin.java | 2 +- .../actions/DefinitionDispatcherAction.java | 4 +-- .../actions/ReloadDefinitionsAction.java | 2 +- .../struts/tiles3/actions/TilesAction.java | 2 +- .../tiles3/commands/TilesPreProcessor.java | 4 +-- .../apache/struts/tiles3/package-info.java | 8 ++--- .../tiles3/preparer/ActionPreparer.java | 2 +- .../preparer/StrutsPreparerFactory.java | 4 +-- .../struts/tiles3/preparer/UrlPreparer.java | 2 +- .../util/PlugInConfigContextAdapter.java | 2 +- tiles3/src/site/site.xml | 6 ++-- tiles3/src/site/xdoc/examples.xml | 8 ++--- tiles3/src/site/xdoc/index.xml | 6 ++-- tiles3/src/site/xdoc/installation.xml | 2 +- tiles3/src/site/xdoc/userGuide.xml | 32 +++++++++---------- 15 files changed, 43 insertions(+), 43 deletions(-) diff --git a/tiles3/src/main/java/org/apache/struts/tiles3/TilesPlugin.java b/tiles3/src/main/java/org/apache/struts/tiles3/TilesPlugin.java index e0c5bcdfa..04b10fe55 100644 --- a/tiles3/src/main/java/org/apache/struts/tiles3/TilesPlugin.java +++ b/tiles3/src/main/java/org/apache/struts/tiles3/TilesPlugin.java @@ -30,7 +30,7 @@ import org.apache.struts.config.ControllerConfig; import org.apache.struts.config.ModuleConfig; import org.apache.struts.config.PlugInConfig; -import org.apache.struts.tiles2.util.PlugInConfigContextAdapter; +import org.apache.struts.tiles3.util.PlugInConfigContextAdapter; import org.apache.struts.util.RequestUtils; import org.apache.tiles.TilesContainer; import org.apache.tiles.TilesException; diff --git a/tiles3/src/main/java/org/apache/struts/tiles3/actions/DefinitionDispatcherAction.java b/tiles3/src/main/java/org/apache/struts/tiles3/actions/DefinitionDispatcherAction.java index 1df5443ab..718b4fee2 100644 --- a/tiles3/src/main/java/org/apache/struts/tiles3/actions/DefinitionDispatcherAction.java +++ b/tiles3/src/main/java/org/apache/struts/tiles3/actions/DefinitionDispatcherAction.java @@ -19,7 +19,7 @@ * under the License. */ -package org.apache.struts.tiles2.actions; +package org.apache.struts.tiles3.actions; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; @@ -52,7 +52,7 @@ * * * <action path="/saveSubscription" - * type="org.apache.struts.tiles2.actions.DefinitionDispatcherAction" + * type="org.apache.struts.tiles3.actions.DefinitionDispatcherAction" * parameter="def"/> * <forward name="success" path="anything" //> * <forward name="error" path="path.to.error.page" //> diff --git a/tiles3/src/main/java/org/apache/struts/tiles3/actions/ReloadDefinitionsAction.java b/tiles3/src/main/java/org/apache/struts/tiles3/actions/ReloadDefinitionsAction.java index 99770d707..b1dab3722 100644 --- a/tiles3/src/main/java/org/apache/struts/tiles3/actions/ReloadDefinitionsAction.java +++ b/tiles3/src/main/java/org/apache/struts/tiles3/actions/ReloadDefinitionsAction.java @@ -19,7 +19,7 @@ * under the License. */ -package org.apache.struts.tiles2.actions; +package org.apache.struts.tiles3.actions; import java.io.PrintWriter; diff --git a/tiles3/src/main/java/org/apache/struts/tiles3/actions/TilesAction.java b/tiles3/src/main/java/org/apache/struts/tiles3/actions/TilesAction.java index bf61f4232..9b1b3865f 100644 --- a/tiles3/src/main/java/org/apache/struts/tiles3/actions/TilesAction.java +++ b/tiles3/src/main/java/org/apache/struts/tiles3/actions/TilesAction.java @@ -19,7 +19,7 @@ * under the License. */ -package org.apache.struts.tiles2.actions; +package org.apache.struts.tiles3.actions; import javax.servlet.ServletException; import javax.servlet.http.HttpServletRequest; diff --git a/tiles3/src/main/java/org/apache/struts/tiles3/commands/TilesPreProcessor.java b/tiles3/src/main/java/org/apache/struts/tiles3/commands/TilesPreProcessor.java index 2a6913e2d..2df568253 100644 --- a/tiles3/src/main/java/org/apache/struts/tiles3/commands/TilesPreProcessor.java +++ b/tiles3/src/main/java/org/apache/struts/tiles3/commands/TilesPreProcessor.java @@ -18,7 +18,7 @@ * specific language governing permissions and limitations * under the License. */ -package org.apache.struts.tiles2.commands; +package org.apache.struts.tiles3.commands; import org.apache.commons.chain.Command; import org.apache.struts.chain.contexts.ServletActionContext; @@ -46,7 +46,7 @@ * *

    To initialize the {@code TilesDefinitionFactory}, use * {@code org.apache.struts.chain.commands.legacy.TilesPlugin}. This class is a - * simple extension to {@code org.apache.struts.tiles2.TilesPlugin} which + * simple extension to {@code org.apache.struts.tiles3.TilesPlugin} which * simply does not interfere with your choice of {@code RequestProcessor} * implementation.

    */ diff --git a/tiles3/src/main/java/org/apache/struts/tiles3/package-info.java b/tiles3/src/main/java/org/apache/struts/tiles3/package-info.java index a311aaca9..8469702d3 100644 --- a/tiles3/src/main/java/org/apache/struts/tiles3/package-info.java +++ b/tiles3/src/main/java/org/apache/struts/tiles3/package-info.java @@ -253,12 +253,12 @@ * *

    Definition File Syntax

    *

    The definition file syntax can be found in the - * tiles-config_1_4.dtd file. + * tiles-config_3_0.dtd file. *

    *

    Following is a simple example:

    * 
    <!DOCTYPE tiles-definitions PUBLIC
- *       "-//Apache Software Foundation//DTD Tiles Configuration 1.4//EN"
- *       "http://struts.apache.org/dtds/tiles-config_1_4.dtd">

    <!-- Definitions for Tiles documentation   -->
    <tiles-definitions>
+ *       "-//Apache Software Foundation//DTD Tiles Configuration 3.0//EN"
+ *       "http://tiles.apache.org/dtds/tiles-config_3_0.dtd">

    <!-- Definitions for Tiles documentation   -->
    <tiles-definitions>
  *
  *  <!-- ========================================================== -->
  *  <!-- Master definition                                          -->
@@ -295,4 +295,4 @@
  *   
  • Enable Tiles logging. See the commons-logging package help.
    • 
  * 
  */
-package org.apache.struts.tiles2;
\ No newline at end of file
+package org.apache.struts.tiles3;
\ No newline at end of file
diff --git a/tiles3/src/main/java/org/apache/struts/tiles3/preparer/ActionPreparer.java b/tiles3/src/main/java/org/apache/struts/tiles3/preparer/ActionPreparer.java
index 1a644893e..c4ad2e2fa 100644
--- a/tiles3/src/main/java/org/apache/struts/tiles3/preparer/ActionPreparer.java
+++ b/tiles3/src/main/java/org/apache/struts/tiles3/preparer/ActionPreparer.java
@@ -19,7 +19,7 @@
  * under the License.
  */
 
-package org.apache.struts.tiles2.preparer;
+package org.apache.struts.tiles3.preparer;
 
 import org.apache.struts.action.Action;
 import org.apache.tiles.AttributeContext;
diff --git a/tiles3/src/main/java/org/apache/struts/tiles3/preparer/StrutsPreparerFactory.java b/tiles3/src/main/java/org/apache/struts/tiles3/preparer/StrutsPreparerFactory.java
index 721dd2a7f..78391cc74 100644
--- a/tiles3/src/main/java/org/apache/struts/tiles3/preparer/StrutsPreparerFactory.java
+++ b/tiles3/src/main/java/org/apache/struts/tiles3/preparer/StrutsPreparerFactory.java
@@ -19,7 +19,7 @@
  * under the License.
  *
  */
-package org.apache.struts.tiles2.preparer;
+package org.apache.struts.tiles3.preparer;
 
 import org.apache.struts.action.Action;
 import org.apache.tiles.TilesException;
@@ -28,7 +28,7 @@
 import org.apache.tiles.request.reflect.ClassUtil;
 
 /**
- * Factory used to instantiate preparers in a Struts 1 / Tiles 2 environment.
+ * Factory used to instantiate preparers in a Struts 1 / Tiles 3 environment.
  *
  * @version $Rev$ $Date$
  */
diff --git a/tiles3/src/main/java/org/apache/struts/tiles3/preparer/UrlPreparer.java b/tiles3/src/main/java/org/apache/struts/tiles3/preparer/UrlPreparer.java
index aa4854313..b62c650b8 100644
--- a/tiles3/src/main/java/org/apache/struts/tiles3/preparer/UrlPreparer.java
+++ b/tiles3/src/main/java/org/apache/struts/tiles3/preparer/UrlPreparer.java
@@ -19,7 +19,7 @@
  * under the License.
  *
  */
-package org.apache.struts.tiles2.preparer;
+package org.apache.struts.tiles3.preparer;
 
 import java.io.IOException;
 
diff --git a/tiles3/src/main/java/org/apache/struts/tiles3/util/PlugInConfigContextAdapter.java b/tiles3/src/main/java/org/apache/struts/tiles3/util/PlugInConfigContextAdapter.java
index e71a8de38..7cf594559 100644
--- a/tiles3/src/main/java/org/apache/struts/tiles3/util/PlugInConfigContextAdapter.java
+++ b/tiles3/src/main/java/org/apache/struts/tiles3/util/PlugInConfigContextAdapter.java
@@ -19,7 +19,7 @@
  * under the License.
  */
 
-package org.apache.struts.tiles2.util;
+package org.apache.struts.tiles3.util;
 
 import java.util.Collections;
 import java.util.HashMap;
diff --git a/tiles3/src/site/site.xml b/tiles3/src/site/site.xml
index 734fec187..ba5f3a473 100644
--- a/tiles3/src/site/site.xml
+++ b/tiles3/src/site/site.xml
@@ -19,7 +19,7 @@
 -->
 
+  name="Struts Tiles 3">
     
         Apache Software Foundation
         ../images/asf-logo.png
@@ -70,8 +70,8 @@
             
 
-            
+            
 
         
 
diff --git a/tiles3/src/site/xdoc/examples.xml b/tiles3/src/site/xdoc/examples.xml
index c48f1ef14..e6aa51447 100644
--- a/tiles3/src/site/xdoc/examples.xml
+++ b/tiles3/src/site/xdoc/examples.xml
@@ -73,7 +73,7 @@
     file: layout.jsp
 
     
+<%@ taglib uri="http://tiles.apache.org/tags-tiles" prefix="tiles" %>
 
 
@@ -97,7 +97,7 @@
 
     file: somepage.jsp 
+<%@ taglib uri="http://tiles.apache.org/tags-tiles" prefix="tiles" %>
 
 
   
@@ -126,7 +126,7 @@
 
     file: somepage.jsp 
     
+<%@ taglib uri="http://tiles.apache.org/tags-tiles" prefix="tiles" %>
 
 
   
@@ -162,7 +162,7 @@
 
     file: somepage.jsp
     
+<%@ taglib uri="http://tiles.apache.org/tags-tiles" prefix="tiles" %>
 
 
     ]]>
diff --git a/tiles3/src/site/xdoc/index.xml b/tiles3/src/site/xdoc/index.xml
index c02273e3e..a79e0e3bd 100644
--- a/tiles3/src/site/xdoc/index.xml
+++ b/tiles3/src/site/xdoc/index.xml
@@ -29,7 +29,7 @@
 
 
 
-
    
+
    
     
    
         Welcome to the Struts Tiles component.Tiles is a templating
         system. (Include on steriods.) It can be used to create a common look
@@ -39,8 +39,8 @@
     
    
     
    
         Tiles can also be used without Struts. A new release of Tiles,
-        Tiles 2, is being prepared. If you would like to use Tiles without
-        Struts, see the new Apache Tiles 2
+        Tiles 3, is being prepared. If you would like to use Tiles without
+        Struts, see the new Apache Tiles 3
         project. The focus of this site is using Tiles with Struts.
     
    
 
    
diff --git a/tiles3/src/site/xdoc/installation.xml b/tiles3/src/site/xdoc/installation.xml
index 830382290..f22026c60 100644
--- a/tiles3/src/site/xdoc/installation.xml
+++ b/tiles3/src/site/xdoc/installation.xml
@@ -88,7 +88,7 @@
             add a line that declares the Tiles custom tag library.
 
     
+    <%@ taglib uri="http://tiles.apache.org/tags-tiles" prefix="tiles" %>
     ]]>
         
     
diff --git a/tiles3/src/site/xdoc/userGuide.xml b/tiles3/src/site/xdoc/userGuide.xml
index f227528df..b97cf6c14 100644
--- a/tiles3/src/site/xdoc/userGuide.xml
+++ b/tiles3/src/site/xdoc/userGuide.xml
@@ -45,31 +45,31 @@
     
 
     
+       "-//Apache Software Foundation//DTD Tiles Configuration 3.0//EN"
+       "http://tiles.apache.org/dtds/tiles-config_3_0.dtd">
 
     
 
-    
-        
-        
-        
-        
-        
+    
+        
+        
+        
+        
+        
     
 
-    
-        
-            
-            
-            
-            
+    
+        
+            
+            
+            
+            
       
     
 
     
-        
-        
+        
+