| <!DOCTYPE html> |
| |
| |
| <!-- |
| | Generated by Apache Maven Doxia Site Renderer 2.0.0 from src/site/xdoc/howto/url-rewriting-howto.xml at 10 Sep 2025 |
| | Rendered using Apache Maven Fluido Skin 2.1.0 |
| --> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1" /> |
| <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0" /> |
| <title>URL Rewriting Howto – Apache Turbine</title> |
| <link rel="stylesheet" href="../css/apache-maven-fluido-2.1.0.min.css" /> |
| <link rel="stylesheet" href="../css/site.css" /> |
| <link rel="stylesheet" href="../css/print.css" media="print" /> |
| <script src="../js/apache-maven-fluido-2.1.0.min.js"></script> |
| <link rel="icon" type="image/png" sizes="48x48" href="https://apache.org/favicons/favicon.ico"> |
| <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
| <style>.github-fork-ribbon:before { background-color: orange; }</style> |
| </head> |
| <body> |
| <a class="github-fork-ribbon right-top" href="https://github.com/apache/turbine-build" data-ribbon="Fork me on GitHub">Fork me on GitHub</a> |
| <div class="container-fluid container-fluid-top"> |
| <header> |
| <div id="banner"> |
| <div class="pull-left"><div id="bannerLeft"><h1><a href="https://turbine.apache.org/"><img src="https://www.apache.org/img/feather_glyph_notm.png" style="width: 50px;" /> The Apache Turbine project</a></h1></div></div> |
| <div class="pull-right"><div id="bannerRight"><h1><a href="https://turbine.apache.org/"><img src="https://turbine.apache.org/images/logo.gif" alt="Apache Turbine" /></a></h1></div></div> |
| <div class="clear"><hr/></div> |
| </div> |
| |
| <div id="breadcrumbs"> |
| <ul class="breadcrumb"> |
| <li id="publishDate">Last Published: 01 Apr 2025<span class="divider">|</span> |
| </li> |
| <li id="projectVersion">Version: 7.1-SNAPSHOT</li> |
| <li class="pull-right"><span class="divider">|</span> |
| <a href="https://turbine.apache.org/fulcrum/">Fulcrum</a></li> |
| <li class="pull-right"><span class="divider">|</span> |
| <a href="https://turbine.apache.org/">Turbine</a></li> |
| <li class="pull-right"><a href="https://www.apache.org">Apache</a></li> |
| </ul> |
| </div> |
| </header> |
| <div class="row-fluid"> |
| <header id="leftColumn" class="span2"> |
| <nav class="well sidebar-nav"> |
| <ul class="nav nav-list"> |
| <li class="nav-header">General Information</li> |
| <li><a href="../index.html">Overview</a></li> |
| <li><a href="../features.html">Features</a></li> |
| <li><a href="../fsd.html">Specification</a></li> |
| <li><a href="../getting-started.html">Getting Started</a></li> |
| <li><a href="../how-to-build.html">Howto Build Turbine</a></li> |
| <li><a href="../changes-report.html">Changes</a></li> |
| <li class="nav-header">Documentation</li> |
| <li><a href="../services/index.html"><span class="icon-chevron-right"></span>Services</a></li> |
| <li><a href="../howto/index.html"><span class="icon-chevron-down"></span>Howtos</a> |
| <ul class="nav nav-list"> |
| <li><a href="../howto/action-event-howto.html">Action Events Howto</a></li> |
| <li><a href="../howto/annotations.html">Annotations Howto</a></li> |
| <li><a href="../howto/configuration-howto.html">Configuration Howto</a></li> |
| <li><a href="../howto/extend-user-howto.html">Extend User Howto</a></li> |
| <li><a href="../howto/hibernate-howto.html">Hibernate OM Howto</a></li> |
| <li><a href="../howto/intake-howto.html">Intake Howto</a></li> |
| <li><a href="../howto/jsp-howto.html">JSP Howto</a></li> |
| <li><a href="../howto/migrate-from-2_1-howto.html">Migrating from 2.1 to 2.2</a></li> |
| <li><a href="../howto/migrate-from-2_2-howto.html">Migrating from 2.2 to 2.3</a></li> |
| <li><a href="../howto/migrate-from-2_3-howto.html">Migrating from 2.3 to 4.0</a></li> |
| <li><a href="../howto/migrate-from-4_0-howto.html">Migrating from 4.0 to 5.0</a></li> |
| <li><a href="../howto/pullmodel-howto.html">Pull Model Howto</a></li> |
| <li><a href="../howto/python-howto.html">Python Howto</a></li> |
| <li><a href="../howto/security-howto.html">Security Howto</a></li> |
| <li><a href="../howto/services-howto.html">Services Howto</a></li> |
| <li><a href="../howto/url-mapper-howto.html">URL Mapper Howto</a></li> |
| <li class="active"><a>URL Rewriting Howto</a></li> |
| <li><a href="../howto/context-howto.html">Velocity Context Howto</a></li> |
| <li><a href="../howto/velocity-site-howto.html">Velocity Site Howto</a></li> |
| <li><a href="../howto/velocityonlylayout-howto.html">VelocityOnlyLayout Howto</a></li> |
| </ul></li> |
| <li><a href="https://cwiki.apache.org/confluence/display/TURBINE">Wiki</a></li> |
| <li><a href="../apidocs/index.html">JavaDocs</a></li> |
| <li class="nav-header">Development</li> |
| <li><a href="../proposals.html">Proposals</a></li> |
| <li><a href="../how-to-help.html">How To Help</a></li> |
| <li><a href="../todo.html">Todo</a></li> |
| <li class="nav-header">Project Documentation</li> |
| <li><a href="../project-info.html"><span class="icon-chevron-right"></span>Project Information</a></li> |
| <li><a href="../project-reports.html"><span class="icon-chevron-right"></span>Project Reports</a></li> |
| <li class="nav-header">Apache</li> |
| <li><a href="https://www.apache.org/">Apache Website</a></li> |
| <li><a href="https://www.apache.org/licenses/">License</a></li> |
| <li><a href="https://www.apache.org/foundation/how-it-works.html">How the ASF works</a></li> |
| <li><a href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li> |
| <li><a href="https://www.apache.org/foundation/thanks.html">Thanks</a></li> |
| <li><a href="https://www.apache.org/security/">Security</a></li> |
| </ul> |
| </nav> |
| <div class="well sidebar-nav"> |
| <form id="search-form" action="https://www.google.com/search" method="get" > |
| <input value="http://turbine.apache.org/turbine/turbine-7-0" name="sitesearch" type="hidden" /> |
| <input class="search-query" name="q" id="query" type="text" placeholder="Search with Google..." /> |
| </form> |
| <div id="poweredBy"> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <a href="https://maven.apache.org/" class="builtBy" target="_blank"><img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /></a> |
| </div> |
| </div> |
| </header> |
| <main id="bodyColumn" class="span10"> |
| |
| |
| |
| |
| <section><a id="Scenario_and_Overview"></a> |
| <h1>Scenario and Overview</h1> |
| |
| |
| <p> |
| Unaltered Turbine URLs look like this: |
| <code>http://www.foo.com:8080/CONTEXT/servlet/MAPPING/template/Foo.vm</code>.<br /> |
| But you want shorter URLs, or you don't like exposing the use of |
| servlets in the URL. Maybe this url would suit you better: |
| <code>http://www.foo.com:8080/po/s/la/template/Foo.vm</code> |
| </p> |
| |
| |
| <p> |
| The bulk of the url is defined by the servlet api and is outside of the |
| control of Turbine: |
| </p> |
| <pre> |
| http://www.foo.com/CONTEXT/servlet/MAPPING/template/Foo.vm |
| [ servlet api defined ][ turbine ]</pre> |
| |
| This HOWTO describes how you can control the servlet part of the url |
| in Tomcat. For other servlet environments you'll have to consult |
| their documentation. |
| |
| |
| |
| <p> |
| Three parts of the url will be addresed: |
| </p> |
| <ol style="list-style-type: decimal;"> |
| |
| <li>the web application context (CONTEXT in the example above),</li> |
| |
| <li>the servlet prefix (servlet),</li> |
| |
| <li>and the servlet mapping (MAPPING).</li> |
| </ol> |
| |
| |
| </section> |
| |
| <section><a id="The_Context"></a> |
| <h1>The Context</h1> |
| |
| |
| <p> |
| You need to register the context with Tomcat. If you have given your |
| application a short name like 'po' and placed it correctly in the |
| webapps directory, then you won't need to do anything special. Tomcat |
| will find the directory, and add a context. If you have a long |
| application name like 'mywonderfulapp', add the following lines to |
| Tomcat's server.xml file: |
| </p> |
| |
| |
| <pre class="prettyprint"><code> |
| <Context |
| path="/po" |
| docBase="webapps/mywonderfulapp" |
| reloadable="true" |
| debug="0" |
| trusted="false" > |
| </Context> |
| </code></pre> |
| |
| |
| <p> |
| Everthing after the docBase= line is obviously up to you. This tells |
| Tomcat to add a context named 'po' with the docbase of your |
| application. |
| </p> |
| |
| </section> |
| |
| <section><a id="The_Servlet_Prefix"></a> |
| <h1>The Servlet Prefix</h1> |
| |
| |
| <p> |
| Modifying the servlet prefix also requires editing Tomcat's server.xml |
| file. Tomcat will use this prefix to determine if a given request is |
| for a servlet. Edit the following lines: |
| </p> |
| |
| |
| <pre class="prettyprint"><code> |
| <RequestInterceptor |
| className="org.apache.tomcat.request.InvokerInterceptor" |
| debug="0" prefix="/s/" /> |
| </code></pre> |
| |
| |
| <p> |
| With this modification, Tomcat recognize requests containing /s/ in |
| the url as a servlet request and will look for the servlet in the |
| web.xml descriptor. |
| </p> |
| |
| </section> |
| |
| <section><a id="The_Servlet_Name"></a> |
| <h1>The Servlet Name</h1> |
| |
| <p> |
| This is defined in web.xml (which you will find here: |
| <code>webapps/WEB-INF/web.xml</code>). This is automatically given |
| the name of your application in Turbine. To change it, simply edit the |
| web.xml file as follows: |
| </p> |
| |
| |
| <pre class="prettyprint"><code> |
| <servlet-name> |
| la |
| </servlet-name> |
| </code></pre> |
| |
| |
| <p> |
| <strong>If you are using Tomcat standalone, then you are done and your url is |
| now <code>http://servername:port:/po/s/la</code></strong> |
| </p> |
| |
| </section> |
| |
| <section><a id="If_you_are_running_Apache_and_mod_jk"></a> |
| <h1>If you are running Apache and mod_jk</h1> |
| |
| |
| <p> |
| ... you will need to change your mod_jk.conf file to include the following: |
| </p> |
| |
| |
| <pre class="prettyprint"><code> |
| ######################################################### |
| # Auto configuration for the /po context starts. |
| ######################################################### |
| |
| # |
| # Make Apache aware of the location of the context |
| # |
| Alias /po "serverroot/webapps/mywonderfulapp" |
| <Directory "serverroot/webapps/mywonderfulapp"> |
| Options Indexes FollowSymLinks |
| </Directory> |
| |
| # |
| # Mount all JSP files and the /servlet/ uri to Tomcat |
| # |
| JkMount /po/s/* ajp12 |
| JkMount /po/*.jsp ajp12 |
| |
| # |
| # Prohibit users from directly accessing WEB-INF |
| # |
| <Location "/mywonderfulapp/WEB-INF/"> |
| AllowOverride None |
| deny from all |
| </Location> |
| |
| # |
| # Prohibit users from directly accessing META-INF |
| # |
| <Location "/mywonderfulapp/META-INF/"> |
| AllowOverride None |
| deny from all |
| </Location> |
| |
| ####################################################### |
| # Auto configuration for the /po context ends. |
| ####################################################### |
| </code></pre> |
| |
| |
| <p> |
| document created August 14, 2001 |
| </p> |
| |
| </section> |
| |
| |
| </main> |
| </div> |
| </div> |
| <hr/> |
| <footer> |
| <div class="container-fluid"> |
| <div class="row-fluid"> |
| <p>© 2000–2025 |
| <a href="https://www.apache.org/">The Apache Software Foundation</a> |
| </p> |
| </div> |
| </div> |
| </footer> |
| </body> |
| </html> |
