Java DB

Apache Derby

Derby Server and Administration Guide

Derby Getting Started
Derby Reference Manual
Derby Developer's Guide
Derby Performance Tuning
Derby Server and Admin Guide
Derby Tools and Utilities
Derby Server and Admin Guide
-Part one: Derby Server Guide
-Derby in a multi-user environment
-Using the Network Server with preexisting Derby applications
-The Network Server and JVMs
-Installing required jar files and adding them to the classpath
-Starting the Network Server
-Shutting down the Network Server
-Obtaining system information
-Accessing the Network Server by using the network client driver
-Accessing the Network Server by using a DataSource object
-XA and the Network Server
-Using the Derby tools with the Network Server
-Differences between running Derby in embedded mode and using the Network Server
-Setting port numbers
-Managing the Derby Network Server
-Managing the Derby Network Server remotely by using the servlet interface
-Derby Network Server advanced topics
-Derby Network Server sample programs
-Part two: Derby Administration Guide
-Checking database consistency
-Backing up and restoring databases
-Replicating databases
-Logging on a separate device
-Obtaining locking information
-Reclaiming unused space

 

Starting the Network Server

To start the Network Server, you can invoke a script, a jar file, or a class.

Important: Note that you should always properly shut down the Network Server after use, because failure to do so might result in unpredictable side-effects, such as blocked ports on the server.

You are strongly urged to enable user authentication when you run a Network Server. For details on how to configure user authentication, please consult the "Working with user authentication" section in the Developer's Guide. You are also urged to install a Java security manager with a customized security policy. For details on how to do this, see Customizing the Network Server's security policy.

You can start the Network Server in any of the following ways:

  • If you are relatively new to the Java programming language, follow the instructions in "Setting up your environment" in Getting Started with Derby to set the DERBY_HOME and JAVA_HOME environment variables and to add DERBY_HOME/bin to your path. Then use the startNetworkServer.bat script to start the Network Server on Windows machines and the startNetworkServer script to start the Network Server on UNIX systems. These scripts are located in $DERBY_HOME/bin, where $DERBY_HOME is the directory where you installed Derby.

    You can run NetworkServerControl commands only from the host that started the Network Server.

    Operating System Command
    Windows 
    set DERBY_HOME=C:\derby
set JAVA_HOME=C:\Program Files\Java\jdk1.5.0_10
set PATH=%DERBY_HOME%\bin;%PATH%
startNetworkServer
    UNIX (Korn Shell) 
    export DERBY_HOME=/opt/derby
export JAVA_HOME=/usr/j2se
export PATH="$DERBY_HOME/bin:$PATH"
startNetworkServer

  • If you are a regular Java user but are new to Derby, set the DERBY_HOME environment variable, then use a java command to invoke the derbyrun.jar or derbynet.jar file:

    Operating System Command
    Windows 
    set DERBY_HOME=C:\derby
java -jar %DERBY_HOME%\lib\derbyrun.jar server start
or
java -jar %DERBY_HOME%\lib\derbynet.jar start
    UNIX (Korn Shell) 
    export DERBY_HOME=/opt/derby
java -jar $DERBY_HOME/lib/derbyrun.jar server start
or
java -jar $DERBY_HOME/lib/derbynet.jar start

    To see the command syntax, invoke derbyrun.jar server or derbynet.jar with no arguments.

  • If you are familiar with both the Java programming language and Derby, you have already set DERBY_HOME. Set your classpath to include the Derby jar files. Then use a java command to invoke the NetworkServerControl class directly.

    Operating System Command
    Windows 
    %DERBY_HOME%\bin\setNetworkServerCP
java org.apache.derby.drda.NetworkServerControl start
    UNIX (Korn Shell) 
    $DERBY_HOME/bin/setNetworkServerCP
java org.apache.derby.drda.NetworkServerControl start

The default system directory is the directory in which Derby was started. (See the Derby Developer's Guide for more information about the default system directory.)

You can specify a different host or port number when you start the Network Server by specifying an option to the command.

  • Specify a port number other than the default (1527) by using the -p portnumber option, as shown in the following example:

    java org.apache.derby.drda.NetworkServerControl start -p 1368

  • Specify a specific interface (host name or IP address) to listen on other than the default (localhost) by using the -h option, as shown in the following example:

    $DERBY_HOME/bin/startNetworkServer -h myhost -p 1368

    where myhost is the host name or IP address.

    Remember: Before using the -h option, you should run under the Java security manager with a customized security policy and you should enable user authentication.

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.

 

javadb@jdbcurl.com