The SoapSOIHelper is an utility class that helps to implement SOAP request handling in SOIs.
Constructors
Name | Description |
---|---|
SoapSOIHelper(IServerObjectHelper, String) | The SoapSOIHelper constructor should be called from the IServerObjectExtension.Init implementation. |
SoapSOIHelper(IServerObjectHelper, String) Constructor
The SoapSOIHelper constructor should be called from the IServerObjectExtension.Init implementation.
public SoapSOIHelper (ESRI.ArcGIS.Server.IServerObjectHelper soHelper, String wsdlFilePath )
Name | Description |
---|---|
soHelper | Reference to an instance of the IServerObjectHelper interface. |
wsdlFilePath | Full pathname of the WSDL schema file. For example, MapServer SOIs can use the <Server install path . |
Methods
Name | Description |
---|---|
SoapSOIHelper.AddObjectToXMLSerializeData(String, Object, String, IXMLSerializeData) | Adds object to IXmlSerializeData property bag. |
SoapSOIHelper.ConvertBinaryRequestToMessage(Byte[]) | Converts binary SOAP request to the IMessage reference via ArcGIS SOAP deserialization. |
SoapSOIHelper.ConvertMessageToBinaryRequest(IMessage) | Converts IMessage to binary SOAP request. |
SoapSOIHelper.ConvertMessageToStringRequest(IMessage) | Converts IMessage to SOAP string request. |
SoapSOIHelper.ConvertStringRequestToMessage(String) | Converts SOAP request string to the IMessage reference via ArcGIS SOAP deserialization. |
SoapSOIHelper.CreateNewIMessage(IMessage) | Creates new IMessage and sets Namespace and Name properties from the provided original IMessage. |
SoapSOIHelper.GetObjectFromXMLSerializeData(Int32, String, String, IXMLSerializeData) | Retrieves property of the IXmlSerializeData and converts it to managed object by value. |
SoapSOIHelper.GetSoapOperationParameterName(String, Int32) | Gets the name of the SOAP operation parameter by SOAP operation name and parameter index. |
SoapSOIHelper.GetSoapOperationParameterTypeName(String, Int32) | Gets the typename of the SOAP operation parameter by SOAP operation name and parameter index. |
SoapSOIHelper.AddObjectToXMLSerializeData(String, Object, String, IXMLSerializeData) Method
Adds object to IXMLSerializeData property bag.
public void AddObjectToXMLSerializeData ( String name,
Object value,
String typeName,
IXMLSerializeData data )
Parameter | Description |
---|---|
name | Property name. |
value | Property value |
typeName | SOAP type of the property. |
data | Property data as IXMLSerializeData. |
SoapSOIHelper.ConvertBinaryRequestToMessage(Byte[]) Method
Converts binary SOAP request to the IMessage reference via ArcGIS SOAP deserialization.
public static IMessage ConvertBinaryRequestToMessage ( byte[] request )
Parameter | Description |
---|---|
request | Binary request data. |
SoapSOIHelper.ConvertMessageToBinaryRequest(IMessage) Method
Converts IMessage to binary SOAP request.
public static byte[] ConvertMessageToBinaryRequest(IMessage iMessage )
Parameter | Description |
---|---|
iMessage | Non-null IMessage reference. |
SoapSOIHelper.ConvertMessageToStringRequest(IMessage) Method
Converts IMessage to SOAP string request.
public static String ConvertMessageToStringRequest(IMessage iMessage)
Parameter | Description |
---|---|
iMessage | Non-null IMessage reference. |
SoapSOIHelper.ConvertStringRequestToMessage(String) Method
Converts SOAP request string to the IMessage reference via ArcGIS SOAP deserialization.
public static IMessage ConvertStringRequestToMessage(String request )
Parameter | Description |
---|---|
request | String request content. |
SoapSOIHelper.CreateNewIMessage(IMessage) Method
Creates new IMessage and sets Namespace
and Name
properties from the provided original IMessage.
public IMessage CreateNewIMessage(IMessage originalIMessage)
Parameter | Description |
---|---|
originalIMessage | Original IMessage. Must be not null. |
SoapSOIHelper.GetObjectFromXMLSerializeData(Int32, String, String, IXMLSerializeData) Method
Retrieves property of the IXmlSerializeData and converts it to managed object by value.
public Object GetObjectFromXMLSerializeData(int index,
String typeNamespace,
String typeName,
IXMLSerializeData data )
Parameter | Description |
---|---|
index | The index of the requested property. |
typeNamespace | Type namespace of the requested property. Only makes sense for the complex types. |
typeName | SOAP type of the requested property. |
data | Reference to source IXMLSerializeData interface. |
For simple types like xs
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.
SoapSOIHelper.GetSoapOperationParameterName(String, Int32) Method
Gets the name of the SOAP operation parameter by SOAP operation name and parameter index.
public String GetSoapOperationParameterName (String operationName, int index)
Parameter | Description |
---|---|
operationName | SOAP operation name. |
index | An index of the requested parameter of the SOAP operation. |
SoapSOIHelper.GetSoapOperationParameterTypeName(String, Int32) Method
Gets the typename of the SOAP operation parameter by SOAP operation name and parameter index.
public String GetSoapOperationParameterTypeName(String operationName, int index)
Parameter | Description |
---|---|
operationName | SOAP operation name. |
index | An index of the requested parameter of the SOAP operation. |
Inheritance Hierarchy
Inheritance: ESRI.Server.SOESupport.SOI.SOIBase → ESRI.Server.SOESupport.SOI.SoapSOIHelper