Skip to main content


class %SOAP.WST.Entropy extends %Library.RegisteredObject, %XML.Adaptor

EntropyType type from WS-Trust 1.3. Either BinarySecret or EncryptedKey may be specified, but not both.

Property Inventory

Method Inventory


Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute.

NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.

parameter NAMESPACE =;
Inherited description: NAMESPACE specifies the XML namespace to be used when projecting the class to XML. If NAMESPACE = "", the default namespace is used for the XML schema is used as the namespace for his class.
parameter XMLFORMAT = literal;
Inherited description: The XMLFORMAT parameter controls the generation of the XMLExport and XMLImport methods for XML enabled classes to include code for only literal or only encoded format. This allows the generated routines to be significantly smaller since usually both formats are not needed.

If XMLFORMAT="Literal", then only support for literal format import and export is generated.

If XMLFORMAT="Encoded", then only support for SOAP encoded format import and export is generated.

The default is to generate support for both literal and encoded format.

parameter XMLPREFIX = wst;
Inherited description: The XMLPREFIX parameter controls the prefix to be used for the XML namespace that is given by the NAMESPACE parameter.


property BinarySecret as %SOAP.WST.BinarySecret (REFNAMESPACE = "", XMLREF = 1);
Property methods: BinarySecretGet(), BinarySecretGetSwizzled(), BinarySecretIsValid(), BinarySecretNewObject(), BinarySecretSet()
property EncryptedKey as %XML.Security.EncryptedKey (REFNAMESPACE = "", XMLREF = 1);
Property methods: EncryptedKeyGet(), EncryptedKeyGetSwizzled(), EncryptedKeyIsValid(), EncryptedKeyNewObject(), EncryptedKeySet()


classmethod CreateBinarySecret(keysize As %Integer, type As %String) as %SOAP.WST.Entropy
Create Entropy element with BinarySecret. keysize is the size of the random entropy in bytes. Default keysize is $$$SOAPWSSCDEFAULTKEYSIZE.
classmethod CreateX509EncryptedKey(keysize As %Integer, credentials As %SYS.X509Credentials = "", referenceOption As %Integer = "", Output status As %Status) as %SOAP.WST.Entropy
Create Entropy element with an EncryptedKey element containing a binary secret. keysize is the size of the random entropy in bytes. Default keysize is $$$SOAPWSSCDEFAULTKEYSIZE.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab