Provisioning Reference Guide › Common Program Exit Reference › Common Program Exit Structure › Common Exits SOAP Interface

Common Exits SOAP Interface

SOAP-deployed program exits must present an external interface like the following prototype:

char * function_name ( char * Input_XML )

The following list describes the parameters for the SOAP‑deployed program exit prototype:

• function_name

  Name of the program exit. The Web Services Description Language (WSDL) file that describes the program exit contains a definition of the function_name. This is also the name of the character buffer in UTF-8 format that is returned. This buffer is allocated by the referenced program, but must be cleared from the calling program.

• Input_XML

  Character buffer in UTF-8 format. Input_XML contains the XML buffer the Provisioning Server passes to the program exit.

The definition of this interface needs to be presented in the following ways:

• A way that the SOAP client can understand.
• A way that the SOAP server can understand.

The SOAP client relies upon WSDL to specify the interface. For a description of WSDL, see http://www.w3.org/tr/wsdl.html.

The SOAP server described here is the Apache SOAP server. The Apache SOAP server requires an XML document known as a Deployment Descriptor. The Deployment Descriptor indicates to the SOAP server what the interface to the SOAP program is. For a more complete description of deployment descriptors, see the Deployment Descriptors section in the User Guide at http://ws.apache.org/soap/docs/index.html.

An example of a SOAP exit can be found in the following folder:

Samples/ProgramExitSOAP