Class SoapSOIHelper

Namespace
ESRI.Server.SOESupport.SOI
Assembly
ESRI.Server.SOESupport.dll

The SoapSOIHelper is an utility class that helps to implement SOAP request handling in SOIs.

public class SoapSOIHelper : SOIBase
Inheritance
SoapSOIHelper
Inherited Members

Constructors

SoapSOIHelper(IServerObjectHelper, string)

The SoapSOIHelper constructor should be called from the IServerObjectExtension.Init implementation.

public SoapSOIHelper(IServerObjectHelper soHelper, string wsdlFilePath)

Parameters

soHelper IServerObjectHelper

Reference to an instance of the IServerObjectHelper interface.

wsdlFilePath string

Full pathname of the WSDL schema file. For example, MapServer SOIs can use the "%lt;Server install path>\XmlSchema\MapServer.wsdl".

Methods

AddObjectToXMLSerializeData(string, object, string, IXMLSerializeData)

Adds object to IXmlSerializeData property bag.

public void AddObjectToXMLSerializeData(string name, object value, string typeName, IXMLSerializeData data)

Parameters

name string

Property name.

value object

Property value

typeName string

SOAP type of the property.

data IXMLSerializeData

Property data as Object.

ConvertBinaryRequestToMessage(byte[])

Converts binary SOAP request to the IMessage reference via ArcGIS SOAP deserialization.

public static IMessage ConvertBinaryRequestToMessage(byte[] request)

Parameters

request byte[]

Binary request data.

Returns

IMessage

IMessage reference.

ConvertMessageToBinaryRequest(IMessage)

Converts IMessage to binary SOAP request.

public static byte[] ConvertMessageToBinaryRequest(IMessage iMessage)

Parameters

iMessage IMessage

Non-null IMessage reference.

Returns

byte[]

SOAP binary request as an array of bytes

ConvertMessageToStringRequest(IMessage)

Converts IMessage to SOAP string request.

public static string ConvertMessageToStringRequest(IMessage iMessage)

Parameters

iMessage IMessage

Non-null IMessage reference.

Returns

string

SOAP request as string.

ConvertStringRequestToMessage(string)

Converts SOAP request string to the IMessage reference via ArcGIS SOAP deserialization.

public static IMessage ConvertStringRequestToMessage(string request)

Parameters

request string

String request content.

Returns

IMessage

IMessage reference.

CreateNewIMessage(IMessage)

Creates new IMessage and sets NamespaceURI and Name properties from the provided originalIMessage.

public IMessage CreateNewIMessage(IMessage originalIMessage)

Parameters

originalIMessage IMessage

Original IMessage. Must be not null.

Returns

IMessage

Reference to newly created IMessage.

GetObjectFromXMLSerializeData(int, string, string, IXMLSerializeData)

Retrieves property of the IXmlSerializeData and converts it to managed object by value.

public object GetObjectFromXMLSerializeData(int index, string typeNamespace, string typeName, IXMLSerializeData data)

Parameters

index int

The index of the requested property.

typeNamespace string

Type namespace of the requested property. Only makes sense for the complex types.

typeName string

SOAP type of the requested property.

data IXMLSerializeData

Reference to source IXMLSerializeData interface.

Returns

object

For simple types like xs:string it will return boxed value as an Object. For ArcGIS enumerations it will return enum value as a boxed string. For complex types it will return boxed object reference.

GetSoapOperationParameterName(string, int)

Gets the name of the SOAP operation parameter by SOAP operation name and parameter index.

public string GetSoapOperationParameterName(string operationName, int index)

Parameters

operationName string

SOAP operation name.

index int

An index of the requested parameter of the SOAP operation.

Returns

string

GetSoapOperationParameterTypeName(string, int)

Gets the typename of the SOAP operation parameter by SOAP operation name and parameter index.

public string GetSoapOperationParameterTypeName(string operationName, int index)

Parameters

operationName string

SOAP operation name.

index int

An index of the requested parameter of the SOAP operation.

Returns

string