Call SOAP API

This handler (com.rierino.handler.soap.SoapEventHandler) provides ability to use SOAP services for 3rd party integrations.

Handler Parameters

Parameter
Definition
Example
Default

soap.state

Name of the state manager keeping soap service definitions (files, soapVersion, serviceName, serviceClassName)

soap_services

handler_soap

soap.domain

Domain name for filtering entries in soap.state

pricing

-

soap.local.dir

Local directory to use for storing service jar files

/tmp

[java.io.tmpdir]

This handler requires the following dependency added to deployment contents:

implementation (group:'com.rierino.custom', name: 'soap', version:"${rierinoVersion}")

Actions

GetAvailableOperations

Gets list of available operations/methods for a SOAP service. Event metadata fields applicable for this action are as follows:

Field
Definition
Example
Default

outputElement

Json path for the output in response event payload

ops

list

With event metadata parameters as:

Parameter
Definition
Example
Default

serviceName

Name of the service to get operations for

price_calculator

-

Invoke

Invokes a specific operation on a SOAP service. Event metadata fields applicable for this action are as follows:

Field
Definition
Example
Default

inputElement

Json path for the input in request event payload

parameters

-

outputElement

Json path for the output in response event payload

ops

list

With event metadata parameters as:

Parameter
Definition
Example
Default

inputPattern

JMESPath pattern to apply on data input

{"item": product}

-

outputPattern

JMESPath pattern to apply on data output

{"product_price": price}

-

serviceName

Name of the service to use

price_calculator

-

operation

Name of the operation to call

calculate

-

Input element of the event payload should match parameter names required by the SOAP operation.

Last updated