Note: There is a newer version (2.3.0) of this package available. Click here to view docs for the latest version.
Module soap
ballerina/soap Ballerina library
2.2.0
Functions
applyInboundConfig
Isolated Function
function applyInboundConfig(InboundConfig inboundSecurity, xml envelope, boolean soap12) returns xml|ErrorapplySecurityPolicies
Isolated Function
function applySecurityPolicies(OutboundSecurityConfig|OutboundSecurityConfig[] security, xml envelope, boolean soap12) returns xml|Error|ErrorParameters
- security OutboundSecurityConfig|OutboundSecurityConfig[] -
- envelope xml -
- soap12 boolean (default true) -
assertSignatureWithoutX509
function assertSignatureWithoutX509(string securedEnvelope)Parameters
- securedEnvelope string -
assertSymmetricBinding
assertUsernameToken
function assertUsernameToken(string envelopeString, string username, string password, PasswordType passwordType, string body) returns error?Parameters
- envelopeString string -
- username string -
- password string -
- passwordType PasswordType -
- body string -
getReadOnlyClientConfig
Isolated Function
function getReadOnlyClientConfig(ClientConfig original) returns readonly & ClientConfigParameters
- original ClientConfig -
sendOnly
Isolated Function
sendReceive
Isolated Function
validateTransportBindingPolicy
Isolated Function
function validateTransportBindingPolicy(ClientConfig config) returns Error?Parameters
- config ClientConfig -
Enums
soap: CanonicalizationAlgorithm
Represents enums for all the supported canonicalization algorithms.
Members
C14N_OMIT_COMMENTS
C14N_WITH_COMMENTS
C14N_EXCL_OMIT_COMMENTS
C14N_EXCL_WITH_COMMENTS
soap: DigestAlgorithm
Represents enums for all the supported digest algorithms.
Members
SHA1
SHA256
SHA384
SHA512
soap: EncryptionAlgorithm
Represents enums for all the supported encryption algorithms.
Members
TRIPLE_DES
AES_128
AES_256
soap: PasswordType
Represents enums for all the supported password types.
Members
TEXT
DIGEST
DERIVED_KEY_TEXT
DERIVED_KEY_DIGEST
soap: SignatureAlgorithm
Represents enums for all the supported signature algorithms.
Members
RSA_SHA1
RSA_SHA256
RSA_SHA384
RSA_SHA512
Records
soap: ClientConfig
Closed record
SOAP client configurations.
Fields
- httpConfig ClientConfiguration(default {}) - HTTP Configuration
- outboundSecurity OutboundSecurityConfig|OutboundSecurityConfig[](default NO_POLICY) - Web service security configurations for SOAP requests
- inboundSecurity InboundSecurityConfig(default {}) - Web service security configurations to decrypt and verify SOAP responses
Errors
soap: Error
Distinct
Defines the common error type for the module.
Simple name reference types
soap: InboundSecurityConfig
InboundSecurityConfig
Represents the record for outbound security configurations to verify and decrypt SOAP envelopes.
soap: OutboundSecurityConfig
OutboundSecurityConfig
Union type of all the outbound web service security configurations.