Contact Free trial Login

Web Service Consumer Connector Reference - Mule 4

Support Version: Select

Web Service Consumer Connector Version 1.4

Web Service Consumer extension used to consume SOAP web services.

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 the runtime considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime purges the instances when it sees fit.

Connection Types

Connection

ConnectionProvider that returns instances of SoapClient.

Parameters
Name Type Description Default Value Required

Soap Version

Enumeration, one of:

  • SOAP11

  • SOAP12

The SOAP version of the WSDL.

SOAP11

Mtom Enabled

Boolean

Whether or not to use the MTOM protocol to manage the attachments.

false

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 usernameToken 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.

Supported Operations

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 to invoke.

x

Body

Binary

The XML body to include in the SOAP message with all the required parameters, or null if no params are required.

#[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.

Output

Type

SOAP Output Envelope

Attributes Type

For Configurations

Throws

  • WSC:BAD_REQUEST

  • WSC:BAD_RESPONSE

  • WSC:CANNOT_DISPATCH

  • WSC:CONNECTIVITY

  • WSC:ENCODING

  • WSC:INVALID_WSDL

  • WSC:RETRY_EXHAUSTED

  • WSC:SOAP_FAULT

  • WSC:TIMEOUT

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 true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

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 false, the reconnection strategy runs in a separate, non-blocking thread.

true

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

true

WSS Sign Security Strategy

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 Key Store 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

Field Type Description Default Value Required

Signature Key Identifier

Enumeration, one of:

  • DIRECT_REFERENCE

  • ISSUER_SERIAL

  • KEY_VALUE

  • SKI_KEY_IDENTIFIER

  • THUMBPRINT

  • X509_KEY_IDENTIFIER

ISSUER_SERIAL

Signature Algorithm

Enumeration, one of:

  • DSAwithSHA1

  • DSAwithSHA256

  • ECDSAwithSHA1

  • ECDSAwithSHA224

  • ECDSAwithSHA256

  • ECDSAwithSHA384

  • ECDSAwithSHA512

  • RSAwithSHA1

  • RSAwithSHA224

  • RSAwithSHA256

  • RSAwithSHA384

  • RSAwithSHA512

Signature Digest Algorithm

Enumeration, one of:

  • SHA1

  • SHA224

  • SHA256

  • SHA384

  • SHA512

SHA1

Signature C14n Algorithm

Enumeration, one of:

  • CanonicalXML_1_0

  • CanonicalXML_1_1

  • ExclusiveXMLCanonicalization_1_0

ExclusiveXMLCanonicalization_1_0

Wss Parts

Array of WSS Part

WSS Part

Field Type Description Default Value Required

Encode

Enumeration, one of:

  • ELEMENT

  • CONTENT

CONTENT

Namespace

String

x

Localname

String

x

WSS Verify Signature Security Strategy

Field Type Description Default Value Required

Trust Store Configuration

The trust store 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

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:

  • DIGEST

  • TEXT

A #password parameter.

TEXT

Add Nonce

Boolean

Specifies a if a cryptographically random nonce should be added 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

Field Type Description Default Value Required

Time To Live

Number

The time difference between creation and expiry times 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 units). Values lower than 1 second are set to a 1 second timestamp.

60

Time To Live Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A #timeToLive parameter. Defaults to SECONDS.

SECONDS

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

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:

  • DIRECT_REFERENCE

  • EMBEDDED_KEY_NAME

  • ENCRYPTED_KEY_SHA1

  • ISSUER_SERIAL

  • SKI_KEY_IDENTIFIER

  • THUMBPRINT

  • X509_KEY_IDENTIFIER

ISSUER_SERIAL

Encryption Sym Algorithm

Enumeration, one of:

  • AES_128

  • AES_128_GCM

  • AES_192

  • AES_192_GCM

  • AES_256

  • AES_256_GCM

  • TRIPLE_DES

AES_128

Encryption Key Transport Algorithm

Enumeration, one of:

  • KEYTRANSPORT_RSA15

  • KEYTRANSPORT_RSAOAEP

  • KEYTRANSPORT_RSAOAEP_XENC11

KEYTRANSPORT_RSAOAEP

Encryption Digest Algorithm

Enumeration, one of:

  • SHA1

  • SHA256

  • SHA384

  • SHA512

SHA1

Wss Part Adapters

Array of WSS Part

WSS Incoming Timestamp Security Strategy

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 60 to avoid problems where clocks are slightly askew. To reject all future-created Timestamps, set this value to 0.

60

Future Time To Live Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A #futureTimeToLive parameter. Defaults to SECONDS.

SECONDS

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 should be allowed to be idle before it’s considered eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime 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

HTTP Transport Configuration

Field Type Description Default Value Required

Requester Config

String

x

Default HTTP Transport Configuration

Field Type Description Default Value Required

Timeout

Number

5000

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub