SOAPam Server

<mapping>

This element specifies the mapping between a SOAP header or method parameter and an <element> of a server request or reply.

 

parents

<mappings>

children

 

Attributes

Attribute

Data Type

Usage

Default Value

Description

name

xsd:NCName

required

none

The name of a <header> or <parameter> element. It must be a descendant of the same method as the mapping element.

element

xsd:NCName

required

none

The value of the element. It must be appropriate to the type of the specified element. If element's type is "integer", value must be an integer value.

Remarks

In the simplest case, a single method parameter is of the same type as the request or reply so that the entire server interprocess message is mapped with a single mapping element. A more complex scenario involves mapping one or more SOAP request headers and method input parameters to various (sub) elements of the request type or from the reply type to SOAP response headers and method output parameters.

Examples

In this example multiple parameters are mapped to individual IPM elements.

XML
<headers>
 <header name="MyHeader" type="string" direction="in"/>
</headers>
 
<parameters>
 <parameter name="MyMethodInputParameter" type="integer" direction="in"/>
 <parameter name="MyMethodOutputParameter" type="string" direction="out"/>
</parameters>
 
<request type="MyRequestMessage">
 <mappings>
   <mapping name="MyHeader" element="MyRequestHeader/MyStringElement"/>
   <mapping name="MyMethodInputParameter" element="MyIntegerElement"/>
</mappings>
</request>
 
<replies>
 <reply type="MyReplyMessage">
   <mappings>
     <mapping name="MyMethodOutputParameter" element="MyStringElement"/>
   </mappings>
 </reply>
</replies>

 

In this example single request and response parameters are mapped to the entire request and response IPM.

XML
<parameters>
 <parameter name="requestMsg" type="MyRequestMessage" direction="in"/>
 <parameter name="replyMsg" type="MyReplyMessage" direction="out"/>
</parameters>
 
<request type ="MyRequestMessage">
 <mappings>
   <mapping name="requestMsg" element="."/>
 </mappings>
</request>
 
<replies>
 <reply type="MyReplyMessage" replyCode="*">
   <mappings>
     <mapping name="replyMsg" element="."/>
   </mappings>
 </reply>
</replies>