Inheritance diagram for EncryptedKey:

[legend]

Collaboration diagram for EncryptedKey:

[legend]

Public Member Functions
	AddReference (_.XML.Security.DataReference reference, _.Library.Boolean doNotReuse)
	Add a reference to XML element using a XML.Security.DataReference. More...

_.Library.Boolean	Equals (_.XML.Security.EncryptedKey credentials)
	Return true if the same Key.

_.Library.Binary	GetEncryptedKeySHA1 ()
	Get EncryptedKeySHA1 format of this EncryptedKey element. More...

_.Library.Status	Initialize ()
	Initialize an EncryptedKey element that is intended for creating EncryptedKey. More...

	Reset ()
	Reset the element.

Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...

_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...

_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...

_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...

_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Public Member Functions inherited from Adaptor
_.Library.Status	XMLExport (_.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent, _.Library.Boolean local, _.Net.MIMEPart mimeAttachments)
	Serialize an XML enabled class as an XML document and write. More...

_.Library.Status	XMLExportToStream (_.Stream.Object export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and appends it to a stream. More...

_.Library.Status	XMLExportToString (_.Library.String export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and write it to a string. More...

Public Member Functions inherited from EncryptedType
	SetEncryptionMethod (_.Library.String algorithm)
	Set the key transport algorithm to be used to encrypt the symmetric key. More...

Static Public Member Functions
_.XML.Security.EncryptedKey	CreateX509 (_.SYS.X509Credentials credentials, _.Library.Integer encryptionOptions, _.Library.Integer referenceOption, _.Library.Status status)
	Create an EncryptedKey element that is to carry a symmetric key which is encrypted using. More...

Static Public Member Functions inherited from Adaptor
_.Library.Status	XMLDTD (_.Library.String top, _.Library.String format, _.Library.Boolean input, dtdlist)
	Write the DTD to the current device for this XML enabled class serialized as. More...

_.Library.RegisteredObject	XMLNew (_.XML.Document document, _.Library.Integer node, _.Library.RegisteredObject containerOref)
	Get an instance of an XML enabled class. More...

_.Library.Status	XMLSchema (_.Library.String top, _.Library.String format, _.Library.String namespacePrefix, _.Library.Boolean input, _.Library.Boolean refOnly, schema)
	Write an XML Schema fragment to the current device which describes an XML enabled class and dependent classes. More...

_.Library.String	XMLSchemaNamespace ()
	Get the namespace to which this class belongs for use in schema generation. More...

_.Library.Status	XMLSchemaType (_.XML.Schema schemaInstance, _.XML.Node node, _.Library.String top, _.Library.Boolean encoded, _.Library.Boolean summary, _.Library.Boolean input, _.Library.Boolean refOnly)
	Add a complexType to the schema that is respresented by an <class>XML.Schema</class> instance. More...

Public Attributes
	CarriedKeyName
	More...

	CipherData
	More...

	EncryptionOptions
	EncryptionOptions specifies which parts of the message are to be signed. More...

	EncryptionProperties
	More...

	Recipient
	More...

	ReferenceList
	More...

	UsedAsEncryptionKey
	UsedAsEncryptionKey is true if this EncryptedKey element was used for encryption. More...

	UsedAsSigningKey
	UsedAsSigningKey is true if this EncryptedKey element was used for signing. More...

Public Attributes inherited from EncryptedType
	Algorithm
	Encryption algorithm to use. More...

	Encoding
	More...

	EncryptionMethod
	More...

	Id
	More...

	KeyInfo
	More...

	KeySize
	Size of key. More...

	MimeType
	More...

	RequireBestEntropy
	RequireBestEntropy - Require best entropy source for initialization. More...

	Type
	More...

Additional Inherited Members
Static Public Attributes inherited from KeyInfoClause
	ELEMENTQUALIFIED = None
	Abstract base class for KeyInfo clauses. More...

Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...

	JAVATYPE = None
	The Java type to be used when exported.

	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Static Public Attributes inherited from Adaptor
	ATTRIBUTEQUALIFIED = None
	ATTRIBUTEQUALIFIED controls the format of exported XML by controlling whether attributes. More...

	ELEMENTQUALIFIED = None
	ELEMENTQUALIFIED controls the format of exported XML. More...

	NAMESPACE = None
	NAMESPACE specifies the XML namespace to be used when projecting the. More...

	SUPPRESSTYPEPREFIX = None
	SUPPRESSTYPEPREFIX allows the type name that refers to this class. More...

	XMLDEFAULTREFERENCE = None
	XMLDEFAULTREFERENCE specifies the default value of the XMLREFERENCE property parameter. More...

	XMLENABLED = None
	If this parameter is true then XML-enabling methods. More...

	XMLFORMAT = None
	The XMLFORMAT parameter controls the generation of the XMLExport and XMLImport. More...

	XMLIGNOREINVALIDATTRIBUTE = None
	The XMLIGNOREINVALIDATTRIBUTE parameter allows the programmer to control handling of unexpected. More...

	XMLIGNOREINVALIDTAG = None
	The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected. More...

	XMLIGNORENULL = None
	XMLIGNORENULL allows the programmer to override the default XML handling. More...

	XMLINCLUDEINGROUP = None
	XMLINCLUDEINGROUP allows the programmer to control whether a class is included. More...

	XMLINHERITANCE = None
	If the XMLINHERITANCE parameter is set to "LEFT", then in the case of multiple. More...

	XMLNAME = None
	This parameter provides the default XMLNAME for the class. More...

	XMLNIL = None
	The XMLNIL class parameter controls the use of xsi:nil by XMLExport. More...

	XMLNILNOOBJECT = None
	The XMLNILNOOBJECT parameter allows creation of an object to be skipped for elements. More...

	XMLPREFIX = None
	The XMLPREFIX parameter controls the prefix to be used for the XML namespace that. More...

	XMLSEQUENCE = None
	If the XMLSEQUENCE = 1, then the order of the XML elements must match the. More...

	XMLSUMMARY = None
	The summary fields to be used when an object is referenced are specified. More...

	XMLTYPE = None
	This parameter provides the default XMLTYPE for the class. More...

	XMLUNSWIZZLE = None
	If the XMLUNSWIZZLE parameter is set to 1, then single object. More...

	XMLUSEEMPTYELEMENT = None
	If the XMLUSEEMPTYELEMENT parameter is set to 1, then the empty element shorthand (<tag>) More...

Detailed Description

For details on using this class, see Encrypting XML Documents. and Encrypting SOAP Security Headers.

XML Encryption element.

Member Function Documentation

◆ AddReference()

AddReference	(	_.XML.Security.DataReference	reference,
		_.Library.Boolean	doNotReuse
	)

Add a reference to XML element using a XML.Security.DataReference.

The reference may be created by using the ##class(XML.Security.Reference).Create method. If doNotReuse is true, then this reference will be removed during Reset

◆ CreateX509()

_.XML.Security.EncryptedKey CreateX509	(	_.SYS.X509Credentials	credentials,
		_.Library.Integer	encryptionOptions,
		_.Library.Integer	referenceOption,
		_.Library.Status	status
	)

static

Create an EncryptedKey element that is to carry a symmetric key which is encrypted using.

an X.509 certificate's public key.

The certificate is specified in the token argument by a SYS.X509Credentials instance containing the certificate or a BinarySecurityToken containing the X509 certificate.
The encryptionOptions argument specifies the parts of the SOAP message to be encrypted. The default is to encrypt the body - $$$SOAPWSEncryptSoapBody. $$$SOAPWSEncryptNoBody means body will not be encrypted, but other parts added using AddReference method. $$$SOAPWSEncryptNone means there will be no ReferenceList in the EncryptedKey element. See soap.inc definitions of $$$SOAPWSEncrypt.... for possibilities.
The referenceOption argument specifies the type of reference to create. See soap.inc definitions of $$$SOAPWSReference.... The default is to use the Thumbprint if the first argument is a SYS.X509Credentials instance.

◆ GetEncryptedKeySHA1()

_.Library.Binary GetEncryptedKeySHA1 ( )

Get EncryptedKeySHA1 format of this EncryptedKey element.

◆ Initialize()

_.Library.Status Initialize ( )

Initialize an EncryptedKey element that is intended for creating EncryptedKey.

elements which will not be in the Security header. EncryptionMethod, and Algorithm or KeySize are expected to be set or defaulted.

Member Data Documentation

◆ CarriedKeyName

CarriedKeyName

◆ CipherData

CipherData

◆ EncryptionOptions

EncryptionOptions

EncryptionOptions specifies which parts of the message are to be signed.

See soap.inc definitions of $$$SOAPWSEncrypt.... for possibilities.

◆ EncryptionProperties

EncryptionProperties

◆ Recipient

Recipient

◆ ReferenceList

ReferenceList

◆ UsedAsEncryptionKey

UsedAsEncryptionKey

UsedAsEncryptionKey is true if this EncryptedKey element was used for encryption.

◆ UsedAsSigningKey

UsedAsSigningKey

UsedAsSigningKey is true if this EncryptedKey element was used for signing.

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members