Contact Us 1-800-596-4880
  1. Homepage
  2. Mule Runtime (3.6)
  3. Developing
  4. Components

  5. CXF Component Reference

CXF Component Reference

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.
When sending requests to an external web service, the recommended approach is to use the Web Service Consumer rather than the CXF Module.

  • The CXF Component was formerly known as the SOAP Connector.

  • In the XSLT-generated sections that follow, the enableMuleSoapHeaders parameter is currently not enabled and has no effect.

Namespace and Syntax

XML Namespace:

xmlns:cxf="http://www.mulesoft.org/schema/mule/cxf"

XML Schema Location:

http://www.mulesoft.org/schema/mule/cxf/3.5/mule-cxf.xsd

Configuration Reference

Jaxws service

Table 1. Attributes of <jaxws-service…​>
Name Type Required Default Description

bindingId

string

no

The binding that should be used for this endpoint. It defaults to the SOAP binding by default.

port

string

no

The WSDL port name of your service.

namespace

string

no

The service namespace. (As of 2.2.1)

service

string

no

The WSDL service name of your service.

serviceClass

string

no

The class CXF should use to construct its service model. This is optional, and by default it will use the implementation class of your component, on inbound cxf endpoint. But it is mandatory for outbound endpoint when using "aegis" frontend.

validationEnabled

boolean

no

Whether or not validation should be enabled on this service. Validation only occurs on inbound server messages.

soapVersion

enumeration

no

The soapVersion that is going to be used for this endpoint. The specified version is translated into the corresponding bindingId value. This attribute is useful when there’s need to avoid the creation of the endpoint with the default binding. In case the bindingId attribute is set this attribute will override it. If not set and not specified otherwise CXF defaults to SOAP 1.1 binding

mtomEnabled

boolean

no

Whether or not MTOM (attachment support) is enabled for this endpoint.

wsdlLocation

string

no

The location of the WSDL for your service. If this is a server side endpoint it will served to your users.

enableMuleSoapHeaders

boolean

no

true

Whether or not this endpoint should write Mule SOAP headers which pass along the correlation and ReplyTo information. This is true by default, but the Mule SOAP headers are only triggered in situations where there is an existing correlation ID and the ReplyTo header is set. (As of 2.2.1)

configuration-ref

string

no

The CXF configuration that should be used.
Table 2. Child Elements of <jaxws-service…​>
Name Cardinality Description

schemaLocations

0..1

ws-security

0..1

Configuration to enable WS-Security

properties

0..1

Additional properties for this service.

abstract-databinding

0..1

The databinding implementation that should be used. By default, this is JAXB for the JAX-WS frontend and Aegis for the simple frontend. A placeholder for arbitrary extensions as children of the 'mule' element. Other transports and modules can extend this if they need to add global elements to the configuration (but consider the more specific elements like abstract-connector first)..

features

0..1

Any CXF features you want to apply to the client/server. See the CXF documentation for more information on features.

inInterceptors

0..1

Additional incoming interceptors for this service.

inFaultInterceptors

0..1

Additional incoming fault interceptors.

outInterceptors

0..1

Additional outgoing interceptors.

outFaultInterceptors

0..1

Additional outgoing fault interceptors.

Proxy service

Table 3. Attributes of <proxy-service…​>
Name Type Required Default Description

bindingId

string

no

The binding that should be used for this endpoint. It defaults to the SOAP binding by default.

port

string

no

The WSDL port name of your service.

namespace

string

no

The service namespace. (As of 2.2.1)

service

string

no

The WSDL service name of your service.

serviceClass

string

no

The class CXF should use to construct its service model. This is optional, and by default it will use the implementation class of your component, on inbound cxf endpoint. But it is mandatory for outbound endpoint when using "aegis" frontend.

validationEnabled

boolean

no

Whether or not validation should be enabled on this service. Validation only occurs on inbound server messages.

soapVersion

enumeration

no

The soapVersion that is going to be used for this endpoint. The specified version is translated into the corresponding bindingId value. This attribute is useful when there’s need to avoid the creation of the endpoint with the default binding. In case the bindingId attribute is set this attribute will override it. If not set and not specified otherwise CXF defaults to SOAP 1.1 binding

mtomEnabled

boolean

no

Whether or not MTOM (attachment support) is enabled for this endpoint.

wsdlLocation

string

no

The location of the WSDL for your service. If this is a server side endpoint it will served to your users.

enableMuleSoapHeaders

boolean

no

true

Whether or not this endpoint should write Mule SOAP headers which pass along the correlation and ReplyTo information. This is true by default, but the Mule SOAP headers are only triggered in situations where there is an existing correlation ID and the ReplyTo header is set. (As of 2.2.1)

configuration-ref

string

no

The CXF configuration that should be used.

payload

enumeration

no

Whether the whole SOAP Envelope, or just the body contents should be sent when in proxy mode.
Table 4. Child Elements of <proxy-service…​>
Name Cardinality Description

schemaLocations

0..1

ws-security

0..1

Configuration to enable WS-Security

properties

0..1

Additional properties for this service.

abstract-databinding

0..1

The databinding implementation that should be used. By default, this is JAXB for the JAX-WS frontend and Aegis for the simple frontend. A placeholder for arbitrary extensions as children of the 'mule' element. Other transports and modules can extend this if they need to add global elements to the configuration (but consider the more specific elements like abstract-connector first).

features

0..1

Any CXF features you want to apply to the client/server. See the CXF documentation for more information on features.

inInterceptors

0..1

Additional incoming interceptors for this service.

inFaultInterceptors

0..1

Additional incoming fault interceptors.

outInterceptors

0..1

Additional outgoing interceptors.

outFaultInterceptors

0..1

Additional outgoing fault interceptors.

Simple service

Table 5. Attributes of <simple-service…​>
Name Type Required Default Description

bindingId

string

no

The binding that should be used for this endpoint. It defaults to the SOAP binding by default.

port

string

no

The WSDL port name of your service.

namespace

string

no

The service namespace. (As of 2.2.1)

service

string

no

The WSDL service name of your service.

serviceClass

string

no

The class CXF should use to construct its service model. This is optional, and by default it will use the implementation class of your component, on inbound cxf endpoint. But it is mandatory for outbound endpoint when using "aegis" frontend.

validationEnabled

boolean

no

Whether or not validation should be enabled on this service. Validation only occurs on inbound server messages.

soapVersion

enumeration

no

The soapVersion that is going to be used for this endpoint. The specified version is translated into the corresponding bindingId value. This attribute is useful when there’s need to avoid the creation of the endpoint with the default binding. In case the bindingId attribute is set this attribute will override it. If not set and not specified otherwise CXF defaults to SOAP 1.1 binding

mtomEnabled

boolean

no

Whether or not MTOM (attachment support) is enabled for this endpoint.

wsdlLocation

string

no

The location of the WSDL for your service. If this is a server side endpoint it will served to your users.

enableMuleSoapHeaders

boolean

no

true

Whether or not this endpoint should write Mule SOAP headers which pass along the correlation and ReplyTo information. This is true by default, but the Mule SOAP headers are only triggered in situations where there is an existing correlation ID and the ReplyTo header is set. (As of 2.2.1)

configuration-ref

string

no

The CXF configuration that should be used.
Table 6. Child Elements of <simple-service…​>
Name Cardinality Description

schemaLocations

0..1

ws-security

0..1

Configuration to enable WS-Security

properties

0..1

Additional properties for this service.

abstract-databinding

0..1

The databinding implementation that should be used. By default, this is JAXB for the JAX-WS frontend and Aegis for the simple frontend. A placeholder for arbitrary extensions as children of the 'mule' element. Other transports and modules can extend this if they need to add global elements to the configuration (but consider the more specific elements like abstract-connector first).

features

0..1

Any CXF features you want to apply to the client/server. See the CXF documentation for more information on features.

inInterceptors

0..1

Additional incoming interceptors for this service.

inFaultInterceptors

0..1

Additional incoming fault interceptors.

