Nav

Web Service Consumer Connector Reference

Web Service Consumer extension used to consume SOAP web services.

Configurations


Config

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 that can be provided 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 will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it 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

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

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

 

Timestamp Security Strategy

a timestamp WSS configuration

 

Decrypt Security Strategy

a decrypt WSS configuration

 

Encrypt Security Strategy

an encrypt WSS configuration

 

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

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Attributes Type

For Configurations.

Throws

  • WSC:RETRY_EXHAUSTED  

  • WSC:INVALID_WSDL  

  • WSC:BAD_REQUEST  

  • WSC:CANNOT_DISPATCH  

  • WSC:BAD_RESPONSE  

  • WSC:ENCODING  

  • WSC:SOAP_FAULT  

  • WSC:TIMEOUT  

  • WSC:CONNECTIVITY  

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 will fail 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 ms) to reconnect

Count

Number

How many reconnection attempts to make

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often (in ms) to reconnect

Wss Sign Security Strategy

Field Type Description Default Value Required

Key Store Configuration

x

Wss Key Store Configuration

Field Type Description Default Value Required

Alias

String

x

Key Password

String

Password

String

x

Key Store Path

String

x

Type

String

jks

Wss Verify Signature Security Strategy

Field Type Description Default Value Required

Trust Store Configuration

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

x

Password

String

x

Password Type

Enumeration, one of:

  • TEXT

  • DIGEST

TEXT

Add Nonce

Boolean

false

Add Created

Boolean

false

Wss Timestamp Security Strategy

Field Type Description Default Value Required

Time To Live

Number

60

Time To Live Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

SECONDS

Wss Decrypt Security Strategy

Field Type Description Default Value Required

Key Store Configuration

x

Wss Encrypt Security Strategy

Field Type Description Default Value Required

Key Store Configuration

x

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 Payload

Field Type Description Default Value Required

Attachments

Object

Body

Binary

Headers

Object

Soap Attributes

Field Type Description Default Value Required

Protocol Headers

Object

Http Transport Configuration

Field Type Description Default Value Required

Requester Config

String

x