Managing the <ph conref="../conrefs.dita#prod/productshortname"></ph> Network Server remotely by using the servlet interface You can use the servlet interface to manage the Network Server remotely. To use the servlet interface, the servlet must be registered with an Application Server, and derby.system.home must be known to the Application Server.

The servlet interface is suitable only for testing purposes. It should not be used in production.

A web application archive (WAR) file for the Network Server, derby.war, is available in $/lib. This file registers the Network Server's servlet at the relative path /derbynet. See the documentation for your Application Server for instructions on how to install it.

For example, if derby.war is installed in WebSphere Application Server with a context root of derby, the URL of the server is:

http://<server>[:port]/derby/derbynet
  • A servlet engine is not part of the Network Server.
  • When the Network Server is started by the servlet interface, shutting down the Application Server also shuts the Network Server down, since both run in the same JVM.

The servlet takes the following optional configuration parameters:

host
Specifies the host name to be used by the Network Server. See the Security Considerations section below.
portNumber
Specifies the port number to be used by the Network Server.
startNetworkServerOnInit
Specifies that the Network Server is to be started when the servlet is initialized.
tracingDirectory
Specifies the location for trace files. If the tracing directory is not specified, the traces are placed in derby.system.home.
Security considerations

For general security considerations for the Network Server, see the .

The host parameter allows configuration of the host name that will be used for the listening socket for network connections. By default, the Network Server will listen to requests only on the loopback address, which means that it will only accept connections from the local host. Changing this value could expose the server to external connections, which raises security concerns, so before using the host parameter, you should enable user authentication.

This section describes the servlet pages.