Web Service Consumer Connector Reference - Mule 4
Web Service Consumer Connector Version 1.5
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
Default Configuration
Default configuration.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Name |
String |
The name for this configuration. Connectors reference the configuration with this name. |
x |
|
Connection |
The connection types to provide to this configuration. |
x |
||
Expiration Policy |
Configures the minimum amount of time that a dynamic configuration instance can remain idle before it is eligible for expiration. Once a configuration instance is designated as expired, it is subsequently purged. |
Connection Types
Connection
Connection provider that returns instances of WSC SOAP client.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Soap Version |
Enumeration, one of:
|
The SOAP version of the WSDL. |
SOAP11 |
|
Mtom enabled |
Boolean |
Determines whether or not to use the MTOM protocol to manage the attachments. |
|
|
Encoding |
String |
Default character encoding to use in all the messages. If not specified, the default charset in the mule configuration is used. |
||
Transport Configuration |
The transport configuration used to dispatch the SOAP messages. |
|||
WSDL Location |
String |
The WSDL file URL (remote or local). |
x |
|
Service |
String |
The service name. |
x |
|
Port |
String |
The port name. |
x |
|
Address |
String |
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 |
A sign WSS configuration. |
|||
Verify Signature Security Strategy |
A verify signature WSS configuration. |
|||
Username Token Security Strategy |
A username token security strategy WSS configuration. |
|||
Outgoing Timestamp Security Strategy |
A timestamp WSS configuration. |
|||
Decrypt Security Strategy |
A decrypt WSS configuration. |
|||
Encrypt Security Strategy |
An encrypt WSS configuration. |
|||
Incoming Timestamp Security Strategy |
A timestamp verification WSS configuration. |
|||
Must Understand |
Boolean |
Determines whether the Must understand attribute in the Web Service Security header is |
|
|
Actor |
String |
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 Web Service Security header to a specific endpoint. This parameter’s value must be a URI. |
Operations
Consume
<wsc:consume>
Consumes an operation from a SOAP Web Service.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Operation |
String |
The name of the Web service operation that aims to invoke. |
x |
|
Body |
Binary |
The XML body to include in the SOAP message, with all the required parameters, or |
#[payload] |
|
Headers |
Binary |
The XML headers to include in the SOAP message. |
||
Attachments |
Object |
The attachments to include in the SOAP request. |
||
Headers |
Object |
A group of transport headers that are bounded with the transport request. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Types
Reconnection
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Fails Deployment |
Boolean |
When the application is deployed, a connectivity test is performed on all connectors. If set to |
||
Reconnection Strategy |
The reconnection strategy to use. |
Reconnect
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Frequency |
Number |
How often (in milliseconds) to reconnect. |
||
Count |
Number |
How many reconnection attempts to make. |
||
blocking |
Boolean |
If |
|
Reconnect Forever
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Frequency |
Number |
How often (in milliseconds) to reconnect. |
||
blocking |
Boolean |
If |
|
WSS Sign Security Strategy Adapter
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Key Store Configuration |
The keystore to use when signing the message. |
x |
||
Sign Algorithm Configuration |
The algorithms to use on the signing. |
WSS Keystore Configuration
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Key Store Path |
String |
x |
||
Alias |
String |
x |
||
Password |
String |
x |
||
Key Password |
String |
|||
Type |
String |
JKS |
WSS Sign Configuration Adapter
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Signature Key Identifier |
Enumeration, one of:
|
ISSUER_SERIAL |
||
Signature Algorithm |
Enumeration, one of:
|
|||
Signature Digest Algorithm |
Enumeration, one of:
|
SHA1 |
||
Signature C14n Algorithm |
Enumeration, one of:
|
ExclusiveXMLCanonicalization_1_0 |
||
WSS Parts |
Array of WSS Part |
WSS Part
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Encode |
Enumeration, one of:
|
CONTENT |
||
Namespace |
String |
x |
||
Localname |
String |
x |
WSS Verify Signature Security Strategy Adapter
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Trust Store Configuration |
The truststore to use to verify the signature. |
WSS Trust Store Configuration
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Trust Store Path |
String |
x |
||
Password |
String |
x |
||
Type |
String |
jks |
WSS Username Token Security Strategy Adapter
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Username |
String |
The username required to authenticate with the service. |
x |
|
Password |
String |
The password for the provided username required to authenticate with the service. |
x |
|
Password Type |
Enumeration, one of:
|
A #password parameter. |
TEXT |
|
Add Nonce |
Boolean |
Specifies whether to add a cryptographically random nonce to the message. |
false |
|
Add Created |
Boolean |
Specifies if a timestamp should be created to indicate the creation time of the message. |
false |
WSS Timestamp Security Strategy Adapter
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Time To Live |
Number |
The time difference between creation and expiry time in the time unit specified in |
60 |
|
Time To Live Unit |
Enumeration, one of:
|
A Time to live parameter. Defaults to |
|
WSS Decrypt Security Strategy
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Key Store Configuration |
The keystore to use when decrypting the message. |
x |
WSS Encrypt Security Strategy Adapter
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Key Store Configuration |
The keystore to use when encrypting the message. |
x |
||
Encryption Algorithms Configuration |
WSS Encryption Algorithms Configuration
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Encryption Key Identifier |
Enumeration, one of:
|
ISSUER_SERIAL |
||
Encryption Sym Algorithm |
Enumeration, one of:
|
AES_128 |
||
Encryption Key Transport Algorithm |
Enumeration, one of:
|
KEYTRANSPORT_RSAOAEP |
||
Encryption Digest Algorithm |
Enumeration, one of:
|
SHA1 |
||
Wss Part Adapters |
Array of WSS Part |
WSS Incoming Timestamp Security Strategy Adapter
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Future Time To Live |
Number |
Specifies the time in the future within which the Created time of an incoming timestamp is valid. The default
value is |
|
|
Future Time To Live Unit |
Enumeration, one of:
|
A Future time to live unit parameter. Defaults to |
|
Expiration Policy
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Max Idle Time |
Number |
A scalar time value for the maximum amount of time a dynamic configuration instance can be idle before it’s considered eligible for expiration. |
||
Time Unit |
Enumeration, one of:
|
A time unit that qualifies the Max idle time attribute. |
SOAP Output Envelope
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Attachments |
Object |
|||
Body |
Binary |
|||
Headers |
Object |
SOAP Attributes
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Protocol Headers |
Object |
The protocol headers bundled in the response. |
x |
|
Additional Transport Data |
Object |
The additional transport data bundled in the response. |
x |