Home > Class Reference > ENSLIB namespace > %SOAP.WST.BinarySecret

%SOAP.WST.BinarySecret

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

BinarySecretType type from WS-Trust 1.3.

Property Inventory

Method Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: 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;
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.
parameter XMLPREFIX = wst;
Inherited description: 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 methods: KeyGet(), KeyIsValid(), KeyLogicalToXSD(), KeySet(), KeySizeDisplayToLogical(), KeySizeGet(), KeySizeIsValid(), KeySizeLogicalToDisplay(), KeySizeNormalize(), KeySizeSet(), KeySizeXSDToLogical(), KeyXSDToLogical()
property KeySize as %Integer (XMLPROJECTION = "none");
Size of key. This property overrides key size that implied by Algorithm.
Property methods: KeySizeDisplayToLogical(), KeySizeGet(), KeySizeIsValid(), KeySizeLogicalToDisplay(), KeySizeNormalize(), KeySizeSet(), KeySizeXSDToLogical()
property Type as %xsd.anyURI (XMLPROJECTION = "attribute");
Property methods: TypeDisplayToLogical(), TypeGet(), TypeIsValid(), TypeLogicalToDisplay(), TypeLogicalToOdbc(), TypeNormalize(), TypeSet()
property value as %xsd.base64Binary (XMLPROJECTION = "content");
Property methods: valueGet(), valueIsValid(), valueLogicalToXSD(), valueSet(), valueXSDToLogical()

Methods

classmethod Create(type As %xsd.anyURI = "", size As %Integer = "") as %SOAP.WST.BinarySecret [ Language = objectscript ]
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 [ Language = objectscript ]
Return true if the same Key.
method Initialize() as %Status [ Language = objectscript ]
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.

Inherited Members

Inherited Methods