Skip to main content


class %SOAP.Addressing.Properties extends %Library.RegisteredObject

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

Property Inventory

Method Inventory


property Action as %String);
An absolute IRI that uniquely identifies the semantics implied by this message. Should be SoapAction for SOAP 1.1.
Property methods: ActionDisplayToLogical(), ActionGet(), ActionIsValid(), ActionLogicalToDisplay(), ActionLogicalToOdbc(), ActionNormalize(), ActionSet()
property Destination as %String);
An absolute URI representing the address of the intended receiver of this message.
Property methods: DestinationDisplayToLogical(), DestinationGet(), DestinationIsValid(), DestinationLogicalToDisplay(), DestinationLogicalToOdbc(), DestinationNormalize(), DestinationSet()
property FaultEndpoint as %SOAP.Addressing.EndpointReference;
An endpoint reference for the intended receiver for faults related to this message.
Property methods: FaultEndpointGet(), FaultEndpointGetSwizzled(), FaultEndpointIsValid(), FaultEndpointNewObject(), FaultEndpointSet()
property MessageId as %String);
An absolute IRI that uniquely identifies the message.
Property methods: MessageIdDisplayToLogical(), MessageIdGet(), MessageIdIsValid(), MessageIdLogicalToDisplay(), MessageIdLogicalToOdbc(), MessageIdNormalize(), MessageIdSet()
property ReferenceParameters as %XML.String);
Corresponds to the value of the [reference parameters] property of the endpoint reference to which the message is addressed.
Property methods: ReferenceParametersDisplayToLogical(), ReferenceParametersGet(), ReferenceParametersIsValid(), ReferenceParametersLogicalToDisplay(), ReferenceParametersLogicalToOdbc(), ReferenceParametersNormalize(), ReferenceParametersSet()
property Relationship as %SOAP.Addressing.RelatesTo;
A pair of values that indicate how this message relates to another message.
Property methods: RelationshipGet(), RelationshipGetSwizzled(), RelationshipIsValid(), RelationshipNewObject(), RelationshipSet()
property ReplyEndpoint as %SOAP.Addressing.EndpointReference;
An endpoint reference for the intended receiver for replies to this message.
Property methods: ReplyEndpointGet(), ReplyEndpointGetSwizzled(), ReplyEndpointIsValid(), ReplyEndpointNewObject(), ReplyEndpointSet()
property SourceEndpoint as %SOAP.Addressing.EndpointReference;
Reference to the endpoint from which the message originated.
Property methods: SourceEndpointGet(), SourceEndpointGetSwizzled(), SourceEndpointIsValid(), SourceEndpointNewObject(), SourceEndpointSet()
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".
Property methods: mustUnderstandDisplayToLogical(), mustUnderstandGet(), mustUnderstandIsValid(), mustUnderstandLogicalToDisplay(), mustUnderstandNormalize(), mustUnderstandSet()


classmethod GetDefaultRequestProperties(destination As %String, action As %String, addressingNamespace As %String) as %SOAP.Addressing.Properties
Get the default Properties for a SOAP request.
classmethod GetDefaultResponseProperties(requestProperties As %SOAP.Addressing.Properties, action As %String) as %SOAP.Addressing.Properties
Get the default Properties for a SOAP response.
method GetId(type As %String) as %String
Get a unique wsu:Id value.
classmethod GetUniqueMessageId() as %String
Get a unique InterSystems format message id.
classmethod IsWSANamespace(namespace As %String) as %Boolean
Return true if the specified namespace is a supported WS-Addressing namespace.
method Namespace() as %String
Get the WS-Addressing XML namespace. Use the namespace of the imported headers if possible, otherwise use the newest specification.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab