Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The URLRewrite Mediator is used to modify and transform the URL values available in messages. This can be done by defining a rewrite action for each fragment of a selected property value. Alternatively, you can rewrite the entire URL string at once.

Info

The URLRewrite mediator is a content aware mediator.

...

Table of Contents
maxLevel3
minLevel3
styleborder:1
locationtop
typeflat
separatorpipe

...

Parameter NameDescription
Action

This parameter is used to specify the action to be performed by the rewrite action. Each rewrite action is performed on a fragment entered in the Fragment parameter. Possible values are as follows.

  • Replace: If this is selected, the existing in property value fragment will be replaced by the result value.
  • Remove: If this is selected, the result value will be removed from the in property value fragment.
  • Append: If this is selected, the result value will be added to the end of the in property value fragment.
  • Prepend: If this is selected, the result value will be added to the beginning of the in property value fragment.
  • Set: If this is selected, the result value will be set as the in property value fragment.
Fragment

The fragment of the in property (i.e. input URL) for which the rewrite action should be performed. The available fragments are as follows.

  • Protocol:
  • Host
  • Port
  • Path
  • Query
  • Ref
  • User
  • Full
Info

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.

Option

This parameter is used to define the result value of the rewrite action. Select one of the following.

  • Value: If this is selected, the result value would be a static value.
  • Expression: If this is selected, the result value will be evaluated using an expression.
Value/ExpressionThis parameter is used to enter the result value of the URLRewrite mediator as a static value or an expression, depending on what you selected for the Option parameter.
Namespace EditorYou can click this link to add namespaces when you are providing an expression. Then the Namespace Editor panel would appear where you can provide any number of namespace prefixes and URLs used in the XPath expression. 
RegexThis parameter is used to specify which part of the in property value fragment should be replaced by the result value if you selected Replace for the Action parameter.
DeleteClick Delete in the relevant row to remove a rewrite action.
Info
titleNote

You can configure the mediator using XML. Click switch to source view in the Mediator window.

Image Added

Example

In this example, the URLRewrite mediator has a rewrite action which replaces the value soap with value services in the fragment path of the input URL. Since no in property or an out  property is specified, the To header of the  request is both the input  to which the rewrite rule is applied and the target where the result URL is set. This configuration is typically used when the address URL of a request contains the context soap which needs to be converted since all the services are deployed under a context named services in the ESB server. Thus, the URL http://localhost:8280/soap/StockQuoteProxy1 is rewritten as http://localhost:8280/services/StockQuoteProxy1 to ensure that the requests are successfully delivered to the server.

...