Tomcat 10.1.19 · org.apache.catalina.valves.rewrite.RewriteMap

Interface for user defined lookup/replacement logic that can be defined in a rewrite.config file by a RewriteMap directive. Such a map can then be used by a RewriteRule defined in the same file.

An example rewrite.config file could look like:

RewriteMap uc example.UpperCaseMap

RewriteRule ^/(.*)$ ${uc:$1}

One parameter can be optionally appended to the RewriteMap directive. This could be used – for example – to specify a name of a file, that contains a lookup table used by the implementation of the map.

Method Summary

Modifier and Type	Method and Description
public String	Returns: mapped value or `null` lookup(String used by the actual implementation to generate a mapped value key) Maps a key to a replacement value.
public String	Returns: value is currently ignored setParameters(String the optional parameter params) Optional parameter that can be defined through the `RewriteMap` directive in the `rewrite.config` file.
public default void	setParameters(String... the optional parameters params) Optional parameters that can be defined through the `RewriteMap` directive in the `rewrite.config` file.

Method Detail

lookup back to summary

lookup	back to summary
public String lookup(String key) Maps a key to a replacement value. The method is free to return `null` to indicate, that the default value from the `RewriteRule` directive should be used. Parameters key:String used by the actual implementation to generate a mapped value Returns:String mapped value or `null`

public String lookup(String key)

Maps a key to a replacement value.
The method is free to return null to indicate, that the default value from the RewriteRule directive should be used.

Parameters

key:String: used by the actual implementation to generate a mapped value

Returns:String

mapped value or null

setParameters back to summary

setParameters	back to summary
public String setParameters(String params) Optional parameter that can be defined through the `RewriteMap` directive in the `rewrite.config` file. Parameters params:String the optional parameter Returns:String value is currently ignored

public String setParameters(String params)

Optional parameter that can be defined through the RewriteMap directive in the rewrite.config file.

Parameters

params:String: the optional parameter

Returns:String

value is currently ignored

setParameters back to summary

setParameters	back to summary
public default void setParameters(String... params) Optional parameters that can be defined through the `RewriteMap` directive in the `rewrite.config` file. This method will be called, if there are more than one parameters defined. Parameters params:String[] the optional parameters

public default void setParameters(String... params)

Optional parameters that can be defined through the RewriteMap directive in the rewrite.config file.

This method will be called, if there are more than one parameters defined.

Parameters

params:String[]: the optional parameters

public Interface RewriteMap

Method Summary

Method Detail