Skip to main content

%SOAP.Addressing.Properties

Class %SOAP.Addressing.Properties Extends %RegisteredObject [ System = 4 ]

%SOAP.Addressing.Properties represents the message properties for WS-Addressing

Properties​

Destination​

Property Destination As %String(MAXLEN = "");

An absolute URI representing the address of the intended receiver of this message.

SourceEndpoint​

Property SourceEndpoint As %SOAP.Addressing.EndpointReference;

Reference to the endpoint from which the message originated.

ReplyEndpoint​

Property ReplyEndpoint As %SOAP.Addressing.EndpointReference;

An endpoint reference for the intended receiver for replies to this message.

FaultEndpoint​

Property FaultEndpoint As %SOAP.Addressing.EndpointReference;

An endpoint reference for the intended receiver for faults related to this message.

Action​

Property Action As %String(MAXLEN = "");

An absolute IRI that uniquely identifies the semantics implied by this message. Should be SoapAction for SOAP 1.1.

MessageId​

Property MessageId As %String(MAXLEN = "");

An absolute IRI that uniquely identifies the message.

Relationship​

Property Relationship As %SOAP.Addressing.RelatesTo;

A pair of values that indicate how this message relates to another message.

ReferenceParameters​

Property ReferenceParameters As %XML.String(MAXLEN = "");

Corresponds to the value of the [reference parameters] property of the endpoint reference to which the message is addressed.

mustUnderstand​

Property mustUnderstand As %Boolean [ MultiDimensional ];

mustUnderstand is a multidimensional property which specifies the mustUnderstand attribute for each of the headers that are created based on the %XML.AddresingProperties class.
mustUnderstand(headerName) may be set to the %Boolean value of the mustUnderstand attribute to be produced for headerName.
where headerName is "To", "From", "ReplyTo", "FaultTo", "Action", "MessageID", "RelatesTo".

WSANamespace​

Property WSANamespace As %String [ Internal ];

The actual namespace used for an imported WS-Addressing header. Multiple namespaces are possible, since there exist multiple implementations of WS-Addressing based on various submissions.

Ids​

Property Ids As %String [ Internal, MultiDimensional ];

An array of wsu:Id values for the defined WS-Addressing headers.

Methods​

Namespace​

Method Namespace() As %String [ CodeMode = expression ]

Get the WS-Addressing XML namespace. Use the namespace of the imported headers if possible, otherwise use the newest specification.

IsWSANamespace​

ClassMethod IsWSANamespace(namespace As %String) As %Boolean

Return true if the specified namespace is a supported WS-Addressing namespace.

GetDefaultRequestProperties​

ClassMethod GetDefaultRequestProperties(destination As %String, action As %String, addressingNamespace As %String) As %SOAP.Addressing.Properties

Get the default Properties for a SOAP request.

GetDefaultResponseProperties​

ClassMethod GetDefaultResponseProperties(requestProperties As %SOAP.Addressing.Properties, action As %String) As %SOAP.Addressing.Properties

Get the default Properties for a SOAP response.

GetUniqueMessageId​

ClassMethod GetUniqueMessageId() As %String [ CodeMode = expression ]

Get a unique InterSystems format message id.

GetId​

Method GetId(type As %String) As %String

Get a unique wsu:Id value.

GetIds​

Method GetIds(ByRef addressingIds) [ Internal ]

Define Id's for the defined WS-Addressing headers

WriteSOAPHeaders​

Method WriteSOAPHeaders(namespaces As %XML.Namespaces, soapPrefix As %String, soapVersion As %String) As %Status [ Internal ]

Output the SOAP headers that correspond to these properties.

ImportHeader​

Method ImportHeader(headerName As %String, handler, message As %Integer, status As %Status) As %Boolean [ Internal ]

Import a WS-Addressing SOAP header

ImportAddressingHeaders​

ClassMethod ImportAddressingHeaders(document As %XML.Document, headers As %String, baseChildlist As %String, Output addressing As %SOAP.Addressing.Properties) As %Status [ Internal ]