Home > Class Reference > %SYS namespace > %SOAP.Binary


Implementation of binary protocol for transferring SOAP messages between InterSystems IRIS instances.
A SOAP message is sent as the serialized form of a %SOAP.Descriptor subclass including the entire tree of referenced objects. For each class sent a description of the class is sent followed later by one or more instances of the class data.
The physical format of the message is multiple blocks each of which begins with a five (5) ASCII character length followed by $list of the specified length. The logical values that are described below are stored in the $list.
Four possible top level structures are used: class definition, class instance and error.
Header: - must be first structure.
version - $$$soapBinaryVersion
SERVICENAME of web service to be used to table - $$$soapBinaryRaw or $$$soapBinaryUTF8
sessionFlag - 1 if SOAPSESSION is supported. Class Definition:
index - integer index that is usede to reference this definition.
class name. Used for matching to classes.
numProperties - number of property definitions that follow.
Property Definition for each property:
name - name of the property.
category - $$$soapBinaryLiteral, $$$soapBinaryStream, $$$soapBinaryObject with $$$soapBinaryList or $$$soapBinaryArray flags OR'ed if needed.

Class Instance:
$$$soapBinaryClassInstance or $$$soapBinaryTopInstance
$$$soapBinaryTopInstance indicates the object is a top level instance specified in the routinne call.
oref - oref of the instance on the sending system as an integer .
index - index of the class definition
Property Values - number and type determined from class definition.
$$$soapBinaryLiteral - literal value including stream
$$$soapBinaryLitChar - flag to indicate that literal is a character string
$$$soapBinaryLitBin - flag too indicate that literal is a binary string literal string value >16000 is represented as $lb()_$lb(segment)*_$lb()
$$$soapBinaryObject - oref of object followed by
index of class definition or a class definition if no previous for this class.
Optionally a class defintion may proceed the oref. The class definition is Class definition is marked by $lb() instead of $$$soapBinaryClassDefinition.
$$$soapBinaryList - flag to indicate list follows.
numItems - Number of items
items -- numItems
value corrresponding to category
$$$soapBinaryArray - flag to indicate list follows.
numItems - Number of items
items -- numItems
value corrresponding to category
faultcode - from %SOAP.Fault
faultstring - from %SOAP.Fault
faultactor - from %SOAP.Fault
detail - from %SOAP.Fault
To Do: UTF8 if mismatched NLS charset -- Matching class names -- exact name not required. Chunked Http Binary block length %XML.DataSet Support XMLREFERENCE=summary,id,oid,guid

Property Inventory

Method Inventory


property AsUTF8 as %Boolean;
True if strings in the output needs to be converted to UTF-8
Property methods: AsUTF8DisplayToLogical(), AsUTF8Get(), AsUTF8IsValid(), AsUTF8LogicalToDisplay(), AsUTF8Normalize(), AsUTF8Set()
property Chunked as %Boolean;
Set to 1 if chunked output is to be used.
Property methods: ChunkedDisplayToLogical(), ChunkedGet(), ChunkedIsValid(), ChunkedLogicalToDisplay(), ChunkedNormalize(), ChunkedSet()
property IsRequest as %Boolean;
True if this is a SOAP request
Property methods: IsRequestDisplayToLogical(), IsRequestGet(), IsRequestIsValid(), IsRequestLogicalToDisplay(), IsRequestNormalize(), IsRequestSet()
property MessageList as %RegisteredObject [ MultiDimensional ];
List of classes to output
Property methods: MessageListGet(), MessageListGetSwizzled(), MessageListIsValid(), MessageListNewObject(), MessageListSet()
property ServiceName as %String;
Name of the SOAP service if this is a SOAP request or response
Property methods: ServiceNameDisplayToLogical(), ServiceNameGet(), ServiceNameIsValid(), ServiceNameLogicalToDisplay(), ServiceNameLogicalToOdbc(), ServiceNameNormalize(), ServiceNameSet()
property SessionFlag as %Boolean;
True if this is request is in a SOAP session.
Property methods: SessionFlagDisplayToLogical(), SessionFlagGet(), SessionFlagIsValid(), SessionFlagLogicalToDisplay(), SessionFlagNormalize(), SessionFlagSet()


classmethod LogMessage(service As %Boolean, action As %String, data, status As %Status) [ Language = objectscript ]
method LogOutputBuffer(buffer As %String) [ Language = objectscript ]
classmethod LogOutputStart(service As %Boolean, action As %String) [ Language = objectscript ]
method OutputStream() [ Language = objectscript ]
Override of method to do the chunked output using the utility functions defined by the abstract super class.

Inherited Members

Inherited Properties

Inherited Methods