JarCastingRewrite 
A highly configurable URL-rewriting tool for Java EE 6+ and Servlet 2.5+ applications, supporting integration with:
- CDI
- Spring DI
- JodaTime configuration
- Tuckey.org URLRewriteFilter configuration
- JavaServer Faces (JSF)
- JavaServer Pages (JSP)
- Struts
- Wicket
- Grails
- Spring Roo
- Spring Web Flow
- Any servlet & web framework!
- All major servlet containers and application servers
Get Help
- Support forum: http://ocpsoft.org/support/forum/rewrite-users/
- Documentation: http://ocpsoft.org/rewrite/docs/
Get Started
-
It is recommended but not required to remove other URL-rewriting tools from your application before using Rewrite. If you choose to leave them in place, weird things may happen, be warned.
-
Include OCPSoft Rewrite in your application's POM file:
<dependency> <groupId>org.ocpsoft.rewrite</groupId> <artifactId>rewrite-servlet</artifactId> <version>${rewrite.version}</version> </dependency> -
Add a configuration provider implementing the 'org.ocpsoft.rewrite.config.ConfigurationProvider' interface, or extending from the abstract HttpConfigurationProvider class for convenience:
package com.example; @RewriteConfiguration public class ExampleConfigurationProvider extends HttpConfigurationProvider { @Override public int priority() { return 10; } @Override public Configuration getConfiguration(final ServletContext context) { return ConfigurationBuilder.begin() .addRule() .when(Direction.isInbound().and(Path.matches("/some/page/{p}/"))) .perform(Forward.to("/new-page/{p}.html")); } } -
You must either annotate your
ConfigurationProviderclass with the @RewriteConfiguration annotation, OR create a file named: '/META-INF/services/org.ocpsoft.rewrite.config.ConfigurationProvider' which contains the fully qualified name of yourConfigurationProviderimplementation:/META-INF/services/org.ocpsoft.rewrite.config.ConfigurationProvider --- com.example.ExampleConfigurationProvider
Note that your annotated class won't be found, by default, if your ConfigurationProvider is in a jar inside a war. You can either set the servlet parameter org.ocpsoft.rewrite.annotation.SCAN_LIB_DIRECTORY to true, or use the ServiceLoader approach instead.
-
Add rules to your configuration. Condition objects such as 'Direction.isInbound()' and 'Path.matches(...)' can be found in the 'org.ocpsoft.rewrite.config.' and 'org.ocpsoft.rewrite.servlet.config.' packages.
-
Consider using Rewrite extensions for extra power:
- JodaTime Integration
- Tuckey URLRewriteFilter Integration
- CDI Integration
- And more... read the Documentation
-
Run your application!
FEEDBACK
This project is looking for your feedback! What would make your task easier? How can we simplify this experience?
TODO's
-
Continue simplification of Configuration objects and convenience APIs.
-
Implement additional xml & file-based configuration support.
-
Implement http://localhost:8080/rewrite-status monitoring tool
