Skip to content
OCPsoft URL-Rewriting Framework
Java Ruby JavaScript HTML Other
Latest commit 4dffdf3 @chkal chkal Merge pull request #221 from ceefour/patch-1
Upgrade ocpsoft.logging to 1.0.4.Final
Failed to load latest commit information.
addressbuilder junit.framework.* -> org.junit.*
annotations-api [maven-release-plugin] prepare for next development iteration
annotations-impl junit.framework.* -> org.junit.*
api-el [maven-release-plugin] prepare for next development iteration
api-servlet junit.framework.* -> org.junit.*
api-tests Added the ability to tell if a condition has been negated
api Added the ability to tell if a condition has been negated
config-annotations junit.framework.* -> org.junit.*
config-jodatime junit.framework.* -> org.junit.*
config-prettyfaces-tests Migrated FEST Asserts -> AssertJ
config-prettyfaces Attempt to fix release build
config-proxy [maven-release-plugin] prepare for next development iteration
config-servlet-tests [maven-release-plugin] prepare for next development iteration
config-servlet junit.framework.* -> org.junit.*
config-tuckey Attempt to fix release build
distribution [maven-release-plugin] prepare for next development iteration
documentation Attempt to fix release build
examples [maven-release-plugin] prepare for next development iteration
impl-servlet-2.5 [maven-release-plugin] prepare for next development iteration
impl-servlet-3.0 [maven-release-plugin] prepare for next development iteration
impl-servlet-tests [maven-release-plugin] prepare for next development iteration
impl-servlet [maven-release-plugin] prepare for next development iteration
impl-tests
impl [maven-release-plugin] prepare for next development iteration
integration-cdi-tests [maven-release-plugin] prepare for next development iteration
integration-cdi Typo
integration-faces-tests Looks like JSessionIdTest doesn't work on Wildfly (and AS7, and Glass…
integration-faces #215 - making volatile List<FacesActionUrlProvider> providers
integration-gwt
integration-spring junit.framework.* -> org.junit.*
rewrite-servlet [maven-release-plugin] prepare for next development iteration
security-integration-shiro [maven-release-plugin] prepare for next development iteration
showcase [maven-release-plugin] prepare for next development iteration
test-base [maven-release-plugin] prepare for next development iteration
test-harness Updated to Wildfly 8.2.0.Final
transform-less Tests ignored on Wildfly for now (see #211)
transform-markup junit.framework.* -> org.junit.*
transform-minify Attempt to fix release build
transform [maven-release-plugin] prepare for next development iteration
.gitignore
.travis-deploy.sh Skip GPG signing when doing snapshot deployment
.travis-settings.xml
.travis.yml Workaround for missing exec permission
CHANGELOG.md changelog again
LICENSE Initial import
NOTICE rewrite-servlet and distribution modules working
README.md Added Travis build status to README
ocpsoft-eclipse-code-format.xml Added code style format profile for Eclipse
pom.xml Upgrade ocpsoft.logging to 1.0.4.Final

README.md

Rewrite Build Status

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

Get Started

  1. 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.

  2. Include OCPSoft Rewrite in your application's POM file:

    <dependency>
       <groupId>org.ocpsoft.rewrite</groupId>
       <artifactId>rewrite-servlet</artifactId>
       <version>${rewrite.version}</version>
    </dependency>
    
  3. 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()
           .defineRule()
             .when(Direction.isInbound().and(Path.matches("/some/page/{p}/")))
             .perform(Forward.to("/new-page/{p}.html"));
        }
    }
    
  4. You must either annotate your ConfigurationProvider class with the @RewriteConfiguration annotation, OR create a file named: '/META-INF/services/org.ocpsoft.rewrite.config.ConfigurationProvider' which contains the fully qualified name of your ConfigurationProvider implementation:

    /META-INF/services/org.ocpsoft.rewrite.config.ConfigurationProvider
    ---
    com.example.ExampleConfigurationProvider
    
  5. 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.

  6. Consider using Rewrite extensions for extra power:

  7. 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

Something went wrong with that request. Please try again.