Skip to main content

%SOAP.Header

Class %SOAP.Header Extends (%RegisteredObject, %XML.Adaptor) [ Inheritance = right, System = 3 ]

Super class for all SOAP headers

Parameters​

OUTPUTTYPEATTRIBUTE​

Parameter OUTPUTTYPEATTRIBUTE As BOOLEAN;

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.

SOAPENABLEREWRITE​

Parameter SOAPENABLEREWRITE As BOOLEAN [ Internal ] = 0;

If true rewrite processing enabled for this header. Rewrite may only be enabled when writing SOAP headers to internal buffer

Properties​

Fault​

Property Fault As %SOAP.Fault(XMLPROJECTION = "none");

Fault which is to be returned by web service based on error importing the header.

actor​

Property actor As %String(XMLPROJECTION = "none");

SOAP 1.1 uses actor.

role​

Property role As %String(XMLPROJECTION = "none") [ Calculated ];

SOAP 1.2 uses role instead of actor.

mustUnderstand​

Property mustUnderstand As %Integer(XMLPROJECTION = "none");

%headerId​

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

XmlId​

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.

HeaderBufferIndex​

Property HeaderBufferIndex As %Integer(XMLPROJECTION = "none") [ Internal ];

The internal buffer index for this header

rewriteTag​

Property rewriteTag As %String(XMLPROJECTION = "none") [ Internal, Private ];

tag saved for rewrite

rewriteFmt​

Property rewriteFmt As %String(XMLPROJECTION = "none") [ Internal, Private ];

fmt save for rewrite

rewriteNamespaces​

Property rewriteNamespaces As %XML.Namespaces(XMLPROJECTION = "none") [ Internal, Private ];

namespaces saved for rewrite

rewriteAttrs​

Property rewriteAttrs As %String(XMLPROJECTION = "none") [ Internal, MultiDimensional, Private ];

attrs saved for rewrite

rewriteMimeAttachments​

Property rewriteMimeAttachments As %Net.MIMEPart(XMLPROJECTION = "none") [ Internal, Private ];

mimeAttachments saved for rewrite

Methods​

roleGet​

Method roleGet() As %String [ CodeMode = expression, Internal ]

roleSet​

Method roleSet(val As %String) As %Status [ Internal ]

GetId​

Method GetId() As %String

Return the value of the Id property. Populate the Id property if it is not yet set.

WriteHeader​

Method WriteHeader(tag As %String, format As %String, typeNamespace As %String, elementQualified As %Boolean, soapPrefix As %String, soapVersion As %String, namespaces As %XML.Namespaces, mimeAttachments As %Net.MIMEPart = "") As %Status [ Internal ]

Output a SOAP header This method is for internal use only. You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this method."

RewriteHeader​

Method RewriteHeader() As %Status [ Internal ]

Internal only method to rewrite a header

ImportHeader​

Method ImportHeader(headerName As %String, format As %String, ByRef handler As %XML.Document, message As %Integer, status As %Status, mimeAttachments As %Net.MIMEPart = "") As %Boolean [ Internal ]

Import a SOAP header This method is for internal use only. You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this method."