This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, visit https://wso2.com/documentation/.

URLRewrite Mediator

Owned by Former user (Deleted)
Last updated: Jan 29, 2014Version comment
3 min read

The URLRewrite Mediator is used to modify and transform the URL values available in the message. The input URL could be taken from the 'To' header of the message or from a property available on the message. Once the input URL is selected, a series of user-defined rewrite rules will be evaluated on the message. Depending on the outcome of these rule evaluations, the URL will be modified and set on the message.

URL rewrite mediator breaks the URL down to seven segments:

  • Protocol
  • User information
  • Hostname
  • Port
  • Path
  • Query
  • Reference parameter

Note that this breakdown is inline with the URI specification (RFC2396). URL rewrite mediator enables rewriting each of the above segments separately and finally combining them to get the final URL value. It also supports rewriting the entire URL string at once.

UI Configuration

Specify the following properties:

  • In Property - By default, the Rewrite Mediator will take the "To" header of the message and will apply the provided rewrite rules on it. If the user specifies an inProperty attribute, the mediator will take the value of the specified property as the input URL.
  • Out Property - Similarly, the mediator by default sets the transformed URL as the "To" header of the message. Alternatively, users can use the outProperty attribute to instruct the mediator to set the resulting URL as a property.

The Rewrite Mediator applies URL transformations by evaluating a set of rules on the message. To add a rule to the mediator, click on the "Add Rule" link.

A URLRewriteRule node is added under the URLRewrite node in the sequence. Click the URLRewriteRule node to configure the rule.

  • Condition - A rule can have an optional condition. If the condition is provided, it will be evaluated first.
  • Action - Specify the type of action to execute on the URL. This defaults to "set" value.
  • Fragment - This attribute can be used to specify the URL fragment on which the action should be executed.
  • Option - If the Action is anything other than Remove, select Value or Expression to indicate which type of value you will provide.
  • Value/Expression - Enter the value or expression to use with the action, such as the value to set.
  • Regex - If the action is Replace, specify an additional "regex" attribute that indicates the portion that should be replaced with the given value.
  • Delete - Removes this action from the rule.

Example

Assume the address URL of a request contains the context "soap", such as http://localhost:8280/soap/StockQuoteProxy1. In the ESB server, all the services are deployed under a context named "services" by default, so we want to replace the "soap" context with "services" in the "To" header (http://localhost:8280/services/StockQuoteProxy1) so that the requests will be delivered to the server successfully. 

<rewrite>
	<rewriterule>
		<action type="replace" regex="soap" value="services" fragment="path" />
	</rewriterule>
</rewrite>

For additional samples, see Rewriting the URL (URL Rewrite Mediator).