outInterceptors

0..1

Additional outgoing interceptors.

outFaultInterceptors

0..1

Additional outgoing fault interceptors.

Proxy client

Table 7. Attributes of <proxy-client…​>
Name Type Required Default Description

soapVersion

enumeration

no

The soapVersion that is going to be used for this endpoint. The specified version is translated into the corresponding bindingId value. This attribute is useful when there’s need to avoid the creation of the endpoint with the default binding. In case the bindingId attribute is set this attribute will override it. If not set and not specified otherwise CXF defaults to SOAP 1.1 binding

mtomEnabled

boolean

no

Whether or not MTOM (attachment support) is enabled for this endpoint.

wsdlLocation

string

no

The location of the WSDL for your service. If this is a server side endpoint it will served to your users.

enableMuleSoapHeaders

boolean

no

true

Whether or not this endpoint should write Mule SOAP headers which pass along the correlation and ReplyTo information. This is true by default, but the Mule SOAP headers are only triggered in situations where there is an existing correlation ID and the ReplyTo header is set. (As of 2.2.1)

configuration-ref

string

no

The CXF configuration that should be used.

serviceClass

string

no

The class CXF should use to construct its service model for the client.

decoupledEndpoint

string

no

The reply to endpoint for clients which have WS-Addressing enabled.

operation

string

no

The operation you want to invoke on the outbound endpoint.

port

string

no

The WSDL port you want to use to communicate with the service.

payload

enumeration

no

Whether the whole SOAP Envelope, or just the body contents should be sent when in proxy mode.
Table 8. Child Elements of <proxy-client…​>
Name Cardinality Description

ws-security

0..1

properties

0..1

Additional properties for this service.

abstract-databinding

0..1

The databinding implementation that should be used. By default, this is JAXB for the JAX-WS frontend and Aegis for the simple frontend. A placeholder for arbitrary extensions as children of the 'mule' element. Other transports and modules can extend this if they need to add global elements to the configuration (but consider the more specific elements like abstract-connector first).

features

0..1

Any CXF features you want to apply to the client/server. See the CXF documentation for more information on features.

inInterceptors

0..1

Additional incoming interceptors for this service.

inFaultInterceptors

0..1

Additional incoming fault interceptors.

outInterceptors

0..1

Additional outgoing interceptors.

outFaultInterceptors

0..1

Additional outgoing fault interceptors.

Simple client

Table 9. Attributes of <simple-client…​>
Name Type Required Default Description

soapVersion

enumeration

no

The soapVersion that is going to be used for this endpoint. The specified version is translated into the corresponding bindingId value. This attribute is useful when there’s need to avoid the creation of the endpoint with the default binding. In case the bindingId attribute is set this attribute will override it. If not set and not specified otherwise CXF defaults to SOAP 1.1 binding

mtomEnabled

boolean

no

Whether or not MTOM (attachment support) is enabled for this endpoint.

wsdlLocation

string

no

The location of the WSDL for your service. If this is a server side endpoint it will served to your users.

enableMuleSoapHeaders

boolean

no

true

Whether or not this endpoint should write Mule SOAP headers which pass along the correlation and ReplyTo information. This is true by default, but the Mule SOAP headers are only triggered in situations where there is an existing correlation ID and the ReplyTo header is set. (As of 2.2.1)

configuration-ref

string

no

The CXF configuration that should be used.

serviceClass

string

no

The class CXF should use to construct its service model for the client.

decoupledEndpoint

string

no

The reply to endpoint for clients which have WS-Addressing enabled.

operation

string

no

The operation you want to invoke on the outbound endpoint.
Table 10. Child Elements of <simple-client…​>
Name Cardinality Description

ws-security

0..1

properties

0..1

Additional properties for this service.

abstract-databinding

0..1

The databinding implementation that should be used. By default, this is JAXB for the JAX-WS frontend and Aegis for the simple frontend. A placeholder for arbitrary extensions as children of the 'mule' element. Other transports and modules can extend this if they need to add global elements to the configuration (but consider the more specific elements like abstract-connector first).

features

0..1

Any CXF features you want to apply to the client/server. See the CXF documentation for more information on features.

inInterceptors

0..1

Additional incoming interceptors for this service.

inFaultInterceptors

0..1

Additional incoming fault interceptors.

outInterceptors

0..1

Additional outgoing interceptors.

outFaultInterceptors

0..1

Additional outgoing fault interceptors.

Databinding

Element Attributes Child Element

aegis-databinding

none

beans:property
Spring property element for custom configuration.
Cardinality: 0..*

jaxb-databinding

none

source-databinding

none

jibx-databinding

none

stax-databinding

none

Ws security

Table 11. Attributes of <ws-security…​>
Name Type Required Default Description

name

string

no

Name of the WS-Security configuration

ref

string

no

Reference to a WS-Security configuration
Table 12. Child Elements of <ws-security…​>
Name Cardinality Description

ws-config

0..1

A map containing the WSS4J configuration. The entry key and value should map to the text strings in WSS4J’s WSHandlerConstants and WSConstants. The key is the name of the element respecting Mule’s naming format, it will be afterwards transformed to CamelCase to map the corresponding constants, e.g. password-callback-class will map to the constant passwordCallbackClass.

Ws security

Configuration to enable WS-Security

Table 13. Attributes of <ws-security…​>
Name Type Required Default Description

name

string

no

Name of the WS-Security configuration

ref

string

no

Reference to a WS-Security configuration
Table 14. Child Elements of <ws-security…​>
Name Cardinality Description

mule-security-manager

0..1

A WSS4J Password validator which verifies username/password combinations against the Mule security manager. A WSS4J Password validator which verifies username/password combinations against the Mule security manager.

ws-config

0..1

A map containing the WSS4J configuration. The entry key and value should map to the text strings in WSS4J’s WSHandlerConstants and WSConstants. The key is the name of the element respecting Mule’s naming format, it will be afterwards transformed to CamelCase to map the corresponding constants, e.g. password-callback-class will map to the constant passwordCallbackClass.

ws-custom-validator

0..1

A list of validators that allows to override the default validators used to validate a received security token.

WS-Security Validators

Username token validator

Override UsernameToken validation providing a custom implementation of the Validator instance

Table 15. Attributes of <username-token-validator…​>
Name Type Required Default Description

ref

yes

The custom validator instance to validate the tokens
Table 16. Child Elements of <username-token-validator…​>
Name Cardinality Description

Saml1 token validator

Override SAML1 token validation providing a custom implementation of the Validator instance

Table 17. Attributes of <saml1-token-validator…​>
Name Type Required Default Description

ref

yes

The custom validator instance to validate the tokens
Table 18. Child Elements of <saml1-token-validator…​>
Name Cardinality Description

Saml2 token validator

Override SAML2 token validation providing a custom implementation of the Validator instance

Table 19. Attributes of <saml2-token-validator…​>
Name Type Required Default Description

ref

yes

The custom validator instance to validate the tokens
Table 20. Child Elements of <saml2-token-validator…​>
Name Cardinality Description

Timestamp token validator

Override Timestamp validation providing a custom implementation of the Validator instance

Table 21. Attributes of <timestamp-token-validator…​>
Name Type Required Default Description

ref

yes

The custom validator instance to validate the tokens
Table 22. Child Elements of <timestamp-token-validator…​>
Name Cardinality Description

Signature token validator

Override trust verification on a signature providing a custom implementation of the Validator instance

Table 23. Attributes of <signature-token-validator…​>
Name Type Required Default Description

ref

yes

The custom validator instance to validate the tokens
Table 24. Child Elements of <signature-token-validator…​>
Name Cardinality Description

Bst token validator

Override BinarySecurityToken validation providing a custom implementation of the Validator instance

Table 25. Attributes of <bst-token-validator…​>
Name Type Required Default Description

ref

yes

The custom validator instance to validate the tokens
Table 26. Child Elements of <bst-token-validator…​>
Name Cardinality Description

Schema

Access the schema file for the SOAP Component.

See Also