Skip to main content


class %XML.Security.EncryptedType extends %SOAP.Security.Element

XML Encryption 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."

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.


property Algorithm as %xsd.anyURI (XMLPROJECTION = "none");
Encryption algorithm to use. The default is $$$SOAPWSaes128cbc. Possible values are $$$SOAPWSaes128cbc, $$$SOAPWSaes192cbc, $$$SOAPWSaes256cbc and $$$SOAPWSaes256gcm.
Property methods: AlgorithmDisplayToLogical(), AlgorithmGet(), AlgorithmIsValid(), AlgorithmLogicalToDisplay(), AlgorithmLogicalToOdbc(), AlgorithmNormalize(), AlgorithmSet()
property Encoding as %xsd.anyURI (XMLPROJECTION = "attribute");
Property methods: EncodingDisplayToLogical(), EncodingGet(), EncodingIsValid(), EncodingLogicalToDisplay(), EncodingLogicalToOdbc(), EncodingNormalize(), EncodingSet()
property EncryptionMethod as %XML.Security.EncryptionMethod;
Property methods: EncryptionMethodGet(), EncryptionMethodGetSwizzled(), EncryptionMethodIsValid(), EncryptionMethodNewObject(), EncryptionMethodSet()
property Id as %String);
Property methods: IdDisplayToLogical(), IdGet(), IdIsValid(), IdLogicalToDisplay(), IdLogicalToOdbc(), IdNormalize(), IdSet()
property KeyInfo as %XML.Security.KeyInfo (REFNAMESPACE = "", XMLREF = 1);
Property methods: KeyInfoGet(), KeyInfoGetSwizzled(), KeyInfoIsValid(), KeyInfoNewObject(), KeyInfoSet()
property KeySize as %Integer (XMLPROJECTION = "none");
Size of key. This property overrides key size that implied by Algorithm.
Property methods: KeySizeDisplayToLogical(), KeySizeGet(), KeySizeIsValid(), KeySizeLogicalToDisplay(), KeySizeNormalize(), KeySizeSet(), KeySizeXSDToLogical()
property MimeType as %String);
Property methods: MimeTypeDisplayToLogical(), MimeTypeGet(), MimeTypeIsValid(), MimeTypeLogicalToDisplay(), MimeTypeLogicalToOdbc(), MimeTypeNormalize(), MimeTypeSet()
property RequireBestEntropy as %Boolean (XMLPROJECTION = "none") [ InitialExpression = 0 ];
RequireBestEntropy - Require best entropy source for initialization of key generation. If this parameter equals 1, the function will return an error unless the generator's internal state has been seeded using the best source of true entropy (OS dependent).
Property methods: RequireBestEntropyDisplayToLogical(), RequireBestEntropyGet(), RequireBestEntropyIsValid(), RequireBestEntropyLogicalToDisplay(), RequireBestEntropyLogicalToXSD(), RequireBestEntropyNormalize(), RequireBestEntropySet(), RequireBestEntropyXSDToLogical()
property Type as %xsd.anyURI (XMLPROJECTION = "attribute");
Property methods: TypeDisplayToLogical(), TypeGet(), TypeIsValid(), TypeLogicalToDisplay(), TypeLogicalToOdbc(), TypeNormalize(), TypeSet()


method SetEncryptionMethod(algorithm As %String)
Set the key transport algorithm to be used to encrypt the symmetric key. The algorithm is reflected in the Algorithm attribute of the EncryptionMethod element of EncryptedKey. Possible values for algortihm are $$$SOAPWSrsaoaep and $$$SOAPWSrsa15

Inherited Members

Inherited Methods


FeedbackOpens in a new tab