Class SOAPUtil

Utility class for working with SOAP web services. This class provides methods for setting SOAP headers and a set of constants representing the supported header names.

If you want to use ws-security features, such as signing and encryption, with your RPC-style SOAP web service, use this class to construct a HashMap with security constants and values.

Note: this method handles sensitive security-related data. Pay special attention to PCI DSS v3. requirements 2, 4, and 12. The following example configures the ws-security actions taken for the request and response to a web service.

See Also:

Deprecated:

This class is deprecated, please use webreferences2 instead (see also WSUtil).
ConstantDescription
WS_ACTION: String = "action"WS-Security action property name.
WS_ENCRYPT: String = "Encrypt"WS-Security action: encrypt the message.
WS_ENCRYPTION_PARTS: String = "encryptionParts"WS-Security encryption: defines which parts of the request are encrypted.
WS_ENCRYPTION_USER: String = "encryptionUser"WS-Security encryption: the user's name for encryption.
WS_ENC_PROP_KEYSTORE_ALIAS: String = "__EncryptionPropKeystoreAlias"WS-Security encryption: the encryption/decryption keystore alias name
WS_ENC_PROP_KEYSTORE_PW: String = "__EncryptionPropKeystorePassword"WS-Security encryption: the encryption/decryption keystore password
WS_ENC_PROP_KEYSTORE_TYPE: String = "__EncryptionPropKeystoreType"WS-Security encryption: the encryption/decryption keystore type ( jks or pkcs12 ), default is jks.
WS_NO_SECURITY: String = "NoSecurity"WS-Security action: no security
WS_PASSWORD_TYPE: String = "passwordType"WS-Security password type: parameter for UsernameToken action to define the encoding of the password.
WS_PW_DIGEST: String = "PasswordDigest"WS-Security password of type digest: use a password digest to send the password information.
WS_PW_TEXT: String = "PasswordText"WS-Security password of type text: send the password information in clear text.
WS_SECRETS_MAP: String = "__SecretsMap"A secrets map with the username/password entries is needed to create the password callback object.
WS_SIGNATURE: String = "Signature"WS-Security action: sign the message.
WS_SIGNATURE_PARTS: String = "signatureParts"WS-Security signature: defines which parts of the request are signed.
WS_SIGNATURE_USER: String = "signatureUser"WS-Security signature: the user's name for signature.
WS_SIG_DIGEST_ALGO: String = "signatureDigestAlgorithm"WS-Security signature: sets the signature digest algorithm to use.
WS_SIG_PROP_KEYSTORE_ALIAS: String = "__SignaturePropKeystoreAlias"WS-Security signature: the signature keystore alias name
WS_SIG_PROP_KEYSTORE_PW: String = "__SignaturePropKeystorePassword"WS-Security signature: the signature keystore password.
WS_SIG_PROP_KEYSTORE_TYPE: String = "__SignaturePropKeystoreType"WS-Security: the signature keystore type ( jks or pkcs12 ).
WS_TIMESTAMP: String = "Timestamp"WS-Security action: add a timestamp to the security header.
WS_USER: String = "user"WS-Security user name.
WS_USERNAME_TOKEN: String = "UsernameToken"WS-Security action: add a UsernameToken identification.
ConstructorDescription
SOAPUtil()
MethodDescription
static getHTTPRequestHeader(Object, String)Returns an HTTP request header property value using the specified key.
static getHTTPResponseHeader(Object, String)Returns an HTTP response header property value using the specified key.
static setHTTPRequestHeader(Object, String, String)Sets an HTTP request header property using the specified key and value.
static setHeader(Object, String)Sets a new SOAPHeaderElement in the SOAP request with the namespace of the XML content.
static setHeader(Object, String, Boolean)Sets a new SOAPHeaderElement in the SOAP request with the namespace of the XML content.
static setHeader(Object, String, String, Object)Creates a new SOAPHeaderElement with the name and namespace and places the given XML into it.
static setHeader(Object, String, String, Object, Boolean)Creates a new SOAPHeaderElement with the name and namespace and places the given XML into it.
static setHeader(Object, String, String, Object, Boolean, String)Creates a new SOAPHeaderElement with the name and namespace and places the given XML into it.
static setHeader(Object, String, String, String)Creates a new SOAPHeaderElement with the name and namespace and places the given XML into it.
static setHeader(Object, String, String, String, Boolean)Creates a new SOAPHeaderElement with the name and namespace and places the given XML into it.
static setHeader(Object, String, String, String, Boolean, String)Creates a new SOAPHeaderElement with the name and namespace and places the given XML into it.
static setWSSecurityConfig(Object, Object, Object)Sets the WS-Security configuration for the request and response based on the constants defined.

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

WS_ACTION: String = "action"

WS-Security action property name. Allowed property values are WS_NO_SECURITY, WS_TIMESTAMP, WS_ENCRYPT, WS_SIGNATURE, WS_USERNAME_TOKEN or a space separated String with multiple values.

Deprecated:

use webreferences2 instead
WS_ENCRYPT: String = "Encrypt"

WS-Security action: encrypt the message. The encryption-specific parameters define how to encrypt, which keys to use, and other parameters.

Deprecated:

use webreferences2 instead
WS_ENCRYPTION_PARTS: String = "encryptionParts"

WS-Security encryption: defines which parts of the request are encrypted.

Deprecated:

use webreferences2 instead
WS_ENCRYPTION_USER: String = "encryptionUser"

WS-Security encryption: the user's name for encryption.

Deprecated:

use webreferences2 instead
WS_ENC_PROP_KEYSTORE_ALIAS: String = "__EncryptionPropKeystoreAlias"

WS-Security encryption: the encryption/decryption keystore alias name

Deprecated:

use webreferences2 instead
WS_ENC_PROP_KEYSTORE_PW: String = "__EncryptionPropKeystorePassword"

WS-Security encryption: the encryption/decryption keystore password

Deprecated:

use webreferences2 instead
WS_ENC_PROP_KEYSTORE_TYPE: String = "__EncryptionPropKeystoreType"

WS-Security encryption: the encryption/decryption keystore type ( jks or pkcs12 ), default is jks.

Note: the keystore file must have the basename of the WSDL file and the file extension based on the keystore type. For example: MyService.jks. The keystore file must be placed in the same cartridge directory as the WSDL file.

Deprecated:

use webreferences2 instead
WS_NO_SECURITY: String = "NoSecurity"

WS-Security action: no security

Deprecated:

use webreferences2 instead
WS_PASSWORD_TYPE: String = "passwordType"

WS-Security password type: parameter for UsernameToken action to define the encoding of the password. Allowed values are PW_DIGEST or PW_TEXT.

Deprecated:

use webreferences2 instead
WS_PW_DIGEST: String = "PasswordDigest"

WS-Security password of type digest: use a password digest to send the password information.

Deprecated:

use webreferences2 instead
WS_PW_TEXT: String = "PasswordText"

WS-Security password of type text: send the password information in clear text.

Deprecated:

use webreferences2 instead
WS_SECRETS_MAP: String = "__SecretsMap"

A secrets map with the username/password entries is needed to create the password callback object.

Deprecated:

use webreferences2 instead
WS_SIGNATURE: String = "Signature"

WS-Security action: sign the message. The signature-specific parameters define how to sign, which keys to use, and other parameters.

Deprecated:

use webreferences2 instead
WS_SIGNATURE_PARTS: String = "signatureParts"

WS-Security signature: defines which parts of the request are signed.

Deprecated:

use webreferences2 instead
WS_SIGNATURE_USER: String = "signatureUser"

WS-Security signature: the user's name for signature.

Deprecated:

use webreferences2 instead
WS_SIG_DIGEST_ALGO: String = "signatureDigestAlgorithm"

WS-Security signature: sets the signature digest algorithm to use.

Deprecated:

use webreferences2 instead
WS_SIG_PROP_KEYSTORE_ALIAS: String = "__SignaturePropKeystoreAlias"

WS-Security signature: the signature keystore alias name

Deprecated:

use webreferences2 instead
WS_SIG_PROP_KEYSTORE_PW: String = "__SignaturePropKeystorePassword"

WS-Security signature: the signature keystore password.

Deprecated:

use webreferences2 instead
WS_SIG_PROP_KEYSTORE_TYPE: String = "__SignaturePropKeystoreType"

WS-Security: the signature keystore type ( jks or pkcs12 ). The default is jks.

Note: The keystore file must have the basename of the WSDL file and the file extension of the keystore type. For example: MyService.jks. The keystore file must be placed in the same cartridge directory as the WSDL file.

Deprecated:

use webreferences2 instead
WS_TIMESTAMP: String = "Timestamp"

WS-Security action: add a timestamp to the security header.

Deprecated:

use webreferences2 instead
WS_USER: String = "user"

WS-Security user name.

Deprecated:

use webreferences2 instead
WS_USERNAME_TOKEN: String = "UsernameToken"

WS-Security action: add a UsernameToken identification.

Deprecated:

use webreferences2 instead
SOAPUtil()

static getHTTPRequestHeader(svc: Object, key: String): String

Returns an HTTP request header property value using the specified key. Null is returned if the key does not represent an HTTP header property.

