SOA Gateway Version 2010-05-31
 —  Reference  —

SOA Gateway SOAP Reference for Server Configuration


Soap Operations for Server Configuration

The SOA Gateway exposes a number of SOAP operations / methods to retrieve and alter the SOA Gateway Server Configuration from any SOAP enabled client.

Note:
hese interfaces are likely to change in the future, they are provided on a trial basis, be aware that you might have to change any "applications" built on top of these interfaces ! As soon as "stable" interfaces are available, this fact will be announced and documented.

adaptorList

This operation is used to load up a SOA Gateway driver library, and return the assoicated internal information.

This operation takes 1 input, libraryName should be set to the name of the library to load and query.

configList

This operation is used to list the current configuration in use by the SOA Gateway server. The current configuration is useful where you wish to make changes to existing configuration items, or just to make sure you are not trying to add, for example, a resource URI that is already in use.

This operation currently has no options.

The full configuration document, minus the XML header, is returned in the soap response.

configRemove

This operation is used to reset the value of an item in the configuration, or to remove an item from the configuration.

Only certain items or levels of items may be altered using this operation. The definition in the WSDL shows what elements may be used. Refer to it for further details on what type of items may be removed and what items may only have their value reset.

A configuration item which is reset will assume it's default value if it is an item that cannot be removed from the configuration.

Configuration items changed by this operation are effective as soon as the engine can make them so.

This operation currently has no options.

configReplace

This operation is used to replace the current configuration file, or to write a new configuration to file on the server.

If the element 'configFileName' is omitted or left empty, then the configuration file currently in use will be overwritten - if it is in the configuration directory.

If the element 'configFileName' is specified, then the configuration will be written to a file of that name in the configuration directory.

The newly written configuration will not come into effect until the SOA Gateway server is next started.

If the element 'configFileName' was specified, and you wish to use this configuration, then before re-starting the SOA Gateway server you must alter the system environment variable XMIDDLE_CONFIGURATION_FILE so that it refers to your new configuration file.

This operation currently has no options.

configSet

This operation is used to set the value of an item in the configuration, or to add an item to the configuration.

Only certain items or levels of items may be altered using this operation. The definition in the WSDL shows what elements may be used. Refer to it for further details on what type of items may be added and what items may only have their value altered.

Configuration items changed by this operation are effective as soon as the engine can make them so.

This operation currently has no options.

Top of page