Module org.eclipse.jetty.rewrite
Package org.eclipse.jetty.rewrite.handler

Class RewriteHandler

java.lang.Object
org.eclipse.jetty.util.component.AbstractLifeCycle
org.eclipse.jetty.util.component.ContainerLifeCycle
org.eclipse.jetty.server.handler.AbstractHandler
org.eclipse.jetty.server.handler.AbstractHandlerContainer
org.eclipse.jetty.server.handler.HandlerWrapper
org.eclipse.jetty.rewrite.handler.RewriteHandler
All Implemented Interfaces:
org.eclipse.jetty.server.Handler, org.eclipse.jetty.server.HandlerContainer, org.eclipse.jetty.util.component.Container, org.eclipse.jetty.util.component.Destroyable, org.eclipse.jetty.util.component.Dumpable, org.eclipse.jetty.util.component.Dumpable.DumpableContainer, org.eclipse.jetty.util.component.LifeCycle
public class RewriteHandler extends org.eclipse.jetty.server.handler.HandlerWrapper

Rewrite handler is responsible for managing the rules. Its capabilities is not only limited for URL rewrites such as RewritePatternRule or RewriteRegexRule. There is also handling for cookies, headers, redirection, setting status or error codes whenever the rule finds a match.

The rules can be matched by the either: pattern matching of @ServletPathSpec (eg PatternRule), regular expressions (eg RegexRule) or certain conditions set (eg MsieSslRule - the requests must be in SSL mode).

The rules can be grouped into rule containers (class RuleContainer), and will only be applied if the request matches the conditions for their container (e.g., by virtual host name)

The list of predefined rules is:

