8
SOAP Administration

This chapter describes configuration and administration details for Oracle SOAP. This chapter covers the following topics:

Configuring the Request Handler Servlet

The Oracle SOAP Request Handler uses an XML configuration file to set required servlet parameters. By default, this file is named soapConfig.xml and is placed in the directory $SOAP_HOME/webapps/soap/WEB-INF/config on UNIX or %SOAP_HOME\webapps\soap\WEB-INF\config on Windows NT. The XML namespace for this file is:

http://xmlns.oracle.com/soap/2001/04/config

To use a different configuration file for SOAP installation, modify the path name specified for the SoapConfig parameter in the soap.properties file. For example, to change the configuration file from the default, soapConfig.xml, to newConfig.xml, modify the value set for soapConfig in soap.properties.

servlet.soaprouter.initArgs=soapConfig=soap_home/soap/webapps/soap/WEB-INF/config/newConfig.xml

Where soap_home is the full path to the SOAP installation on your system.

Table 8-1 lists the SOAP deployment parameters available for configuring the SOAP Request Handler Servlet.

Table 8-1 SOAP Request Handler Servlet Configuration File Parameters

Parameter	Description
`errorHandlers`	Specifies a list of handlers for the error handler chain.
`faultListeners`	Specifies a list of fault listeners.
`handlers`	Specifies the available handler names and the options for each handler.
`logger`	Error and informational messages are logged using the class defined in the logger element. The logger class must extend `oracle.soap.server.Logger`. Oracle SOAP includes the class `oracle.soap.server.impl.ServletLogger` that collects the servlet log methods so that SOAP messages are logged to the servlet log file. `ServletLogger` is the default logger. For the default logger, the severity option can be to any of the following values: `status`, `error`, `debug`.
`providerManager`	Defines how the server accesses provider deployment information. The `providerManager` class attribute specifies a Java class that implements `oracle.soap.server.ProviderManager`. Oracle SOAP includes the class `oracle.soap.server.impl.FileProviderManager` which stores provider deployment information in a file. Using FileProviderManager, the file name is specified with the `filename` option. See "Setting Provider Manager and Service Manager Configuration Options" for more information.
`requestHandlers`	Specifies a list of handlers for the request handler chain
`responseHandlers`	Specifies a list of handlers for the response handler chain
`serviceManager`	Defines how the server accesses service deployment information. The `serviceManager` class attribute specifies a Java class that implements `oracle.soap.server.ServiceManager`. Oracle SOAP includes the class `oracle.soap.server.impl.FileServiceManager` which stores the service deployment information in a file. Using `FileServiceManager`, the file name is specified with the `filename` option. See "Setting Provider Manager and Service Manager Configuration Options" for more information.

Setting Provider Manager and Service Manager Configuration Options

The SOAP providerManager and serviceManager can be configured as SOAP services. To configure these deployment administration routines as SOAP services, set the serviceManager autoDeploy option to the value true in the soapConfig configuration file. Set the value to false to disable this option.

When the administration routines are deployed as SOAP services, you can optionally specify a specific URL for these services (an administration URL). Specifying an administration URL helps to maintain security for SOAP service deployment, and is recommended. To set and control the administration URL, perform the following three steps.

Configure ProviderManager and ServiceManager by setting the requiredRequestURI option in soapConfi.xml. Set the serviceManager or providerManager option requiredRequestURI to specify a URL for administration.
Modify the Jserv mount points for the administration URL by setting configuration options in the file jserv.conf in the directory $ORACLE_HOME/Apache/Jserv/etc.

For a manager that runs manually, with autoDeploy set to false, add a new path for a ApJServMount. For example,
```
ApJServMount /servlets /soap/admin/servlet
```
Run this with the URL,
```
http://hostname:port/soap/admin/servlet/soaprouter
```
For a manager that runs in auto mode, with autoDeploy set to true, add a new path for a ApJServGroupMount. For example,
```
ApJServGroupMount /servlets /soap/admin/servlet
```
Run this with the URL,
```
http://hostname:port/soap/admin/servlet/soaprouter
```
Set security for the specified URL by setting configuration options in the file httpd.conf in the directory $ORACLE_HOME/Apache/conf.

For example, if /soap/admin/servlet is set with secure access, you could set requiredRequestURI to /soap/admin/servlet/soaprouter for the ProviderManager and the ServiceManager.

Using Auto Start Mode

The SOAP Request Handler Servlet runs in auto mode or in non-auto mode. The mode determines how the servlet is started.

In auto mode, a process manager within Apache starts the SOAP Request Handler Servlet automatically and manages the process. In non-auto mode, the SOAP Request Handler Servlet needs to be manually started.

Oracle SOAP is installed using the default mode, auto. To change the mode, change the value for the ApJServManual configuration directive in the file jserv.conf in the directory $ORACLE_HOME/Apache/Jserv/etc.

Setting Jserv Configuration and Security

To set or update the list of IP addresses that is allowed to connect to Apache Jserv, modify the security.allowedAddresses parameter in the file $ORACLE_HOME/Apache/Jserv/etc/jservSoap.properties.

Changing the HTTP Listener Port Number

To set the port where the SOAP HTTP Listener runs, modify the Apache configuration file, httpd.conf found in the directory $ORACLE_HOME/Apache/Apache/conf.

You can view this file to determine the port where the Apache HTTP listener starts.

Configuring Memory Options

You can configure heap memory usage for the SOAP Request Handler Servlet in the file jservSoap.properties. This file resides in the directory $ORACLE_HOME/Apache/Jserv/etc on UNIX, or %ORACLE_HOME%\Apache\Jserv\etc on Windows NT. If you receive java.lang.OutofMemory errors from the SOAP Request Handler Servlet, increasing the heap size may solve this problem.

For example, to set the size of the SOAP Request Handler Servlet's heap memory to 32 megabytes, use the following settings in jservSoap.properties:

wrapper.bin.parameters=-Xmx32m
wrapper.bin.parameters--Xms32m

8 SOAP Administration