CXF Component Reference

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/current/mule-cxf.xsd

Configuration Reference

JAXWS Service

Table 1. Attributes of <jaxws-service…>
Name	Description
bindingId	The binding that should be used for this endpoint. It defaults to the SOAP binding by default. Type: string Required: no Default: none
port	The WSDL port name of your service. Type: string Required: no Default: none
namespace	The service namespace. (As of 2.2.1) Type: string Required: no Default: none
service	The WSDL service name of your service. Type: string Required: no Default: none
serviceClass	The class CXF should use to construct its service model. This is optional, and by default uses the implementation class of your component, on inbound CXF endpoint. But it is mandatory for outbound endpoint when using the "aegis" front end. Type: string Required: no Default: none
validationEnabled	Whether or not validation should be enabled on this service. Validation only occurs on inbound server messages. Type: boolean Required: no Default: none
soapVersion	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 overrides it. If not set and not specified otherwise CXF defaults to SOAP 1.1 binding Type: enumeration Required: no Default: none
mtomEnabled	Whether or not MTOM (attachment support) is enabled for this endpoint. Type: boolean Required: no Default: none
wsdlLocation	The location of the WSDL for your service. If this is a server side endpoint it will served to your users. Type: string Required: no Default: none
enableMuleSoapHeaders	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) Type: boolean Required: no Default: `true`
configuration-ref	The CXF configuration that should be used. Type: string Required: no Default: none

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 data binding implementation that should be used. By default, this is JAXB for the JAX-WS front end and Aegis for the simple front end. 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	Description
bindingId	The binding that should be used for this endpoint. It defaults to the SOAP binding by default. Type: string Required: no Default: none
port	The WSDL port name of your service. Type: string Required: no Default: none
namespace	The service namespace. (As of 2.2.1) Type: string Required: no Default: none
service	The WSDL service name of your service. Type: string Required: no Default: none
serviceClass	The class CXF should use to construct its service model. This is optional, and by default uses the implementation class of your component, on inbound CXF endpoint. But it is mandatory for outbound endpoint when using the "aegis" front end. Type: string Required: no Default: none
validationEnabled	Whether or not validation should be enabled on this service. Validation only occurs on inbound server messages. Type: boolean Required: no Default: none
soapVersion	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 overrides it. If not set and not specified otherwise CXF defaults to SOAP 1.1 binding Type: enumeration Required: no Default: none
mtomEnabled	Whether or not MTOM (attachment support) is enabled for this endpoint. Type: boolean Required: no Default: none
wsdlLocation	The location of the WSDL for your service. If this is a server side endpoint it will served to your users. Type: string Required: no Default: none
enableMuleSoapHeaders	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) Type: boolean Required: no Default: `true`
configuration-ref	The CXF configuration that should be used. Type: string Required: no Default: none
payload	Whether the whole SOAP Envelope, or just the body contents should be sent when in proxy mode. Type: enumeration Required: no Default: none

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 data binding implementation that should be used. By default, this is JAXB for the JAX-WS front end and Aegis for the simple front end. 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	Description
bindingId	The binding that should be used for this endpoint. It defaults to the SOAP binding by default. Type: string Required: no Default: none
port	The WSDL port name of your service. Type: string Required: no Default: none
namespace	The service namespace. (As of 2.2.1) Type: string Required: no Default: none
service	The WSDL service name of your service. Type: string Required: no Default: none
serviceClass	The class CXF should use to construct its service model. This is optional, and by default uses the implementation class of your component, on inbound CXF endpoint. But it is mandatory for outbound endpoint when using the "aegis" front end.
validationEnabled	Whether or not validation should be enabled on this service. Validation only occurs on inbound server messages. Type: boolean Required: no Default: none
soapVersion	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 overrides it. If not set and not specified otherwise CXF defaults to SOAP 1.1 binding Type: enumeration Required: no Default: none
mtomEnabled	Whether or not MTOM (attachment support) is enabled for this endpoint. Type: boolean Required: no Default: none
wsdlLocation	The location of the WSDL for your service. If this is a server side endpoint it will served to your users. Type: string Required: no Default: none
enableMuleSoapHeaders	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) Type: boolean Required: no Default: `true`
configuration-ref	The CXF configuration that should be used. Type: string Required: no Default: none

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 data binding implementation that should be used. By default, this is JAXB for the JAX-WS front end and Aegis for the simple front end. 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	Description
soapVersion	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 overrides it. If not set and not specified otherwise CXF defaults to SOAP 1.1 binding Type: enumeration Required: no Default: none
mtomEnabled	Whether or not MTOM (attachment support) is enabled for this endpoint. Type: boolean Required: no Default: none
wsdlLocation	The location of the WSDL for your service. If this is a server side endpoint it will served to your users. Type: string Required: no Default: none
enableMuleSoapHeaders	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) Type: boolean Required: no Default: `true`
configuration-ref	The CXF configuration that should be used. Type: string Required: no Default: none
serviceClass	The class CXF should use to construct its service model for the client. Type: string Required: no Default: none
decoupledEndpoint	The reply to endpoint for clients which have WS-Addressing enabled. Type: string Required: no Default: none
operation	The operation you want to invoke on the outbound endpoint. Type: string Required: no Default: none
port	The WSDL port you want to use to communicate with the service. Type: string Required: no Default: none
payload	Whether the whole SOAP Envelope, or just the body contents should be sent when in proxy mode. Type: enumeration Required: no Default: none

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	Description
soapVersion	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 overrides it. If not set and not specified otherwise CXF defaults to SOAP 1.1 binding Type: enumeration Required: no Default: none
mtomEnabled	Whether or not MTOM (attachment support) is enabled for this endpoint. Type: boolean Required: no Default: none
wsdlLocation	The location of the WSDL for your service. If this is a server side endpoint it will served to your users. Type: string Required: no Default: none
enableMuleSoapHeaders	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) Type: boolean Required: no Default: `true`
configuration-ref	The CXF configuration that should be used. Type: string Required: no Default: none
serviceClass	The class CXF should use to construct its service model for the client. Type: string Required: no Default: none
decoupledEndpoint	The reply to endpoint for clients which have WS-Addressing enabled. Type: string Required: no Default: none
operation	The operation you want to invoke on the outbound endpoint. Type: string Required: no Default: none

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 data binding implementation that should be used. By default, this is JAXB for the JAX-WS front end and Aegis for the simple front end. 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

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

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	Description
name	Name of the WS-Security configuration Type: string Required: no Default: none
ref	Reference to a WS-Security configuration Type: string Required: no Default: none

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	Description
name	Name of the WS-Security configuration Type: string Required: no Default: none
ref	Reference to a WS-Security configuration Type: string Required: no Default: none

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	Description
ref	The custom validator instance to validate the tokens Type: Required: yes Default: none

No Child Elements of <username-token-validator…>

SAML1 Token Validator

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

Table 16. Attributes of <saml1-token-validator…>
Name	Description
ref	The custom validator instance to validate the tokens Type: Required: yes Default: none

No Child Elements of <saml1-token-validator…>

SAML2 Token Validator

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

Table 17. Attributes of <saml2-token-validator…>
Name	Description
ref	The custom validator instance to validate the tokens Type: Required: yes Default: none

No Child Elements of <saml2-token-validator…>

Timestamp Token Validator

Override Timestamp validation providing a custom implementation of the Validator instance

Table 18. Attributes of <timestamp-token-validator…>
Name	Description
ref	The custom validator instance to validate the tokens Type: Required: yes Default: none

No Child Elements of <timestamp-token-validator…>

Signature Token Validator

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

Table 19. Attributes of <signature-token-validator…>
Name	Description
ref	The custom validator instance to validate the tokens Type: Required: yes Default: none

No Child Elements of <signature-token-validator…>

BST Token Validator

Override BinarySecurityToken validation providing a custom implementation of the Validator instance

Table 20. Attributes of <bst-token-validator…>
Name	Description
ref	The custom validator instance to validate the tokens Type: Required: yes Default: none

No Child Elements of <bst-token-validator…>

Schema

Access the schema file for the SOAP Component.

CXF Component Reference

Namespace and Syntax

XML Namespace

XML Schema Location

Configuration Reference

JAXWS Service

Proxy Service

Simple Service

Proxy Client

Simple Client

Databinding

WS Security

WS Security

WS-Security Validators

Username Token Validator

SAML1 Token Validator

SAML2 Token Validator

Timestamp Token Validator

Signature Token Validator

BST Token Validator

Schema

See Also