Class RewriteValve
java.lang.Object
org.apache.catalina.util.LifecycleBase
org.apache.catalina.util.LifecycleMBeanBase
org.apache.catalina.valves.ValveBase
org.apache.catalina.valves.rewrite.RewriteValve
- All Implemented Interfaces:
- MBeanRegistration,- Contained,- JmxEnabled,- Lifecycle,- Valve
Note: Extra caution should be used when adding a Rewrite Rule. When
 specifying a regex to match for in a Rewrite Rule, certain regex could allow
 an attacker to DoS your server, as Java's regex parsing is vulnerable to
 "catastrophic backtracking" (also known as "Regular expression Denial of
 Service", or ReDoS). There are some open source tools to help detect
 vulnerable regex, though in general it is a hard problem. A good defence is
 to use a regex debugger on your desired regex, and read more on the subject
 of catastrophic backtracking.
- See Also:
- 
Nested Class SummaryNested classes/interfaces inherited from interface org.apache.catalina.LifecycleLifecycle.SingleUse
- 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected booleanWill be set to true if the valve is associated with a context.protected booleanenabled this componentprotected ThreadLocal<Boolean>If rewriting occurs, the whole request will be processed again.protected Map<String,RewriteMap> Maps to be used by the rules.Maps configuration.protected StringRelative path to the configuration file.protected RewriteRule[]The rewrite rules that the valve will use.Fields inherited from class org.apache.catalina.valves.ValveBaseasyncSupported, container, containerLog, next, smFields inherited from interface org.apache.catalina.LifecycleAFTER_DESTROY_EVENT, AFTER_INIT_EVENT, AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_DESTROY_EVENT, BEFORE_INIT_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, CONFIGURE_START_EVENT, CONFIGURE_STOP_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionbooleanprotected voidSub-classes wishing to perform additional initialization should override this method, ensuring that super.initInternal() is the first call in the overriding method.voidPerform request processing as required by this Valve.protected voidparse(BufferedReader reader) static ObjectThis factory method will parse a line formed like: Example: RewriteCond %{REMOTE_HOST} ^host1.* [OR]protected static voidparseCondFlag(String line, RewriteCond condition, String flag) Parser for RewriteCond flags.protected static voidparseRuleFlag(String line, RewriteRule rule, String flag) Parser for RewriteRule flags.voidsetConfiguration(String configuration) voidsetEnabled(boolean enabled) protected voidStart this component and implement the requirements ofLifecycleBase.startInternal().protected voidStop this component and implement the requirements ofLifecycleBase.stopInternal().Methods inherited from class org.apache.catalina.valves.ValveBasebackgroundProcess, getContainer, getDomainInternal, getNext, getObjectNameKeyProperties, isAsyncSupported, setAsyncSupported, setContainer, setNext, toStringMethods inherited from class org.apache.catalina.util.LifecycleMBeanBasedestroyInternal, getDomain, getObjectName, postDeregister, postRegister, preDeregister, preRegister, register, setDomain, unregister, unregisterMethods inherited from class org.apache.catalina.util.LifecycleBaseaddLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, getThrowOnFailure, init, removeLifecycleListener, setState, setState, setThrowOnFailure, start, stop
- 
Field Details- 
rulesThe rewrite rules that the valve will use.
- 
invokedIf rewriting occurs, the whole request will be processed again.
- 
resourcePathRelative path to the configuration file. Note: If the valve's container is a context, this will be relative to /WEB-INF/.
- 
contextprotected boolean contextWill be set to true if the valve is associated with a context.
- 
enabledprotected boolean enabledenabled this component
- 
mapsMaps to be used by the rules.
- 
mapsConfigurationMaps configuration.
 
- 
- 
Constructor Details- 
RewriteValvepublic RewriteValve()
 
- 
- 
Method Details- 
getEnabledpublic boolean getEnabled()
- 
setEnabledpublic void setEnabled(boolean enabled) 
- 
initInternalDescription copied from class:LifecycleMBeanBaseSub-classes wishing to perform additional initialization should override this method, ensuring that super.initInternal() is the first call in the overriding method.- Overrides:
- initInternalin class- ValveBase
- Throws:
- LifecycleException- If the initialisation fails
 
- 
startInternalDescription copied from class:ValveBaseStart this component and implement the requirements ofLifecycleBase.startInternal().- Overrides:
- startInternalin class- ValveBase
- Throws:
- LifecycleException- if this component detects a fatal error that prevents this component from being used
 
- 
setConfiguration- Throws:
- Exception
 
- 
getConfiguration
- 
parse- Throws:
- LifecycleException
 
- 
stopInternalDescription copied from class:ValveBaseStop this component and implement the requirements ofLifecycleBase.stopInternal().- Overrides:
- stopInternalin class- ValveBase
- Throws:
- LifecycleException- if this component detects a fatal error that prevents this component from being used
 
- 
invokeDescription copied from interface:ValvePerform request processing as required by this Valve. An individual Valve MAY perform the following actions, in the specified order: - Examine and/or modify the properties of the specified Request and Response.
- Examine the properties of the specified Request, completely generate the corresponding Response, and return control to the caller.
- Examine the properties of the specified Request and Response, wrap either or both of these objects to supplement their functionality, and pass them on.
- If the corresponding Response was not generated (and control was not
     returned, call the next Valve in the pipeline (if there is one) by
     executing getNext().invoke().
- Examine, but not modify, the properties of the resulting Response (which was created by a subsequently invoked Valve or Container).
 A Valve MUST NOT do any of the following things: - Change request properties that have already been used to direct the flow of processing control for this request (for instance, trying to change the virtual host to which a Request should be sent from a pipeline attached to a Host or Context in the standard implementation).
- Create a completed Response AND pass this Request and Response on to the next Valve in the pipeline.
- Consume bytes from the input stream associated with the Request, unless it is completely generating the response, or wrapping the request before passing it on.
- Modify the HTTP headers included with the Response after the
     getNext().invoke()method has returned.
- Perform any actions on the output stream associated with the
     specified Response after the getNext().invoke()method has returned.
 - Parameters:
- request- The servlet request to be processed
- response- The servlet response to be created
- Throws:
- IOException- if an input/output error occurs, or is thrown by a subsequently invoked Valve, Filter, or Servlet
- ServletException- if a servlet error occurs, or is thrown by a subsequently invoked Valve, Filter, or Servlet
 
- 
parseThis factory method will parse a line formed like: Example: RewriteCond %{REMOTE_HOST} ^host1.* [OR]- Parameters:
- line- A line from the rewrite configuration
- Returns:
- The condition, rule or map resulting from parsing the line
 
- 
parseCondFlagParser for RewriteCond flags.- Parameters:
- line- The configuration line being parsed
- condition- The current condition
- flag- The flag
 
- 
parseRuleFlagParser for RewriteRule flags.- Parameters:
- line- The configuration line being parsed
- rule- The current rule
- flag- The flag
 
 
-