Contact Us 1-800-596-4880
  1. Homepage
  2. APIkit (4.x)
  3. APIkit for SOAP

  4. Module Reference

APIkit for SOAP Module Reference

Configurations

Config

Configuration element for a SOAP Router

Parameters

Name Type Description Default Value Required

Name

String

Connectors use this configuration name to reference its configuration.

None

Yes

Soap Version

Enumeration, one of:

  • SOAP11

  • SOAP12

SOAP version of the WSDL.

SOAP11

No

Address

String

Address of the web service.

None

No

MTOM Enabled

Boolean

Defines if the MTOM protocol manages the attachments.

false

No

Inbound Validation Enabled

Boolean

Defines if the schema of the inbound request is validated.

false

No

Inbound Validation Message Level

Enumeration, one of:

  • WARN

  • ERROR

Defines the validation level of the inbound requests. If set to ERROR, the validation fails and sends an error to the flow.

WARN

No

HTTP Status Var Name

String

Variable name for the HTTP status.

httpStatus

No

Namespace Prefixes

Object

Map of custom namespaces prefixes to specify in response.

None

No

Expiration Policy

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the run-time considers it eligible for expiration. The platform does not necessarily expire the instance at the exact moment that it becomes eligible. The run-time purges the instances when it considers it appropriate.

None

No

WSDL Location

String

WSDL file URL, remote or local.

None

Yes

Service

String

Name of the service.

None

Yes

Port

String

Name of the port.

None

Yes

Associated Operations

Operations

SOAP Fault

<apikit-soap:fault>

APIkit for SOAP Fault

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration.

None

Yes

Payload

Binary

Mule payload.

#[payload]

No

Streaming Strategy

Configure if repeatable streams and their behavior are used.

Non repeatable stream

No

Operation

String

An operation defined in the WSDL.

None

Yes

Fault

String

A fault defined in the selected operation.

None

Yes

Target Variable

String

Name of a variable on which the operation output is placed.

None

No

Target Value

String

Expression that is evaluated against the operation output. The effect of the expression is stored in the target variable.

#[payload]

No

Output

Type

Binary

For Configurations

Throws

  • APIKIT-SOAP:FAULT

  • APIKIT-SOAP:ROUTER

SOAP Router

<apikit-soap:router>

APIkit for SOAP Router

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration.

None

Yes

Message

Binary

Mule payload.

#[payload]

Attributes

Object

Map of Mule message attributes.

None

Yes

Output Mime Type

String

MIME type of the payload that this operation outputs.

None

No

Output Encoding

String

Encoding of the payload that this operation outputs.

None

No

Streaming Strategy

Configure if repeatable streams and their behavior are used.

Non repeatable stream

No

Target Variable

String

Name of a variable on which the operation output is placed.

None

No

Target Value

String

Expression that is evaluated against the operation output. The outcome of the expression is stored in the target variable.

#[payload]

No

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • APIKIT-SOAP:FAULT

  • APIKIT-SOAP:ROUTER

Types

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

None

No

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute

None

No

Repeatable in Memory Stream

Field Type Description Default Value Required

Initial Buffer Size

Number

Amount of memory that is allocated to consume the stream and provide random access to it. If the stream contains more data than buffer capacity, then it’s expanded according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

None

No

Buffer Size Increment

Number

Amount the buffer size expands if it exceeds its initial size. A value of zero or lower specifies that the buffer doesn’t expand. When the buffer is full, a STREAM_MAXIMUM_SIZE_EXCEEDED error occurs.

None

No

Max Buffer Size

Number

Maximum amount of memory used. If more is used, a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower or equal to zero means no limit.

None

No

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed.

None

No

Repeatable File Store Stream

Field Type Description Default Value Required

In Memory Size

Number

Defines the maximum memory that the stream uses to keep data in memory. If it consumes more, the stream buffers the content on disk.

None

No

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed.

None

No

SOAP Attributes

Field Type Description Default Value Required

Protocol Headers

Object

Protocol headers bundled in the response

None

No

Additional Transport Data

Object

Additional transport data bundled in the response

None

No

APIkit for SOAP System Properties

System Property Default Description Since

mule.soapkit.allowControlCharacters

false

Enables the use of XML 1.1 C0 characters.

1.3.0