Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%SOAP] >  [WST] >  [BinarySecret]
Private  Storage   

class %SOAP.WST.BinarySecret extends %XML.Security.KeyInfoClause

BinarySecretType type from WS-Trust 1.3.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
4 4 8


Summary

Properties
Key KeySize Type value

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
Create Equals Initialize XMLDTD
XMLExport XMLExportToStream XMLExportToString 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-trust/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 = "wst";
The XMLPREFIX parameter controls the prefix to be used for the XML namespace that is given by the NAMESPACE parameter.

Properties

• property Key as %xsd.base64Binary(XMLPROJECTION="none") [ Calculated ];
Alias for the BinarySecret value when being used as a key
• property KeySize as %Integer(XMLPROJECTION="none");
Size of key. This property overrides key size that implied by Algorithm.
• property Type as %xsd.anyURI(XMLPROJECTION="attribute");
• property value as %xsd.base64Binary(XMLPROJECTION="content");

Methods

• classmethod Create(type As %xsd.anyURI = "", size As %Integer = "") as %SOAP.WST.BinarySecret
Create a BinarySecret element of specified type and size. Default type is $$$SOAPWSTNonce and default size is $$$SOAPWSSCDEFAULTKEYSIZE.
• method Equals(credentials As %SOAP.WST.BinarySecret) as %Boolean
Return true if the same Key.
• method Initialize() as %Status
Initialize an BinarySecret element that is intended for elements which will not be in the Security header. Type and KeySize are expected to be set or defaulted.


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.