Here is a typical jetty.xml configuration would be: 

     <New id="RewriteHandler" class="org.eclipse.jetty.rewrite.handler.RewriteHandler">
       <Set name="rules">
         <Array type="org.eclipse.jetty.rewrite.handler.Rule">

           <Item>
             <New id="rewrite" class="org.eclipse.jetty.rewrite.handler.RewritePatternRule">
               <Set name="pattern">/*</Set>
               <Set name="replacement">/test</Set>
             </New>
           </Item>

           <Item>
             <New id="response" class="org.eclipse.jetty.rewrite.handler.ResponsePatternRule">
               <Set name="pattern">/session/</Set>
               <Set name="code">400</Set>
               <Set name="reason">Setting error code 400</Set>
             </New>
           </Item>

           <Item>
             <New id="header" class="org.eclipse.jetty.rewrite.handler.HeaderPatternRule">
               <Set name="pattern">*.jsp</Set>
               <Set name="name">server</Set>
               <Set name="value">dexter webserver</Set>
             </New>
           </Item>

           <Item>
             <New id="header" class="org.eclipse.jetty.rewrite.handler.HeaderPatternRule">
               <Set name="pattern">*.jsp</Set>
               <Set name="name">title</Set>
               <Set name="value">driven header purpose</Set>
             </New>
           </Item>

           <Item>
             <New id="redirect" class="org.eclipse.jetty.rewrite.handler.RedirectPatternRule">
               <Set name="pattern">/test/dispatch</Set>
               <Set name="location">http://jetty.eclipse.org</Set>
             </New>
           </Item>

           <Item>
             <New id="regexRewrite" class="org.eclipse.jetty.rewrite.handler.RewriteRegexRule">
               <Set name="regex">/test-jaas/$</Set>
               <Set name="replacement">/demo</Set>
             </New>
           </Item>

           <Item>
             <New id="forwardedHttps" class="org.eclipse.jetty.rewrite.handler.ForwardedSchemeHeaderRule">
               <Set name="header">X-Forwarded-Scheme</Set>
               <Set name="headerValue">https</Set>
               <Set name="scheme">https</Set>
             </New>
           </Item>

           <Item>
             <New id="virtualHost" class="org.eclipse.jetty.rewrite.handler.VirtualHostRuleContainer">

               <Set name="virtualHosts">
                 <Array type="java.lang.String">
                   <Item>eclipse.com</Item>
                   <Item>www.eclipse.com</Item>
                   <Item>eclipse.org</Item>
                   <Item>www.eclipse.org</Item>
                 </Array>
               </Set>

               <Call name="addRule">
                 <Arg>
                   <New class="org.eclipse.jetty.rewrite.handler.CookiePatternRule">
                     <Set name="pattern">/*</Set>
                     <Set name="name">CookiePatternRule</Set>
                     <Set name="value">1</Set>
                   </New>
                 </Arg>
               </Call>

             </New>
           </Item>

         </Array>
       </Set>
     </New>

     <Set name="handler">
       <Ref id="RewriteHandler"/>
         <Set name="handler">
           <New id="Handlers" class="org.eclipse.jetty.server.handler.HandlerCollection">
             <Set name="handlers">
               <Array type="org.eclipse.jetty.server.Handler">
                 <Item>
                   <New id="Contexts" class="org.eclipse.jetty.server.handler.ContextHandlerCollection"/>
                 </Item>
                 <Item>
                   <New id="DefaultHandler" class="org.eclipse.jetty.server.handler.DefaultHandler"/>
                 </Item>
               </Array>
             </Set>
           </New>
         </Set>
       </Ref>
     </Set>

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.eclipse.jetty.server.handler.AbstractHandler

    org.eclipse.jetty.server.handler.AbstractHandler.ErrorDispatchHandler

    Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

    org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener, org.eclipse.jetty.util.component.AbstractLifeCycle.StopException

    Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container

    org.eclipse.jetty.util.component.Container.InheritedListener, org.eclipse.jetty.util.component.Container.Listener

    Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable

    org.eclipse.jetty.util.component.Dumpable.DumpableContainer

    Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

    org.eclipse.jetty.util.component.LifeCycle.Listener

  • Field Summary

    Fields inherited from class org.eclipse.jetty.server.handler.HandlerWrapper

    _handler

    Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

    FAILED, STARTED, STARTING, STOPPED, STOPPING

    Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

    KEY

  • Constructor Summary

    Constructors
    Constructor
    Description
    RewriteHandler()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addRule(Rule rule)
    Add a Rule
    EnumSet<jakarta.servlet.DispatcherType>
    getDispatcherTypes()
     
    String
    getOriginalPathAttribute()
     
    RuleContainer
    getRuleContainer()
     
    Rule[]
    getRules()
    Returns the list of rules.
    void
    handle(String target, org.eclipse.jetty.server.Request baseRequest, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
     
    boolean
    isRewritePathInfo()
     
    boolean
    isRewriteRequestURI()
     
    void
    setDispatcherTypes(jakarta.servlet.DispatcherType... types)
     
    void
    setDispatcherTypes(EnumSet<jakarta.servlet.DispatcherType> types)
     
    void
    setOriginalPathAttribute(String originalPathAttribute)
     
    void
    setRewritePathInfo(boolean rewritePathInfo)
     
    void
    setRewriteRequestURI(boolean rewriteRequestURI)
     
    void
    setRuleContainer(RuleContainer rules)
    Assigns the rules to process.
    void
    setRules(Rule[] rules)
    Assigns the rules to process.

    Methods inherited from class org.eclipse.jetty.server.handler.HandlerWrapper

    destroy, expandChildren, getHandler, getHandlers, insertHandler, setHandler

    Methods inherited from class org.eclipse.jetty.server.handler.AbstractHandlerContainer

    expandHandler, findContainerOf, getChildHandlerByClass, getChildHandlers, getChildHandlersByClass, setServer

    Methods inherited from class org.eclipse.jetty.server.handler.AbstractHandler

    doError, doStart, doStop, getServer

    Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle

    addBean, addBean, addEventListener, addManaged, contains, dump, dump, dump, dumpObjects, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, start, stop, unmanage, updateBean, updateBean, updateBeans, updateBeans

    Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

    getEventListeners, getState, getState, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, setEventListeners, start, stop, toString

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.eclipse.jetty.util.component.Container

    getCachedBeans, getEventListeners

    Methods inherited from interface org.eclipse.jetty.util.component.Dumpable

    dumpSelf

    Methods inherited from interface org.eclipse.jetty.util.component.Dumpable.DumpableContainer

    isDumpable

    Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle

    addEventListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeEventListener, start, stop

  • Constructor Details

    • RewriteHandler

      public RewriteHandler()

  • Method Details

    • getRules

      public Rule[] getRules()
      Returns the list of rules.
      Returns:
      an array of Rule.

    • setRules

      public void setRules(Rule[] rules)
      Assigns the rules to process.
      Parameters:
      rules - an array of Rule.

    • setRuleContainer

      public void setRuleContainer(RuleContainer rules)
      Assigns the rules to process.
      Parameters:
      rules - a RuleContainer containing other rules to process

    • getRuleContainer

      public RuleContainer getRuleContainer()

    • addRule

      public void addRule(Rule rule)
      Add a Rule
      Parameters:
      rule - The rule to add to the end of the rules array

    • isRewriteRequestURI

      public boolean isRewriteRequestURI()
      Returns:
      the rewriteRequestURI If true, this handler will rewrite the value returned by HttpServletRequest.getRequestURI().

    • setRewriteRequestURI

      public void setRewriteRequestURI(boolean rewriteRequestURI)
      Parameters:
      rewriteRequestURI - true if this handler will rewrite the value returned by HttpServletRequest.getRequestURI().

    • isRewritePathInfo

      public boolean isRewritePathInfo()
      Returns:
      true if this handler will rewrite the value returned by HttpServletRequest.getPathInfo().

    • setRewritePathInfo

      public void setRewritePathInfo(boolean rewritePathInfo)
      Parameters:
      rewritePathInfo - true if this handler will rewrite the value returned by HttpServletRequest.getPathInfo().

    • getOriginalPathAttribute

      public String getOriginalPathAttribute()
      Returns:
      the originalPathAttribte. If non null, this string will be used as the attribute name to store the original request path.

    • setOriginalPathAttribute

      public void setOriginalPathAttribute(String originalPathAttribute)
      Parameters:
      originalPathAttribute - If non null, this string will be used as the attribute name to store the original request path.

    • getDispatcherTypes

      public EnumSet<jakarta.servlet.DispatcherType> getDispatcherTypes()

    • setDispatcherTypes

      public void setDispatcherTypes(EnumSet<jakarta.servlet.DispatcherType> types)

    • setDispatcherTypes

      public void setDispatcherTypes(jakarta.servlet.DispatcherType... types)

    • handle

      public void handle(String target, org.eclipse.jetty.server.Request baseRequest, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response) throws IOException, jakarta.servlet.ServletException
      Specified by:
      handle in interface org.eclipse.jetty.server.Handler
      Overrides:
      handle in class org.eclipse.jetty.server.handler.HandlerWrapper
      Throws:
      IOException
      jakarta.servlet.ServletException