<mapping> element

 Top  Previous  Next

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 name

data type

usage

default value

description

 

name

xsd:NCName

required

 

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

 

The name of the element to be mapped. It must be a child of the type specified by the type attribute of the mapping's parent <request>. It may include a path separated by "/" if it refers to a sub element. The special value "." indicates the element whose name matches the parameter name.

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.

 

For further information and a complete example, see ........

Examples

<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>

 

-----------------------------

 

<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>