Skip to main content


class %XML.Security.KeyInfo extends %Library.RegisteredObject, %XML.Adaptor

XML Signature element. This class is used internally by InterSystems IRIS. You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class.

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.


classmethod CreateBinarySecret(binarySecret As %SOAP.WST.BinarySecret, Output status As %Status) as %XML.Security.KeyInfo
Create a KeyInfo containing the specified EncryptedKey.
classmethod CreateEncryptedKey(encryptedKey As %XML.Security.EncryptedKey, Output status As %Status) as %XML.Security.KeyInfo
Create a KeyInfo containing the specified EncryptedKey.
classmethod CreateX509(ByRef credentials As %SYS.X509Credentials, referenceOption As %Integer, Output status As %Status) as %XML.Security.KeyInfo
Create a KeyInfo associated with the specified X509 certificate.
- The certificate is specified in the token argument by a %SYS.X509Credentials instance containing the certificate, a BinarySecurityToken containing the X509 certificate or a SAML Assertion whose SubjectConfirmation is based on X.509 credentials. A binary security token must be used for a direct reference.
- The referenceOption argument specifies the type of reference to create. See definitions of $$$SOAPWSReference.... and $$$KeyInfoX509.... The default is to use a direct reference if the first argument is a binary security token or to use the Thumbprint if the first argument is a %SYS.X509Credentials instance.
- If no KeyInfo is returned the status argument is set to the error %Status.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab