Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / %SOAP.Security.SecurityTokenReference
Private  Storage   

%SOAP.Security.SecurityTokenReference


class %SOAP.Security.SecurityTokenReference extends
%XML.Security.KeyInfoClause, %SOAP.Security.Element

SecurityTokenReference element for SOAP Security header. 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."

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 6 11


Summary


Properties
Id Length Nonce OriginalElement
Reference TokenType Usage WasEncrypted
X509Credentials

Methods
%%OIDGet %AddToSaveSet %BindExport %BuildObjectGraph
%ClassIsLatestVersion %ClassName %Close %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IncrementCount %IsA %IsModified
%New %NormalizeObject %ObjectModified %OriginalNamespace
%PackageName %RemoveFromSaveSet %SerializeObject %SetModified
%ValidateObject %XMLGenerate GetDirectReference GetId
GetKeyIdentifier GetSAMLDirectReference GetSAMLKeyIdentifier GetSCTReference
GetX509Data GetX509DirectReference GetX509KeyIdentifier InitializeForService
InitializeKey Perform Reset SetIdentifier
ValidateElement ValidateTokenRef XMLAfterExport XMLBeforeExport
XMLDTD XMLExport XMLExportInternal XMLExportToStream
XMLExportToString XMLGetSchemaImports XMLImport XMLImportInternal
XMLIsObjectEmpty XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType

Subclasses
%SOAP.Security.wsse200207.SecurityTokenReference %SOAP.Security.wsse200306.SecurityTokenReference

Parameters


• parameter NAMESPACE = "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd";
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 Length as %xsd.unsignedLong(REFNAMESPACE="http://docs.oasis-open.org/ws-sx/ws-secureconversation/200512",XMLPROJECTION="attribute",XMLREF=1);
• property Nonce as %xsd.base64Binary(REFNAMESPACE="http://docs.oasis-open.org/ws-sx/ws-secureconversation/200512",XMLPROJECTION="attribute",XMLREF=1);
• property Reference as list of %RegisteredObject(XMLCHOICELIST="%SOAP.Security.Reference,%SOAP.Security.KeyIdentifier,%XML.Security.X509Data",XMLPROJECTION="element",XMLREF=1,XMLTYPECONSTRAINT="choice");
• property TokenType as %String(MAXLEN="",REFNAMESPACE="http://docs.oasis-open.org/wss/oasis-wss-wssecurity-secext-1.1.xsd",XMLPROJECTION="attribute",XMLREF=1);
• property Usage as %String(MAXLEN="",XMLPROJECTION="attribute");
• property X509Credentials as %RawString(XMLPROJECTION="none");
If token is based on X509 certificate, this is the X509 credentials class.

Methods


• classmethod GetDirectReference(tokenURI As %String, valueType As %String) as %SOAP.Security.SecurityTokenReference
Create a SecurityTokenReference containing a direct reference with no ValueType. This form is used for reference to EncryptedKey.
• classmethod GetKeyIdentifier(valueType As %String, value As %Binary) as %SOAP.Security.SecurityTokenReference
Create a SecurityTokenReference containing a KeyIdentfier based on an encrypted key.
• classmethod GetSAMLDirectReference(tokenURI As %String) as %SOAP.Security.SecurityTokenReference
Create a SecurityTokenReference containing a direct reference to aSAML Assertion.
• classmethod GetSAMLKeyIdentifier(credentials As %SAML.Assertion, type As %String) as %SOAP.Security.SecurityTokenReference
Create a SecurityTokenReference to a SAML token containing a KeyIdentfier
• classmethod GetSCTReference(SCT As %SOAP.WSSC.SecurityContextToken) as %SOAP.Security.SecurityTokenReference
Create a SecurityTokenReference containing a remote reference to a SecurityContextToken
• classmethod GetX509Data(valueType As %String, credentials As %SYS.X509Credentials, Output status As %Status) as %SOAP.Security.SecurityTokenReference
Create a SecurityTokenReference containing an X509Data element If no X509Data element is returned the status argument is set to the error %Status.
• classmethod GetX509DirectReference(tokenURI As %String) as %SOAP.Security.SecurityTokenReference
Create a SecurityTokenReference containing a direct reference to an X.509 BinarySecurityToken
• classmethod GetX509KeyIdentifier(valueType As %String, credentials As %SYS.X509Credentials, Output status As %Status) as %SOAP.Security.SecurityTokenReference
Create a SecurityTokenReference containing a KeyIdentfier If no SecurityTokenReference is returned the status argument is set to the error %Status.
• method SetIdentifier(key As %Binary)
Set the Identifier of %XML.SecurityTokenReference if it is ""
• method ValidateElement(document As %XML.Document, service As %SOAP.WebBase) as %String
Validate the SecurityTokenReference element as a direct child of the Security header element. If invalid return an error code.
• method ValidateTokenRef(service As %SOAP.WebBase, ByRef tokenType As %String, Output credentials As %RawString, topLevel As %Boolean) as %String
Validate this input KeyInfo clause. Default behavior is to ignore the clause. If valid, set credentials and tokenType and return "". credentials is either %SYS.X509Credentials or %Binary If not valid, return error code.