Examples of NetworkServerControl

• org.apache.derby.drda.NetworkServerControl
  NetworkServerControl provides the ability to start a Network Server or connect to a running Network Server to shutdown, configure or retreive diagnostic information. With the exception of ping, these commands can only be performed from the machine on which the server is running. Commands can be performed from the command line with the following arguments:

  • start [-h <host>] [-p <portnumber>]: This starts the network server on the port/host specified or on localhost, port 1527 if no host/port is specified and no properties are set to override the defaults. By default Network Server will only listen for connections from the machine on which it is running. Use -h 0.0.0.0 to listen on all interfaces or -h <hostname> to listen on a specific interface on a multiple IP machine.
  • shutdown [-h <host>][-p <portnumber>]: This shutdowns the network server on the host and port specified or on the local host and port 1527(default) if no host or port is specified.
  • ping [-h <host>] [-p <portnumber>] This will test whether the Network Server is up.
  • sysinfo [-h <host>] [-p <portnumber>]: This prints classpath and version information about the Network Server, the JVM and the Derby engine.
  • runtimeinfo [-h <host] [-p <portnumber]: This prints extensive debbugging information about sessions, threads, prepared statements, and memory usage for the running Network Server.
  • logconnections {on | off} [-h <host>] [-p <portnumber>]: This turns logging of connections on or off. Connections are logged to derby.log. Default is off.
  • maxthreads <max> [-h <host>][-p <portnumber>]: This sets the maximum number of threads that can be used for connections. Default 0 (unlimitted).
  • timeslice <milliseconds> [-h <host>][-p <portnumber>]: This sets the time each session can have using a connection thread before yielding to a waiting session. Default is 0 (no yeild).
  • trace {on | off} [-s <session id>] [-h <host>] [-p <portnumber>]: This turns drda tracing on or off for the specified session or if no session is specified for all sessions. Default is off
  • tracedirectory <tracedirectory> [-h <host>] [-p <portnumber>]: This changes where new trace files will be placed. For sessions with tracing already turned on, trace files remain in the previous location. Default is derby.system.home, if it is set. Otherwise the default is the current directory.

  Properties can be set in the derby.properties file or on the command line. Properties on the command line take precedence over properties in the derby.properties file. Arguments on the command line take precedence over properties. The following is a list of properties that can be set for NetworkServerControl:

  • derby.drda.portNumber=<port number>: This property indicates which port should be used for the Network Server.
  • derby.drda.host=<host name or ip address >: This property indicates the ip address to which NetworkServerControl should connect
  • derby.drda.traceDirectory=<trace directory>: This property indicates where to put trace files.
  • derby.drda.traceAll=true: This property turns on tracing for all sessions. Default is tracing is off.
  • derby.drda.logConnections=true: This property turns on logging of connections. Default is connections are not logged.
  • derby.drda.minThreads=<value>: If this property is set, the <value> number of threads will be created when the Network Server is booted.
  • derby.drda.maxThreads=<value>: If this property is set, the <value> is the maximum number of connection threads that will be created. If a session starts when there are no connection threads available and the maximum number of threads has been reached, it will wait until a conection thread becomes available.
  • derby.drda.timeSlice=<milliseconds>: If this property is set, the connection threads will not check for waiting sessions until the current session has been working for <milliseconds>. A value of 0 causes the thread to work on the current session until the session exits. If this property is not set, the default value is 0.

  Examples.

  This is an example of shutting down the server on port 1621.

    java org.apache.derby.drda.NetworkServerControl shutdown -p 1621 

  This is an example of turning tracing on for session 3

   java org.apache.derby.drda.NetworkServerControl  trace on -s 3  

  This is an example of starting and then shutting down the network server on port 1621 on machine myhost

   java org.apache.derby.drda.NetworkServerControl  start -h myhost -p 1621 java org.apache.derby.drda.NetworkServerControl  shutdown -h myhost -p 1621 

  This is an example of starting and shutting down the Network Server in the example above with the API.

   NetworkServerControl serverControl = new NetworkServerControl(InetAddress.getByName("myhost"),1621) serverControl.shutdown(); 

Examples of org.apache.derby.drda.NetworkServerControl