Web Service Consumer Connector 2.0 Reference | MuleSoft Documentation
# Web Service Consumer Connector 2.0 Reference
Anypoint Connector for Web Service Consumer (Web Service Consumer Connector) consumes a SOAP Web service to acquire data from an external source.
Release Notes: Web Service Consumer Release Notes
## Configurations
### Config
Default configuration
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Name for this configuration. Connectors reference the configuration with this name.  
**Connection** |  The connection types to provide to this configuration.  
The identifier of this element used to reference it in other components.  
**Expiration Policy** |  Expiration Policy |  Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.  
#### Connection Types
##### Connection
ConnectionProvider that returns instances of WscSoapClient.
###### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Soap Version** |  Enumeration, one of:
  * SOAP11
  * SOAP12

|  The soap version of the WSDL.  
**Mtom Enabled** |  If should use the MTOM protocol to manage the attachments or not.  
Default character encoding to use in all the messages. If not specified, the default charset in the mule configuration will be used  
**Transport Configuration** |  One of:
  * HTTP Transport Configuration
  * Default HTTP Transport Configuration

|  The transport configuration used to dispatch the SOAP messages.  
**Wsdl Location** |  The WSDL file URL remote or local.  
The service name.  
The port name.  
The address of the web service.  
**Reconnection** |  |  When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy  
**Sign Security Strategy** |  WSS Sign Security Strategy Adapter |  A sign WSS configuration  
**Verify Signature Security Strategy** |  WSS Verify Signature Security Strategy Adapter |  A verify signature WSS configuration  
**Username Token Security Strategy** |  Wss Username Token Security Strategy Adapter |  A usernameToken WSS configuration  
**Outgoing Timestamp Security Strategy** |  WSS Timestamp Security Strategy Adapter |  A timestamp WSS configuration  
**Decrypt Security Strategy** |  WSS Decrypt Security Strategy |  A decrypt WSS configuration  
**Encrypt Security Strategy** |  WSS Encrypt Security Strategy Adapter |  an encrypt WSS configuration  
**Incoming Timestamp Security Strategy** |  WSS Incoming Timestamp Security Strategy Adapter |  A timestamp verification WSS configuration  
**Must Understand** |  Whether mustUnderstand attribute in wsse:Security header is true or false. Defaults to true TODO (W-11800462): For the next major (v2.0.0) the default value should be false to match the SOAP protocol standard.  
A SOAP message may travel from a sender to a receiver by passing different endpoints along the message path. The SOAP actor attribute is used to address the wsse:Security header to a specific endpoint. This parameter values must be a URI.  
**Security Headers Order** |  Enumeration, one of:
  * TimestampAtEnd
  * TimestampAtStart

|  Select the order of outgoing WS-Security tags.  
## Supported Operations
## Operations
### Consume
`<wsc:consume>`
Consumes an operation from a SOAP Web Service.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  Name of the configuration to use.  
The name of the web service operation that aims to invoke.  
**Config Ref** |  ConfigurationProvider |  The name of the configuration to use to execute this component.  
The XML body to include in the SOAP message, with all the required parameters, or null if no params are required.  
The XML headers to include in the SOAP message.  
**Attachments** |  The attachments to include in the SOAP request.  
A group of transport headers that will be bounded with the transport request.  
**Force XML Prolog into body** |  If true, the XML Prolog statement will be appended to the request’s body.  
**Target Variable** |  Name of the variable that storesoperation’s output will be placed  
**Target Value** |  An expression to evaluate against the operation’s output and store the expression outcome in the target variable  
**Error Mappings** |  Array of Error Mapping |  Set of error mappings.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  Retry strategy in case of connectivity errors.  
#### Output
SOAP Output Envelope  
---  
Attributes Type |  SOAP Attributes  
### For Configurations
#### Throws
  * WSC:SOAP_FAULT
  * WSC:EMPTY_RESPONSE
  * WSC:TIMEOUT
  * WSC:BAD_RESPONSE
  * WSC:BAD_REQUEST
  * WSC:CONNECTIVITY
  * WSC:CANNOT_DISPATCH
  * WSC:RETRY_EXHAUSTED
  * WSC:INVALID_WSDL
  * WSC:ENCODING


## Types
### Reconnection
Configures a reconnection strategy for an operation.
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Fails Deployment** |  When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  Reconnection strategy to use.  
### Reconnect
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
How often to attempt to reconnect, in milliseconds.  
If false, the reconnection strategy runs in a separate, non-blocking thread.  
How many reconnection attempts the Mule app can make.  
### Reconnect Forever
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
How often to attempt to reconnect, in milliseconds.  
If false, the reconnection strategy runs in a separate, non-blocking thread.  
### WSS Sign Security Strategy Adapter
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Key Store Configuration** |  WSS Key Store Configuration |  The keystore to use when signing the message.  
**Sign Algorithm Configuration** |  WSS Sign Configuration Adapter |  The algorithms to use on the signing.  
### WSS Key Store Configuration
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Key Store Path**  
Password to authenticate against the proxy server.  
**Key Password**  
### WSS Sign Configuration Adapter
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Signature Key Identifier** |  Enumeration, one of:
  * ISSUER_SERIAL
  * DIRECT_REFERENCE
  * X509_KEY_IDENTIFIER
  * THUMBPRINT
  * SKI_KEY_IDENTIFIER
  * KEY_VALUE

|  ISSUER_SERIAL  
**Signature Algorithm** |  Enumeration, one of:
  * RSAwithSHA256
  * ECDSAwithSHA256
  * DSAwithSHA1
  * RSAwithSHA1
  * RSAwithSHA224
  * RSAwithSHA384
  * RSAwithSHA512
  * ECDSAwithSHA1
  * ECDSAwithSHA224
  * ECDSAwithSHA384
  * ECDSAwithSHA512
  * DSAwithSHA256

  
**Signature Digest Algorithm** |  Enumeration, one of:
  * SHA256
  * SHA224
  * SHA384
  * SHA512

  
**Signature C14n Algorithm** |  Enumeration, one of:
  * CanonicalXML_1_0
  * CanonicalXML_1_1
  * ExclusiveXMLCanonicalization_1_0

|  ExclusiveXMLCanonicalization_1_0  
Array of WSS Part  
### WSS Part
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Enumeration, one of:
  * ELEMENT
  * CONTENT

  
### WSS Verify Signature Security Strategy Adapter
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Trust Store Configuration** |  WSS Trust Store Configuration |  The truststore to use to verify the signature.  
### WSS Trust Store Configuration
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Trust Store Path**  
Password to authenticate against the proxy server.  
### Wss Username Token Security Strategy Adapter
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The username required to authenticate with the service.  
The password for the provided username required to authenticate with the service.  
**Password Type** |  Enumeration, one of:
  * DIGEST
**Signature Digest Algorithm** |  Enumeration, one of:
  * SHA256
  * SHA224
  * SHA384
  * SHA512

  
**Signature C14n Algorithm** |  Enumeration, one of:
  * CanonicalXML_1_0
  * CanonicalXML_1_1
  * ExclusiveXMLCanonicalization_1_0

|  ExclusiveXMLCanonicalization_1_0  
Array of WSS Part  
### WSS Part
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Enumeration, one of:
  * ELEMENT
  * CONTENT

  
### WSS Verify Signature Security Strategy Adapter
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Trust Store Configuration** |  WSS Trust Store Configuration |  The truststore to use to verify the signature.  
### WSS Trust Store Configuration
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Trust Store Path**  
Password to authenticate against the proxy server.  
### Wss Username Token Security Strategy Adapter
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The username required to authenticate with the service.  
The password for the provided username required to authenticate with the service.  
**Password Type** |  Enumeration, one of:
  * DIGEST

|  A #password parameter.  
Specifies a if a cryptographically random nonce should be added to the message.  
**Add Created** |  Specifies if a timestamp should be created to indicate the creation time of the message.  
### WSS Timestamp Security Strategy Adapter
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Time To Live** |  The time difference between creation and expiry time in the time unit specified in timeToLiveUnit. After this time the message is invalid. ```
This parameter values must be greater or equal to 1 second (or similar in other unit). Values lower than 1 second will end up
in 1 second timestamp.
```
  
**Time To Live Unit** |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

|  A #timeToLive parameter. ```
Defaults to SECONDS
```
  
### WSS Decrypt Security Strategy
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Key Store Configuration** |  WSS Key Store Configuration |  The keystore to use when decrypting the message.  
### WSS Encrypt Security Strategy Adapter
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Key Store Configuration** |  WSS Key Store Configuration |  The keystore to use when encrypting the message.  
**Encryption Algorithms Configuration** |  WSS Encryption Algorithms Configuration  
### WSS Encryption Algorithms Configuration
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Encryption Key Identifier** |  Enumeration, one of:
  * ISSUER_SERIAL
  * DIRECT_REFERENCE
  * X509_KEY_IDENTIFIER
  * THUMBPRINT
  * SKI_KEY_IDENTIFIER
  * ENCRYPTED_KEY_SHA1
  * EMBEDDED_KEY_NAME

|  ISSUER_SERIAL  
**Encryption Sym Algorithm** |  Enumeration, one of:
  * TRIPLE_DES
  * AES_128
  * AES_256
  * AES_192
  * AES_128_GCM
  * AES_192_GCM
  * AES_256_GCM

  
**Encryption Key Transport Algorithm** |  Enumeration, one of:
  * KEYTRANSPORT_RSA15
  * KEYTRANSPORT_RSAOAEP
  * KEYTRANSPORT_RSAOAEP_XENC11

|  KEYTRANSPORT_RSAOAEP  
**Encryption Digest Algorithm** |  Enumeration, one of:
  * SHA256
  * SHA384
  * SHA512

  
**Wss Part Adapters** |  Array of WSS Part  
### WSS Incoming Timestamp Security Strategy Adapter
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Future Time To Live** |  Specifies the time in the future within which the Created time of an incoming Timestamp is valid. The default value is "60", to avoid problems where clocks are slightly askew. To reject all future-created Timestamps, set this value to "0".  
**Future Time To Live Unit** |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

|  A #futureTimeToLive parameter. ```
Defaults to SECONDS
```
  
### Expiration Policy
Configures an expiration policy strategy.
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Max Idle Time** |  Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.  
Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

|  Time unit for the **Max Idle Time** field.  
### SOAP Output Envelope
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Attachments**  
Map of HTTP headers in the message.  
### SOAP Attributes
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Protocol Headers** |  The protocol headers bundled in the response.  
**Additional Transport Data** |  The additional transport data bundled in the response.  
### Error Mapping
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Enumeration, one of:
  * REDELIVERY_EXHAUSTED
  * TRANSFORMATION
  * EXPRESSION
  * SECURITY
  * CLIENT_SECURITY
  * SERVER_SECURITY
  * ROUTING
  * CONNECTIVITY
  * RETRY_EXHAUSTED
  * TIMEOUT

|  Source of the error.  
Target of the error.  
### HTTP Transport Configuration
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Requester Config**  
### Default HTTP Transport Configuration
Field | Type | Description | Default Value | Required  
---|---|---|---|---