com.ocpsoft.rewrite:rewrite-api-servlet


License

License

GroupId

GroupId

com.ocpsoft.rewrite
ArtifactId

ArtifactId

rewrite-api-servlet
Last Version

Last Version

1.0.0.Alpha11
Release Date

Release Date

Type

Type

jar
Description

Description

Download rewrite-api-servlet

How to add to project

<!-- https://jarcasting.com/artifacts/com.ocpsoft.rewrite/rewrite-api-servlet/ -->
<dependency>
    <groupId>com.ocpsoft.rewrite</groupId>
    <artifactId>rewrite-api-servlet</artifactId>
    <version>1.0.0.Alpha11</version>
</dependency>
// https://jarcasting.com/artifacts/com.ocpsoft.rewrite/rewrite-api-servlet/
implementation 'com.ocpsoft.rewrite:rewrite-api-servlet:1.0.0.Alpha11'
// https://jarcasting.com/artifacts/com.ocpsoft.rewrite/rewrite-api-servlet/
implementation ("com.ocpsoft.rewrite:rewrite-api-servlet:1.0.0.Alpha11")
'com.ocpsoft.rewrite:rewrite-api-servlet:jar:1.0.0.Alpha11'
<dependency org="com.ocpsoft.rewrite" name="rewrite-api-servlet" rev="1.0.0.Alpha11">
  <artifact name="rewrite-api-servlet" type="jar" />
</dependency>
@Grapes(
@Grab(group='com.ocpsoft.rewrite', module='rewrite-api-servlet', version='1.0.0.Alpha11')
)
libraryDependencies += "com.ocpsoft.rewrite" % "rewrite-api-servlet" % "1.0.0.Alpha11"
[com.ocpsoft.rewrite/rewrite-api-servlet "1.0.0.Alpha11"]

Dependencies

compile (1)

Group / Artifact Type Version
com.ocpsoft.rewrite : rewrite-api jar 1.0.0.Alpha11

provided (1)

Group / Artifact Type Version
org.jboss.spec.javax.servlet : jboss-servlet-api_3.0_spec jar

test (2)

Group / Artifact Type Version
com.ocpsoft.rewrite : rewrite-test-harness jar 1.0.0.Alpha11
junit : junit jar 4.8.1

Project Modules

There are no modules declared in this project.

Rewrite Build Status

Join the chat at https://gitter.im/ocpsoft/rewrite

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()
            .addRule()
              .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
    

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.

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

  2. Consider using Rewrite extensions for extra power:

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

com.ocpsoft.rewrite

OCPsoft

Versions

Version
1.0.0.Alpha11
1.0.0.Alpha10
1.0.0.Alpha9
1.0.0.Alpha8
1.0.0.Alpha7
1.0.0.Alpha6
1.0.0.Alpha5
1.0.0.Alpha4
1.0.0.Alpha3
1.0.0.Alpha2
1.0.0.Alpha1