Parameters:

  • svc - a service stub returned from getService().
  • key - the header property key.

Returns:

  • an HTTP request header property value using the specified key or null.

Deprecated:

use webreferences2 instead
static getHTTPResponseHeader(svc: Object, key: String): String

Returns an HTTP response header property value using the specified key. Null is returned if the key does not represent an HTTP response header property.

Parameters:

  • svc - a service stub returned from getService().
  • key - the header property key.

Returns:

  • an HTTP response header property value using the specified key or null.

Deprecated:

use webreferences2 instead
static setHTTPRequestHeader(svc: Object, key: String, value: String): void

Sets an HTTP request header property using the specified key and value.

Parameters:

  • svc - a service stub returned from getService().
  • key - the header property key.
  • value - the header property value. If the value is null, the property identified by the key is removed from the HTTP request header.

Deprecated:

use webreferences2 instead
static setHeader(svc: Object, xml: String): void

Sets a new SOAPHeaderElement in the SOAP request with the namespace of the XML content.

Parameters:

  • svc - a service stub returned from getService()
  • xml - a string with arbitrary XML content

Deprecated:

use webreferences2 instead
static setHeader(svc: Object, xml: String, mustUnderstand: Boolean): void

Sets a new SOAPHeaderElement in the SOAP request with the namespace of the XML content.

Parameters:

  • svc - a service stub returned from getService()
  • xml - a string with arbitrary XML content
  • mustUnderstand - sets the SOAP header attribute 'mustUnderstand'

Deprecated:

use webreferences2 instead
static setHeader(svc: Object, namespace: String, name: String, xml: Object): void

Creates a new SOAPHeaderElement with the name and namespace and places the given XML into it.

Parameters:

  • svc - a service stub returned from getService()
  • namespace - the namespace of the header element
  • name - the element name for the header element
  • xml - a E4X XML object

Deprecated:

use webreferences2 instead
static setHeader(svc: Object, namespace: String, name: String, xml: Object, mustUnderstand: Boolean): void

Creates a new SOAPHeaderElement with the name and namespace and places the given XML into it.

Parameters:

  • svc - a service stub returned from getService()
  • namespace - the namespace of the header element
  • name - the element name for the header element
  • xml - a E4X XML object
  • mustUnderstand - sets the SOAP header attribute mustUnderstand

Deprecated:

use webreferences2 instead
static setHeader(svc: Object, namespace: String, name: String, xml: Object, mustUnderstand: Boolean, actor: String): void

Creates a new SOAPHeaderElement with the name and namespace and places the given XML into it.

Parameters:

  • svc - a service stub returned from getService()
  • namespace - the namespace of the header element
  • name - the element name for the header element
  • xml - a E4X XML object
  • mustUnderstand - sets the SOAP header attribute 'mustUnderstand'
  • actor - the SOAP actor, which should be set for this header element. null removes any actor.

Deprecated:

use webreferences2 instead
static setHeader(svc: Object, namespace: String, name: String, xml: String): void

Creates a new SOAPHeaderElement with the name and namespace and places the given XML into it.

Parameters:

  • svc - a service stub returned from getService()
  • namespace - the namespace of the header element
  • name - the element name for the header element
  • xml - a string with arbitrary XML content

Deprecated:

use webreferences2 instead
static setHeader(svc: Object, namespace: String, name: String, xml: String, mustUnderstand: Boolean): void

Creates a new SOAPHeaderElement with the name and namespace and places the given XML into it.

Parameters:

  • svc - a service stub returned from getService()
  • namespace - the namespace of the header element
  • name - the element name for the header element
  • xml - a string with arbitrary XML content
  • mustUnderstand - sets the SOAP header attribute mustUnderstand

Deprecated:

use webreferences2 instead
static setHeader(svc: Object, namespace: String, name: String, xml: String, mustUnderstand: Boolean, actor: String): void

Creates a new SOAPHeaderElement with the name and namespace and places the given XML into it.

Parameters:

  • svc - a service stub returned from getService()
  • namespace - the namespace of the header element
  • name - the element name for the header element
  • xml - a string with arbitrary XML content
  • mustUnderstand - sets the SOAP header attribute mustUnderstand
  • actor - the SOAP actor, which should be set for this header element. null removes any actor.

Deprecated:

use webreferences2 instead
static setWSSecurityConfig(svc: Object, requestConfigMap: Object, responseConfigMap: Object): void

Sets the WS-Security configuration for the request and response based on the constants defined.

Parameters:

  • svc - a service stub returned from getService()
  • requestConfigMap - the WS-Security request config
  • responseConfigMap - the WS-Security response config

Deprecated:

use webreferences2 instead