Skip to main content

%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 Caché. 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

Parameters

parameter NAMESPACE = http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd;
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.

Properties

property Length as %xsd.unsignedLong (REFNAMESPACE = "http://docs.oasis-open.org/ws-sx/ws-secureconversation/200512", XMLPROJECTION = "attribute", XMLREF = 1);
Property methods: LengthDisplayToLogical(), LengthGet(), LengthIsValid(), LengthLogicalToDisplay(), LengthNormalize(), LengthSet(), LengthXSDToLogical()
property Nonce as %xsd.base64Binary (REFNAMESPACE = "http://docs.oasis-open.org/ws-sx/ws-secureconversation/200512", XMLPROJECTION = "attribute", XMLREF = 1);
Property methods: NonceGet(), NonceIsValid(), NonceLogicalToXSD(), NonceSet(), NonceXSDToLogical()
property Reference as list of %RegisteredObject (XMLCHOICELIST = "%SOAP.Security.Reference,%SOAP.Security.KeyIdentifier,%XML.Security.X509Data", XMLPROJECTION = "element", XMLREF = 1, XMLTYPECONSTRAINT = "choice");
Property methods: ReferenceBuildValueArray(), ReferenceCollectionToDisplay(), ReferenceCollectionToOdbc(), ReferenceDisplayToCollection(), ReferenceGet(), ReferenceGetObject(), ReferenceGetObjectId(), ReferenceGetSwizzled(), ReferenceIsValid(), ReferenceOdbcToCollection(), ReferenceSet(), ReferenceSetObject(), ReferenceSetObjectId()
property TokenType as %String);
Property methods: TokenTypeDisplayToLogical(), TokenTypeGet(), TokenTypeIsValid(), TokenTypeLogicalToDisplay(), TokenTypeLogicalToOdbc(), TokenTypeNormalize(), TokenTypeSet()
property Usage as %String);
Property methods: UsageDisplayToLogical(), UsageGet(), UsageIsValid(), UsageLogicalToDisplay(), UsageLogicalToOdbc(), UsageNormalize(), UsageSet()

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
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.

Inherited Members

Inherited Methods

Subclasses

FeedbackOpens in a new tab