Class RewriteRule
java.lang.Object
org.apache.catalina.valves.rewrite.RewriteRule
-
Field Summary
Modifier and TypeFieldDescriptionprotected boolean
This flag chains the current rule with the next rule (which itself can be chained with the following rule, etc.).protected RewriteCond[]
protected boolean
This sets a cookie on the client's browser.protected String
protected boolean
protected int
protected String
protected String
protected ThreadLocal<String>
protected boolean
protected Substitution
protected String
protected boolean
This forces a request attribute named VAR to be set to the value VAL, where VAL can contain regexp back references $N and %N which will be expanded.protected ArrayList<ThreadLocal<String>>
protected ArrayList<Substitution>
protected String
protected boolean
This forces the current URL to be forbidden, i.e., it immediately sends back an HTTP response of 403 (FORBIDDEN).protected boolean
This forces the current URL to be gone, i.e., it immediately sends back an HTTP response of 410 (GONE).protected boolean
Host.protected boolean
Stop the rewriting process here and don't apply any more rewriting rules.protected boolean
Re-run the rewriting process (starting again with the first rewriting rule).protected boolean
This makes the Pattern case-insensitive, i.e., there is no difference between 'A-Z' and 'a-z' when Pattern is matched against the current URL.protected boolean
This flag keeps mod_rewrite from applying the usual URI escaping rules to the result of a rewrite.protected boolean
This flag forces the rewriting engine to skip a rewriting rule if the current request is an internal sub-request.protected ThreadLocal<Pattern>
protected String
protected boolean
protected boolean
This flag forces the rewriting engine to append a query string part in the substitution string to the existing one instead of replacing it.protected boolean
When the requested URI contains a query string, and the target URI does not, the default behavior of RewriteRule is to copy that query string to the target URI.protected boolean
Prefix Substitution with http://thishost[:thisport]/ (which makes the new URL a URI) to force an external redirection.protected int
protected int
This flag forces the rewriting engine to skip the next num rules in sequence when the current rule matches.protected Substitution
protected String
protected boolean
Force the MIME-type of the target file to be MIME-type.protected String
protected boolean
Allows skipping the next valve in the Catalina pipeline. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addCondition
(RewriteCond condition) void
addEnvName
(String envName) void
addEnvValue
(String envValue) evaluate
(CharSequence url, Resolver resolver) Evaluate the rule based on the contextint
getEnvName
(int i) getEnvResult
(int i) int
getEnvValue
(int i) final String
int
int
getSkip()
boolean
isChain()
boolean
isCookie()
boolean
boolean
boolean
isEnv()
boolean
boolean
boolean
isGone()
boolean
isHost()
boolean
isLast()
boolean
isNext()
boolean
isNocase()
boolean
boolean
boolean
final boolean
boolean
boolean
isType()
boolean
void
parse
(Map<String, RewriteMap> maps) void
setChain
(boolean chain) void
setConditions
(RewriteCond[] conditions) void
setCookie
(boolean cookie) void
setCookieDomain
(String cookieDomain) void
setCookieHttpOnly
(boolean cookieHttpOnly) void
setCookieLifetime
(int cookieLifetime) void
setCookieName
(String cookieName) void
setCookiePath
(String cookiePath) void
setCookieSecure
(boolean cookieSecure) void
setCookieValue
(String cookieValue) void
setEnv
(boolean env) void
setEscapeBackReferences
(boolean escapeBackReferences) final void
setFlagsString
(String flagsString) void
setForbidden
(boolean forbidden) void
setGone
(boolean gone) void
setHost
(boolean host) void
setLast
(boolean last) void
setNext
(boolean next) void
setNocase
(boolean nocase) void
setNoescape
(boolean noescape) void
setNosubreq
(boolean nosubreq) void
setPatternString
(String patternString) void
setQsappend
(boolean qsappend) final void
setQsdiscard
(boolean qsdiscard) void
setRedirect
(boolean redirect) void
setRedirectCode
(int redirectCode) void
setSkip
(int skip) void
setSubstitution
(Substitution substitution) void
setSubstitutionString
(String substitutionString) void
setType
(boolean type) void
setTypeValue
(String typeValue) void
setValveSkip
(boolean valveSkip) toString()
String representation.
-
Field Details
-
conditions
-
pattern
-
substitution
-
patternString
-
substitutionString
-
flagsString
-
positive
protected boolean positive -
chain
protected boolean chainThis flag chains the current rule with the next rule (which itself can be chained with the following rule, etc.). This has the following effect: if a rule matches, then processing continues as usual, i.e., the flag has no effect. If the rule does not match, then all following chained rules are skipped. For instance, use it to remove the ".www" part inside a per-directory rule set when you let an external redirect happen (where the ".www" part should not to occur!). -
cookie
protected boolean cookieThis sets a cookie on the client's browser. The cookie's name is specified by NAME and the value is VAL. The domain field is the domain of the cookie, such as '.apache.org',the optional lifetime is the lifetime of the cookie in minutes, and the optional path is the path of the cookie -
cookieName
-
cookieValue
-
cookieDomain
-
cookieLifetime
protected int cookieLifetime -
cookiePath
-
cookieSecure
protected boolean cookieSecure -
cookieHttpOnly
protected boolean cookieHttpOnly -
cookieSubstitution
-
cookieResult
-
env
protected boolean envThis forces a request attribute named VAR to be set to the value VAL, where VAL can contain regexp back references $N and %N which will be expanded. Multiple env flags are allowed. -
envName
-
envValue
-
envSubstitution
-
envResult
-
forbidden
protected boolean forbiddenThis forces the current URL to be forbidden, i.e., it immediately sends back an HTTP response of 403 (FORBIDDEN). Use this flag in conjunction with appropriate RewriteConds to conditionally block some URLs. -
gone
protected boolean goneThis forces the current URL to be gone, i.e., it immediately sends back an HTTP response of 410 (GONE). Use this flag to mark pages which no longer exist as gone. -
host
protected boolean hostHost. This means this rule and its associated conditions will apply to host, allowing host rewriting (ex: redirecting internally *.foo.com to bar.foo.com). -
last
protected boolean lastStop the rewriting process here and don't apply any more rewriting rules. This corresponds to the Perl last command or the break command from the C language. Use this flag to prevent the currently rewritten URL from being rewritten further by following rules. For example, use it to rewrite the root-path URL ('/') to a real one, e.g., '/e/www/'. -
next
protected boolean nextRe-run the rewriting process (starting again with the first rewriting rule). Here the URL to match is again not the original URL but the URL from the last rewriting rule. This corresponds to the Perl next command or the continue command from the C language. Use this flag to restart the rewriting process, i.e., to immediately go to the top of the loop. But be careful not to create an infinite loop! -
nocase
protected boolean nocaseThis makes the Pattern case-insensitive, i.e., there is no difference between 'A-Z' and 'a-z' when Pattern is matched against the current URL. -
noescape
protected boolean noescapeThis flag keeps mod_rewrite from applying the usual URI escaping rules to the result of a rewrite. Ordinarily, special characters (such as '%', '$', ';', and so on) will be escaped into their hexcode equivalents ('%25', '%24', and '%3B', respectively); this flag prevents this from being done. This allows percent symbols to appear in the output, as inRewriteRule /foo/(.*) /bar?arg=P1\%3d$1 [R,NE]
which would turn '/foo/zed' into a safe request for '/bar?arg=P1=zed'. -
nosubreq
protected boolean nosubreqThis flag forces the rewriting engine to skip a rewriting rule if the current request is an internal sub-request. For instance, sub-requests occur internally in Apache when mod_include tries to find out information about possible directory default files (index.xxx). On sub-requests it is not always useful and even sometimes causes a failure to if the complete set of rules are applied. Use this flag to exclude some rules. Use the following rule for your decision: whenever you prefix some URLs with CGI-scripts to force them to be processed by the CGI-script, the chance is high that you will run into problems (or even overhead) on sub-requests. In these cases, use this flag. -
qsappend
protected boolean qsappendThis flag forces the rewriting engine to append a query string part in the substitution string to the existing one instead of replacing it. Use this when you want to add more data to the query string via a rewrite rule. -
qsdiscard
protected boolean qsdiscardWhen the requested URI contains a query string, and the target URI does not, the default behavior of RewriteRule is to copy that query string to the target URI. Using the [QSD] flag causes the query string to be discarded. Using [QSD] and [QSA] together will result in [QSD] taking precedence. -
redirect
protected boolean redirectPrefix Substitution with http://thishost[:thisport]/ (which makes the new URL a URI) to force an external redirection. If no code is given an HTTP response of 302 (FOUND, previously MOVED TEMPORARILY) is used. If you want to use other response codes in the range 300-399 just specify them as a number or use one of the following symbolic names: temp (default), permanent, seeother. Use it for rules which should canonicalize the URL and give it back to the client, e.g., translate "/~" into "/u/" or always append a slash to /u/user, etc. Note: When you use this flag, make sure that the substitution field is a valid URL! If not, you are redirecting to an invalid location! And remember that this flag itself only prefixes the URL with http://thishost[:thisport]/, rewriting continues. Usually you also want to stop and do the redirection immediately. To stop the rewriting you also have to provide the 'L' flag. -
redirectCode
protected int redirectCode -
skip
protected int skipThis flag forces the rewriting engine to skip the next num rules in sequence when the current rule matches. Use this to make pseudo if-then-else constructs: The last rule of the then-clause becomes skip=N where N is the number of rules in the else-clause. (This is not the same as the 'chain|C' flag!) -
type
protected boolean typeForce the MIME-type of the target file to be MIME-type. For instance, this can be used to setup the content-type based on some conditions. For example, the following snippet allows .php files to be displayed by mod_php if they are called with the .phps extension: RewriteRule ^(.+\.php)s$ $1 [T=application/x-httpd-php-source] -
typeValue
-
valveSkip
protected boolean valveSkipAllows skipping the next valve in the Catalina pipeline.
-
-
Constructor Details
-
RewriteRule
public RewriteRule()
-
-
Method Details
-
parse
-
addCondition
-
evaluate
Evaluate the rule based on the context- Parameters:
url
- The char sequenceresolver
- Property resolver- Returns:
null
if no rewrite took place
-
toString
String representation. -
isEscapeBackReferences
public boolean isEscapeBackReferences() -
setEscapeBackReferences
public void setEscapeBackReferences(boolean escapeBackReferences) -
isChain
public boolean isChain() -
setChain
public void setChain(boolean chain) -
getConditions
-
setConditions
-
isCookie
public boolean isCookie() -
setCookie
public void setCookie(boolean cookie) -
getCookieName
-
setCookieName
-
getCookieValue
-
setCookieValue
-
getCookieResult
-
isEnv
public boolean isEnv() -
getEnvSize
public int getEnvSize() -
setEnv
public void setEnv(boolean env) -
getEnvName
-
addEnvName
-
getEnvValue
-
addEnvValue
-
getEnvResult
-
isForbidden
public boolean isForbidden() -
setForbidden
public void setForbidden(boolean forbidden) -
isGone
public boolean isGone() -
setGone
public void setGone(boolean gone) -
isLast
public boolean isLast() -
setLast
public void setLast(boolean last) -
isNext
public boolean isNext() -
setNext
public void setNext(boolean next) -
isNocase
public boolean isNocase() -
setNocase
public void setNocase(boolean nocase) -
isNoescape
public boolean isNoescape() -
setNoescape
public void setNoescape(boolean noescape) -
isNosubreq
public boolean isNosubreq() -
setNosubreq
public void setNosubreq(boolean nosubreq) -
isQsappend
public boolean isQsappend() -
setQsappend
public void setQsappend(boolean qsappend) -
isQsdiscard
public final boolean isQsdiscard() -
setQsdiscard
public final void setQsdiscard(boolean qsdiscard) -
isRedirect
public boolean isRedirect() -
setRedirect
public void setRedirect(boolean redirect) -
getRedirectCode
public int getRedirectCode() -
setRedirectCode
public void setRedirectCode(int redirectCode) -
getSkip
public int getSkip() -
setSkip
public void setSkip(int skip) -
getSubstitution
-
setSubstitution
-
isType
public boolean isType() -
setType
public void setType(boolean type) -
getTypeValue
-
setTypeValue
-
getPatternString
-
setPatternString
-
getSubstitutionString
-
setSubstitutionString
-
getFlagsString
-
setFlagsString
-
isHost
public boolean isHost() -
setHost
public void setHost(boolean host) -
getCookieDomain
-
setCookieDomain
-
getCookieLifetime
public int getCookieLifetime() -
setCookieLifetime
public void setCookieLifetime(int cookieLifetime) -
getCookiePath
-
setCookiePath
-
isCookieSecure
public boolean isCookieSecure() -
setCookieSecure
public void setCookieSecure(boolean cookieSecure) -
isCookieHttpOnly
public boolean isCookieHttpOnly() -
setCookieHttpOnly
public void setCookieHttpOnly(boolean cookieHttpOnly) -
isValveSkip
public boolean isValveSkip() -
setValveSkip
public void setValveSkip(boolean valveSkip)
-