Module soap
ballerina/soap Ballerina library
0.1.0
Overview
This module provides APIs to send an ordinary XML request to a SOAP backend by specifying the necessary details to construct a SOAP envelope.
Soap module abstracts out the details of the creation of a SOAP envelope, headers, and the body in a SOAP message.
For information on the operations, which you can perform with the soap module, see the below Functions.
Clients
soap: Client
Isolated
Object for the basic SOAP client endpoint.
Constructor
Gets invoked during object initialization.
init (string url, *ClientConfiguration config)- url string - URL endpoint
- config *ClientConfiguration - Configurations for SOAP client
sendReceive
Remote Function
Sends SOAP request and expects a response.
xml|mime:Entity[] response = check soapClient->sendReceive(body);
Parameters
sendOnly
Remote Function
Fires and forgets requests. Sends the request without the possibility of any response from the service (even an error).
check soapClient->sendOnly(body);
Parameters
Return Type
- Error? - If successful, returns
nil. Else, returns an error
Enums
soap: SoapVersion
Defines the supported SOAP versions.
Members
SOAP11 - Represents SOAP 1.1 version
SOAP12 - Represents SOAP 1.2 version
Records
soap: ClientConfiguration
Closed record
Soap client configurations.
Fields
- Fields Included from * ClientConfiguration
- secureSocket ClientSecureSocket|()
- httpVersion HttpVersion
- http1Settings ClientHttp1Settings
- http2Settings ClientHttp2Settings
- timeout decimal
- forwarded string
- followRedirects FollowRedirects|()
- poolConfig PoolConfiguration|()
- cache CacheConfig
- compression Compression
- auth CredentialsConfig|BearerTokenConfig|JwtIssuerConfig|OAuth2ClientCredentialsGrantConfig|OAuth2PasswordGrantConfig|OAuth2RefreshTokenGrantConfig|OAuth2JwtBearerGrantConfig|()
- circuitBreaker CircuitBreakerConfig|()
- retryConfig RetryConfig|()
- cookieConfig CookieConfig|()
- responseLimits ResponseLimitConfigs
- proxy ProxyConfig|()
- validation boolean
- socketConfig ClientSocketConfig
- soapVersion SoapVersion(default SOAP11) - SOAP version
Errors
soap: Error
Distinct
Defines the common error type for the module.