SOAP Inbound Connection


Overview

You can have only one SOAP Connection defined in the UAC.xml file.

Setting Up an Inbound SOAP Listener

To set up an inbound SOAP Listener, you must:

  1. Supply values for the following items in the UAC.xml file:
    • Operation
      Name of the SOAP operation from the inbound source application's web service call.
      Note: If the operation of the calling web service does not match the operation specified here, the inbound web service call will fail.
    • URI
      Path to the inbound service. This value should be set to: /axis2/services/UACInbound.
  2. Specify the attributes for the SOAP Listener, which include Destination and Actions.
    Currently, the only Action that is supported is writing the inbound transaction to a file.
    • Directory
      Output directory where UAC will write the file. If only a name is given, it is considered relative to the UAC directory. A fully qualified path can be given, as long as it is reachable locally or via a network. The only requirement is that the directory must exist prior to commencing inbound operations.
    • File Name Pattern
      Name of the file and the sequence pattern, if there will be more than one file written to the same directory. The format is <filenamehere%Seq%.txt>, where filenamehere is the name of the file you have chosen.

File name restrictions are enforced by the file system to which the file is being written. For example, using double quotation marks ( " ) around a file name in Windows will result in an error.

  • Start Sequence Number
    Starting number to use for the pattern sequence (%Seq%).
  • Write Properties
    The default value is false. However, if it is useful to see what was specified in the properties of the SOAP message, especially if more than one node is involved, set the value to true

 

SOAP Connection Sample

The following figure illustrates a sample SOAP Connection section. The values in red are the values discussed above.

See UAC.xml File Description for details on the elements and structure of the UAC.xml file.


<sb:SOAPConnection>
   <sb:URI>/axis2/services/UACInbound</sb:URI>
   <sb:Listeners>
      <sb:SOAPListener>
         <sb:Operation>Operation</sb:Operation>
         <sb:Actions>
            <sb:SOAPFileWriter>
               <sb:Directory>outputDirectory</sb:Directory>
               <sb:FilenamePattern>soapMessage%Seq%.xml</sb:FilenamePattern>
               <sb:StartSequenceNumber>1</sb:StartSequenceNumber>
               <sb:WriteEnvelope>false</sb:WriteEnvelope>
            </sb:SOAPFileWriter>
         </sb:Actions>
      </sb:SOAPListener>
   </sb:Listeners>
</sb:SOAPConnection>