Contact Us 1-800-596-4880
  1. Homepage
  2. Web Service Consumer Connector (1.10)

  3. Web Service Consumer Connector Reference

All Connectors

Web Service Consumer Connector Reference - Mule 4

Web Service Consumer Connector Version 1.10

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

String

Name for this configuration. Connectors reference the configuration with this name.

x

Connection

Connection

The connection types to provide to this configuration.

x

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.

SOAP11

Mtom Enabled

Boolean

If should use the MTOM protocol to manage the attachments or not.

false

Encoding

String

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:

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

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

Boolean

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.

true

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

String

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 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 will be bounded with the transport request.

Force XML Prolog into body

Boolean

If true, the XML Prolog statement will be appended to the request’s body.

false

Target Variable

String

Name of the variable that storesoperation’s output will be placed

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

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

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

Reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Count

Number

How many reconnection attempts the Mule app can make.

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often to attempt to reconnect, in milliseconds.

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.

x

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

String

x

Alias

String

x

Password

String

Password to authenticate against the proxy server.

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

  • 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:

  • SHA1

  • SHA256

  • SHA224

  • 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 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

String

x

Password

String

Password to authenticate against the proxy server.

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:

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

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

WSS 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

WSS Key Store Configuration

The keystore to use when encrypting the message.

x

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

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 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 "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

Configures an expiration policy strategy.

Field Type Description Default Value Required

Max Idle Time

Number

Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Max Idle Time field.

SOAP Output Envelope

Field Type Description Default Value Required

Attachments

Object

Body

Binary

Headers

Object

Map of HTTP headers in the message.

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
Back to top
View on GitHub