Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / %SAML.Subject
Private  Storage   

%SAML.Subject


class %SAML.Subject extends
%RegisteredObject, %XML.Adaptor

A SAML Subject

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 2 4


Summary


Properties
NameID SubjectConfirmation

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
AddBinarySecretConfirmation AddConfirmation AddEncryptedKeyConfirmation AddX509Confirmation
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType


Parameters


• parameter ELEMENTQUALIFIED = 0;
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 = "urn:oasis:names:tc:SAML:2.0:assertion";
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";
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.

Properties


• property NameID as %SAML.BaseID(XMLREF=1,XMLTYPECONSTRAINT="choice");
• property SubjectConfirmation as list of %SAML.SubjectConfirmation(XMLPROJECTION="element",XMLREF=1);

Methods


• method AddBinarySecretConfirmation(binarySecret As %SOAP.WST.BinarySecret) as %Status
Create SubjectConfirmation and associated KeyInfo for holder-of-key SubjectConfirmation based on BinarySecret. The NameID field must still be set for the Subject.
• method AddConfirmation(method As %String) as %Status
Create SubjectConfirmation with specified SubjectConfirmation method. The method argument should be $$$SAMLSenderVouches, $$$SAMLHolderOfKey or $$$SAMLBearer. The NameID field must still be set for the Subject.
• method AddEncryptedKeyConfirmation(encryptedKey As %XML.Security.EncryptedKey) as %Status
Create SubjectConfirmation and associated KeyInfo for holder-of-key SubjectConfirmation based on EncryptedKey. The NameID field must still be set for the Subject.
• method AddX509Confirmation(credentials As %SYS.X509Credentials, referenceOption As %Integer) as %Status
Create SubjectConfirmation and associated KeyInfo for holder-of-key SubjectConfirmation based X.509 credentials. The NameID field must still be set for the Subject.