public class RewriteHandler extends 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 PathMap
(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:
CookiePatternRule
- adds a new cookie in response. HeaderPatternRule
- adds/modifies the HTTP headers in response. RedirectPatternRule
- sets the redirect location. ResponsePatternRule
- sets the status/error codes. RewritePatternRule
- rewrites the requested URI. RewriteRegexRule
- rewrites the requested URI using regular expression for pattern matching. MsieSslRule
- disables the keep alive on SSL for IE5 and IE6. ForwardedSchemeHeaderRule
- set the scheme according to the headers present. VirtualHostRuleContainer
- checks whether the request matches one of a set of virtual host names.<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"> <New id="Handlers" class="org.eclipse.jetty.server.handler.HandlerCollection"> <Set name="handlers"> <Array type="org.eclipse.jetty.server.Handler"> <Item> <Ref id="RewriteHandler"/> </Item> <Item> <New id="Contexts" class="org.eclipse.jetty.server.handler.ContextHandlerCollection"/> </Item> <Item> <New id="DefaultHandler" class="org.eclipse.jetty.server.handler.DefaultHandler"/> </Item> <Item> <New id="RequestLog" class="org.eclipse.jetty.server.handler.RequestLogHandler"/> </Item> </Array> </Set> </New> </Set>
AbstractHandler.ErrorDispatchHandler
AbstractLifeCycle.AbstractLifeCycleListener
LifeCycle.Listener
Container.InheritedListener, Container.Listener
_handler
FAILED, RUNNING, STARTED, STARTING, STOP_ON_FAILURE, STOPPED, STOPPING
Constructor and Description |
---|
RewriteHandler() |
Modifier and Type | Method and Description |
---|---|
void |
addRule(Rule rule)
Add a Rule
|
EnumSet<DispatcherType> |
getDispatcherTypes() |
String |
getOriginalPathAttribute() |
RuleContainer |
getRuleContainer() |
Rule[] |
getRules()
Returns the list of rules.
|
void |
handle(String target,
Request baseRequest,
HttpServletRequest request,
HttpServletResponse response)
Handle a request.
|
boolean |
isRewritePathInfo() |
boolean |
isRewriteRequestURI() |
void |
setDispatcherTypes(DispatcherType... types) |
void |
setDispatcherTypes(EnumSet<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.
|
void |
setRules(RuleContainer rules)
Deprecated.
|
destroy, expandChildren, getHandler, getHandlers, insertHandler, setHandler
expandHandler, findContainerOf, getChildHandlerByClass, getChildHandlers, getChildHandlersByClass, setServer
doError, doStart, doStop, dumpThis, getServer
addBean, addBean, addBean, addEventListener, addManaged, contains, dump, dump, dump, dump, dump, dumpBeans, dumpObject, dumpStdErr, getBean, getBeans, getBeans, isManaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, unmanage, updateBean, updateBean, updateBeans
addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
addLifeCycleListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop
public void setRules(Rule[] rules)
rules
- an array of Rule
.@Deprecated public void setRules(RuleContainer rules)
rules
- a RuleContainer
containing other rules to processpublic void setRuleContainer(RuleContainer rules)
rules
- a RuleContainer
containing other rules to processpublic RuleContainer getRuleContainer()
public void addRule(Rule rule)
rule
- The rule to add to the end of the rules arraypublic boolean isRewriteRequestURI()
HttpServletRequest.getRequestURI()
.public void setRewriteRequestURI(boolean rewriteRequestURI)
rewriteRequestURI
- true if this handler will rewrite the value
returned by HttpServletRequest.getRequestURI()
.public boolean isRewritePathInfo()
HttpServletRequest.getPathInfo()
.public void setRewritePathInfo(boolean rewritePathInfo)
rewritePathInfo
- true if this handler will rewrite the value
returned by HttpServletRequest.getPathInfo()
.public String getOriginalPathAttribute()
public void setOriginalPathAttribute(String originalPathAttribute)
originalPathAttribute
- If non null, this string will be used
as the attribute name to store the original request path.public EnumSet<DispatcherType> getDispatcherTypes()
public void setDispatcherTypes(EnumSet<DispatcherType> types)
public void setDispatcherTypes(DispatcherType... types)
public void handle(String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException
Handler
handle
in interface Handler
handle
in class HandlerWrapper
target
- The target of the request - either a URI or a name.baseRequest
- The original unwrapped request object.request
- The request either as the Request
object or a wrapper of that request. The
HttpConnection.getCurrentConnection()
.getHttpChannel()
.getRequest()
method can be used access the Request object if required.response
- The response as the Response
object or a wrapper of that request. The
HttpConnection.getCurrentConnection()
.getHttpChannel()
.getResponse()
method can be used access the Response object if required.IOException
- if unable to handle the request or response processingServletException
- if unable to handle the request or response due to underlying servlet issueCopyright © 1995–2017 Webtide. All rights reserved.