Skip to content

Commit

Permalink
Update manual URL
Browse files Browse the repository at this point in the history
  • Loading branch information
paultuckey committed Dec 26, 2021
1 parent 17b6b0a commit 5d6c290
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 9 deletions.
12 changes: 6 additions & 6 deletions README.md
@@ -1,24 +1,24 @@

# UrlRewriteFilter

### [UrlRewriteFilter Web Site](http://www.tuckey.org/urlrewrite/) | [Documentation](http://cdn.rawgit.com/paultuckey/urlrewritefilter/master/src/doc/manual/4.0/index.html)
### [UrlRewriteFilter Web Site](http://www.tuckey.org/urlrewrite/) | [Documentation](https://tuckey.org/urlrewrite/manual/4.0/index.html)


*Based on the popular and very useful [mod_rewrite](http://httpd.apache.org/docs-2.0/mod/mod_rewrite.html) for apache, UrlRewriteFilter is a Java Web Filter for any J2EE compliant web application server (such as [Resin](http://caucho.com), [Orion](http://www.orionserver.com/) or [Tomcat](http://tomcat.apache.org/)), which allows you to rewrite URLs before they get to your code. It is a very powerful tool just like Apache's mod_rewrite.*

URL rewriting is very common with Apache Web Server (see [mod_rewrite's rewriting guide](http://httpd.apache.org/docs-2.0/misc/rewriteguide.html)) but has not been possible in most java web application servers. The main things it is used for are:

* URL Tidyness / [URL Abstraction](http://cdn.rawgit.com/paultuckey/urlrewritefilter/master/src/doc/manual/4.0/guide.html#urlabs) - keep URLs tidy irrespective of the underlying technology or framework (JSP, Servlet, Struts etc).
* URL Tidyness / [URL Abstraction](https://tuckey.org/urlrewrite/manual/4.0/guide.html#urlabs) - keep URLs tidy irrespective of the underlying technology or framework (JSP, Servlet, Struts etc).
* Browser Detection - Allows you to rewrite URLs based on request HTTP headers (such as user-agent or charset).
* Date based rewriting - Allows you to forward or redirect to other URL's based on the date/time (good for planned outages).
* Moved content - enable a graceful move of content or even a change in CMS.
* Tiny/Friendly URL's (i.e. blah.com/latest can be redirected to blah.com/download/ver1.2.46.2/setup.exe)
* A Servlet mapping engine (see [Method Invocation](http://cdn.rawgit.com/paultuckey/urlrewritefilter/master/src/doc/manual/4.0/guide.html#method))
* A Servlet mapping engine (see [Method Invocation](https://tuckey.org/urlrewrite/manual/4.0/guide.html#method))


!UrlRewriteFilter uses an xml file, called urlrewrite.xml (it goes into the WEB-INF directory), for configuration. Most parameters can be Perl5 style Regular Expressions or Wildcard Expressions. This makes it very powerful indeed.

See the [manual](http://cdn.rawgit.com/paultuckey/urlrewritefilter/master/src/doc/manual/4.0/index.html) for more information.
See the [manual](https://tuckey.org/urlrewrite/manual/4.0/index.html) for more information.


## Quick Start
Expand All @@ -31,7 +31,7 @@ See the [manual](http://cdn.rawgit.com/paultuckey/urlrewritefilter/master/src/do
<version>4.0.3</version>
</dependency>
```
* Add the following to your WEB-INF/web.xml (add it near the top above your servlet mappings (if you have any)): (see <a href="http://cdn.rawgit.com/paultuckey/urlrewritefilter/master/src/doc/manual/4.0/index.html#filterparams">filter parameters</a> for more options)
* Add the following to your WEB-INF/web.xml (add it near the top above your servlet mappings (if you have any)): (see <a href="https://tuckey.org/urlrewrite/manual/4.0/index.html#filterparams">filter parameters</a> for more options)
```xml
<filter>
<filter-name>UrlRewriteFilter</filter-name>
Expand All @@ -44,7 +44,7 @@ See the [manual](http://cdn.rawgit.com/paultuckey/urlrewritefilter/master/src/do
<dispatcher>FORWARD</dispatcher>
</filter-mapping>
```
* Add <b><a href="http://cdn.rawgit.com/paultuckey/urlrewritefilter/master/src/doc/manual/4.0/urlrewrite.xml">urlrewrite.xml</a></b> into your WEB-INF directory. (src/main/webapp/WEB-INF/ for Maven users)
* Add <b><a href="https://tuckey.org/urlrewrite/manual/4.0/urlrewrite.xml">urlrewrite.xml</a></b> into your WEB-INF directory. (src/main/webapp/WEB-INF/ for Maven users)
* Restart the context.

You can visit http://127.0.0.1:8080/rewrite-status (or whatever the address of your local webapp and context) to see output (note: this page is only viewable from localhost).
Expand Down
2 changes: 1 addition & 1 deletion src/doc/manual/4.0/index.html
Expand Up @@ -107,7 +107,7 @@ <h2>Install</h2>
&lt;dispatcher&gt;REQUEST&lt;/dispatcher&gt;
&lt;dispatcher&gt;FORWARD&lt;/dispatcher&gt;
&lt;/filter-mapping&gt;</code></pre></li>
<li>Add <b><a href="http://cdn.rawgit.com/paultuckey/urlrewritefilter/master/src/doc/manual/4.0/urlrewrite.xml">urlrewrite.xml</a></b>
<li>Add <b><a href="https://tuckey.org/urlrewrite/manual/4.0/urlrewrite.xml">urlrewrite.xml</a></b>
into your WEB-INF directory. (src/main/webapp/WEB-INF/ for Maven users)</li>
<li>Restart the context.</li>
</ol>
Expand Down
2 changes: 1 addition & 1 deletion src/doc/manual/5.0/index.html
Expand Up @@ -106,7 +106,7 @@ <h2>Install</h2>
&lt;dispatcher&gt;REQUEST&lt;/dispatcher&gt;
&lt;dispatcher&gt;FORWARD&lt;/dispatcher&gt;
&lt;/filter-mapping&gt;</code></pre></li>
<li>Add <b><a href="http://cdn.rawgit.com/paultuckey/urlrewritefilter/master/src/doc/manual/4.0/urlrewrite.xml">urlrewrite.xml</a></b>
<li>Add <b><a href="https://tuckey.org/urlrewrite/manual/4.0/urlrewrite.xml">urlrewrite.xml</a></b>
into your WEB-INF directory. (src/main/webapp/WEB-INF/ for Maven users)</li>
<li>Restart the context.</li>
</ol>
Expand Down
2 changes: 1 addition & 1 deletion src/site/site.xml
Expand Up @@ -29,7 +29,7 @@
<item name="Home" href="http://www.tuckey.org/urlrewrite/"/>
<item name="Download" href="http://www.tuckey.org/urlrewrite/#download"/>
<item name="Source" href="https://github.com/paultuckey/urlrewritefilter"/>
<item name="Manual" href="http://cdn.rawgit.com/paultuckey/urlrewritefilter/master/src/doc/manual/4.0/index.html"/>
<item name="Manual" href="https://tuckey.org/urlrewrite/manual/4.0/index.html"/>
</menu>

<menu name="Generated Documentation" ref="reports"/>
Expand Down

0 comments on commit 5d6c290

Please sign in to comment.