Contact Free trial Login

Web Service Proxy Pattern

Mule Runtime Engine versions 3.5, 3.6, and 3.7 reached End of Life on or before January 25, 2020. For more information, contact your Customer Success Manager to determine how you can migrate to the latest Mule version.

Proxying web services is a very common practice used for different reasons like security or auditing. This pattern allows a short and easy configuration of such a proxy.


Core Features

A web service proxy acts as an intermediate between a caller application and the target web service. This gives the proxy a chance to transparently introduce new behaviors in the calling sequence. For example, it can:

  • Add or remove HTTP headers.

  • Transform the SOAP envelope (body or header) to add or remove specific entries.

  • Rewrite remote WSDLs so they appear to bind to services inside a corporate firewall.

  • Introduce custom error handling.

Let’s take a look at Web Service Proxy in action:

Web Service Proxy

<pattern:web-service-proxy name="weather-forecast-ws-proxy"
    outboundAddress="" />

With this configuration in place, all calls to the local weather forecaster proxy redirect to the remote one.

The Web Service Proxy is provided by the ws module, which must be present on the classpath to be usable. Its namespace is and its schema location is

The true value add comes from the automatic address rewriting that is performed by the proxy: calling ` http://localhost:8090/weather-forecast?wsdl `returns the remote WSDL where the port addresses have been automatically rewritten based on the URL of the request hitting the proxy. That way, if your Mule instance is accessed behind a load balancer or any kind of network indirection, the generated WSDL points the caller to port addresses that respect your network’s topology.

As said above, the proxy can perform changes on the SOAP invocation by the use of transformers. This is demonstrated hereafter:

Proxy with Transformers

<pattern:web-service-proxy name="weather-forecast-ws-proxy-transformers"
    transformer-refs="zip-code-transformer add-credentials-transformer"
    outboundEndpoint-ref="target-ws-endpoint" />

Notice how transformers are introduced by using references to globally declared ones. This technique is also applicable to global endpoints, as you can see with the above reference to target-ws-endpoint.

The Web Service Proxy element supports child elements. The following shows a configuration variant where endpoints are declared internally and an exception strategy has been added in:

Child Elements

<pattern:web-service-proxy name="weather-forecast-ws-proxy">
  <http:inbound-endpoint address="http://localhost:8090/weather-forecast" />
  <http:outbound-endpoint address="" />
  <custom-exception-strategy class="com.acme.AcmeExceptionStrategy" />

Finally, the Web Service Proxy also supports inheritance, which allows sharing common configuration attributes across several concrete instantiations of the proxy. Check out the following to see how inheritance works:


<pattern:web-service-proxy name="abstract-ws-proxy-zipcode-changer"
    transformer-refs="zip-code-transformer add-credentials-transformer"
    responseTransformer-refs="weather-code-transformer" />

<pattern:web-service-proxy name="weather-forecast-ws-proxy"
  <http:inbound-endpoint address="http://localhost:8090/weather-forecast" />
  <http:outbound-endpoint address="" />

The proxy offers a few extra options as far as WSDL handling is concerned. Let’s look at them.

WSDL Redirection

In some cases, the remote web service doesn’t follow the common practice of exposing its WSDL on the same address as the service with a "?wsdl" appended at the end. In that case, it is required to point the Web Service Proxy to the exact location of the remote WSDL, as illustrated there:

Remote WSDL Redirection

<pattern:web-service-proxy name="weather-forecast-ws-proxy"
    wsdlLocation="" />

In this scenario, the remote WSDL has its port addresses rewritten as explained above.

For the case when no remote WSDL is available or if the remote WSDL needs manual adjustment before being exposed by the Web Service Proxy, the solution consists in storing the correct WSDL as a local file and have the proxy serve it. This is done as shown here:

File WSDL Redirection

<pattern:web-service-proxy name="weather-forecast-ws-proxy"
    wsdlFile="path/to/correct/weather-forecaster.wsdl" />

In this case, the WSDL is served as is from the file: no rewriting occurs.

Serving Static Content

When proxying web services whose WSDL imports external resources like XSD files, add an http:static-resource-handler element in a separate flow to serve these external static resources.

Otherwise the client applications calling the proxied web service cannot determine the correct types they must use to invoke the service.

Sample configuration:

<pattern:web-service-proxy name="ws-proxy"
  inboundAddress="http://${}:${http.inbound.port}/some-service"  wsdlFile="${wsdl.location}">
  <http:outbound-endpoint  address="${http.outbound.address}" responseTimeout="${http.outbound.timeout}"/>

<flow name="static-content">
  <http:inbound-endpoint exchange-pattern="request-response" host="${}" port="${http.inbound.port}" doc:name="HTTP"/>
  <http:static-resource-handler resourceBase="${app.home}/xsd/" doc:name="HTTP Static Resource Handler"/>

If the WSDL file pointed by the property wsdl.location includes XSD imports, the following example shows how to handle this use case:

        <import namespace="" schemaLocation="/some-namespace/type-01.xsd"/>
        <import namespace="" schemaLocation="/other-namespace/complexTypes.xsd"/>

The application serves these static contents from src/main/app/xsd. See HTTP Static Resource Handler for more information about this.

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub