Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / %SYS namespace / %SOAP.WSSC.SecurityContextToken
Private  Storage   

%SOAP.WSSC.SecurityContextToken


class %SOAP.WSSC.SecurityContextToken extends
%SOAP.WST.AbstractToken, %SOAP.Security.Element

SecurityContextToken from WS-SecureConversation 1.3.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
4 7 15


Summary


Properties
AppliesTo ExpiresInSeconds Id Identifier
Instance Key MustNotSendCancel OriginalElement
WasEncrypted any

Methods
%%OIDGet %AddToSaveSet %BindExport %BuildObjectGraph
%ClassIsLatestVersion %ClassName %Close %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IncrementCount %IsA %IsModified
%New %NormalizeObject %ObjectModified %OnNew
%OriginalNamespace %PackageName %RemoveFromSaveSet %SerializeObject
%SetModified %ValidateObject %XMLGenerate Copy
Create Equals GetId InitializeForService
InitializeKey Load Log MakeFault
Open Perform Remove RemoveAll
Reset Save ValidateElement ValidateKey
XMLAfterExport XMLBeforeExport XMLDTD XMLExport
XMLExportInternal XMLExportToStream XMLExportToString XMLGetSchemaImports
XMLImport XMLImportInternal XMLIsObjectEmpty XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType


Parameters


• parameter ELEMENTQUALIFIED = 1;
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 = "http://docs.oasis-open.org/ws-sx/ws-secureconversation/200512";
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.
• parameter XMLPREFIX = "wsc";
The XMLPREFIX parameter controls the prefix to be used for the XML namespace that is given by the NAMESPACE parameter.

Properties


• property AppliesTo as %xsd.anyURI(XMLPROJECTION="none");
The endpoint of the web service to which this token applies
• property ExpiresInSeconds as %Integer(XMLPROJECTION="none");
The expiration in seconds since December 31, 1840
• property Identifier as %xsd.anyURI;
• property Instance as %String(MAXLEN="");
• property Key as %Binary(XMLPROJECTION="none");
The symmetric key to be used.
• property MustNotSendCancel as %Boolean(XMLPROJECTION="none") [ InitialExpression = 0 ];
If MustNotSendCancel is true, then token may nopt be cancelled.
• property any as %XML.ElementExtension(XMLPROJECTION="group");

Methods


• method %OnNew(initvalue As %String = "") as %Status
This callback method is invoked by the %New method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

• method Copy(sct As %SOAP.WSSC.SecurityContextToken)
Copy the specified token to this token
• classmethod Create() as %SOAP.WSSC.SecurityContextToken
Create a SecurityContextToken with Identifier set
• method Equals(credentials As %SOAP.WSSC.SecurityContextToken) as %Boolean
Return true if the same Key.
• method InitializeKey(service As %SOAP.WebBase, algorithm As %String) as %Status
Initialize the SecurityContextToken key.
• method Load(keepId As %Boolean = 1) as %Boolean
Retrieve the SecurityContextToken properties for token with this identifier for system wide global. See Save method description for details.
• classmethod Log(terminal As %Boolean = 0)
Log list of SecurityContextTokens
• classmethod MakeFault(faultCode As %String) as %SOAP.Fault
Create a WS-SecureConversation security fault.
• classmethod Open(identifier As %xsd.anyURI, instance As %String = "") as %SOAP.WSSC.SecurityContextToken
Retrieve the SecurityContextToken with this identifier for system wide global. See Save method description for details.
• method Remove()
Remove this token from context list
• classmethod RemoveAll()
Remove all security contexts
• method Reset()
Reset the element.
• method Save() as %Status
Save this SecurityContextToken in a system wide global. The global format is: ^SYS("SOAPContext",Identifier,Instance)=$lb(type,ExpiresInSeconds,Key,AppliesTo,any,wsuId as $list,MustNotSendCancel) The index for cleanup is ^SYS("SOAPContext",0,ExpiresInSeconds,Identifier,Instance)="" where Instance is $c(0) if no Instance and type is always = 1 for SecurityContextToken.
• method ValidateElement(document As %XML.Document, service As %SOAP.WebBase) as %String
Validate the security header element. If invalid return an error code.
• method ValidateKey(service As %SOAP.WebBase) as %String
Validate the SecurityContextToken key. If invalid return an error code.