Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [%SYS] >  [%SOAP] >  [Header]
Private  Storage   

class %SOAP.Header extends %RegisteredObject, %XML.Adaptor

Super class for all SOAP headers

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 12 6


Summary

Properties
%headerId Fault XmlId actor mustUnderstand
role

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
GetId XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType

Subclasses
%DeepSee.XMLA.BeginSessionHeader %DeepSee.XMLA.EndSessionHeader %SOAP.Addressing.Action
%SOAP.Addressing.EndpointReference %SOAP.Addressing.MessageID %SOAP.Addressing.RelatesTo
%SOAP.Addressing.To %SOAP.IdHeader %SOAP.RM.AckRequested
%SOAP.RM.Sequence %SOAP.RM.SequenceAcknowledgement %SOAP.RM.SequenceFault
%SOAP.RM.UsesSequenceSSL %SOAP.RM.UsesSequenceSTR %SOAP.Security.Header
%SOAP.SessionHeader

Parameters

• parameter OUTPUTTYPEATTRIBUTE;
OUTPUTTYPEATTRIBUTE allows the programmer to force the xsi:type attribute to be included in all elements of a SOAP message which is a web client request or web service response. If specified, this parameter overrides the OUTPUTTYPEATTRIBUTE of the client or service.

Properties

• property %headerId as %String(MAXLEN="",REFNAMESPACE="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd",XMLNAME="Id",XMLPROJECTION="XATTRIBUTE",XMLREF=1);
Header may have a wsu:Id attribute
• property Fault as %SOAP.Fault(XMLPROJECTION="none");
Fault which is to be returned by web service based on error importing the header.
• property XmlId as %String(MAXLEN="",XMLPROJECTION="none");
The xml:id attribute to be added to the header element when writing a SOAP message. Usually wsu:Id will be used, but in certain cases xml:id is needed.
• property actor as %String(XMLPROJECTION="none");
SOAP 1.1 uses actor.
• property mustUnderstand as %Integer(XMLPROJECTION="none");
• property role as %String(XMLPROJECTION="none") [ Calculated ];
SOAP 1.2 uses role instead of actor.

Methods

• method GetId() as %String
Return the value of the Id property. Populate the Id property if it is not yet set.


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