Apache Derby 10.9

org.apache.derby.drda
Class NetworkServerControl

java.lang.Object
  extended by org.apache.derby.drda.NetworkServerControl

public class NetworkServerControl
extends java.lang.Object

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:

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:

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();
        


Field Summary
static int DEFAULT_PORTNUMBER
           
 
Constructor Summary
NetworkServerControl()
          Creates a NetworkServerControl object that is configured to control a Network Server on the default host(localhost) and the default port(1527) unless derby.drda.portNumber and derby.drda.host are set.
NetworkServerControl(java.net.InetAddress address, int portNumber)
          Creates a NetworkServerControl object that is configured to control a Network Server on a specified port and InetAddress.
NetworkServerControl(java.net.InetAddress address, int portNumber, java.lang.String userName, java.lang.String password)
          Creates a NetworkServerControl object that is configured to control a Network Server on a specified port and InetAddress with given user credentials.
NetworkServerControl(java.lang.String userName, java.lang.String password)
          Creates a NetworkServerControl object that is configured to control a Network Server on the default host and the default port with given user credentials.
 
Method Summary
 java.util.Properties getCurrentProperties()
          Get current Network server properties
 int getMaxThreads()
          Returns the current maxThreads setting for the running Network Server
 java.lang.String getRuntimeInfo()
          Return detailed session runtime information about sessions, prepared statements, and memory usage for the running Network Server.
 java.lang.String getSysinfo()
          Return classpath and version information about the running Network Server.
 int getTimeSlice()
          Return the current timeSlice setting for the running Network Server
 void logConnections(boolean on)
          Turn logging connections on or off.
static void main(java.lang.String[] args)
          main routine for NetworkServerControl
 void ping()
          Check if Network Server is started Excecutes and returns without error if the server has started
protected  void setClientLocale(java.lang.String locale)
          set the client locale.
 void setMaxThreads(int max)
          Set Network Server maxthread parameter.
 void setTimeSlice(int timeslice)
          Set Network Server connection time slice parameter.
 void setTraceDirectory(java.lang.String traceDirectory)
          Set directory for trace files.
 void shutdown()
          Shutdown a Network Server.
 void start(java.io.PrintWriter consoleWriter)
          Start a Network Server This method will launch a separate thread and start Network Server.
 void trace(boolean on)
          Turn tracing on or off for the specified connection on the Network Server.
 void trace(int connNum, boolean on)
          Turn tracing on or off for all connections on the Network Server.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_PORTNUMBER

public static final int DEFAULT_PORTNUMBER
See Also:
Constant Field Values
Constructor Detail

NetworkServerControl

public NetworkServerControl(java.net.InetAddress address,
                            int portNumber,
                            java.lang.String userName,
                            java.lang.String password)
                     throws java.lang.Exception
Creates a NetworkServerControl object that is configured to control a Network Server on a specified port and InetAddress with given user credentials.

Parameters:
address - The IP address of the Network Server host. address cannot be null.
portNumber - port number server is to used. If <= 0, default port number is used
userName - The user name for actions requiring authorization.
password - The password for actions requiring authorization.
Throws:
java.lang.Exception - on error

NetworkServerControl

public NetworkServerControl(java.lang.String userName,
                            java.lang.String password)
                     throws java.lang.Exception
Creates a NetworkServerControl object that is configured to control a Network Server on the default host and the default port with given user credentials.

Parameters:
userName - The user name for actions requiring authorization.
password - The password for actions requiring authorization.
Throws:
java.lang.Exception - on error

NetworkServerControl

public NetworkServerControl(java.net.InetAddress address,
                            int portNumber)
                     throws java.lang.Exception
Creates a NetworkServerControl object that is configured to control a Network Server on a specified port and InetAddress.

Examples:

To configure for port 1621 and listen on the loopback address:

  NetworkServerControl  util = new
 NetworkServerControl(InetAddress.getByName("localhost"), 1621);
 

Parameters:
address - The IP address of the Network Server host. address cannot be null.
portNumber - port number server is to used. If <= 0, default port number is used
Throws:
java.lang.Exception - on error

NetworkServerControl

public NetworkServerControl()
                     throws java.lang.Exception
Creates a NetworkServerControl object that is configured to control a Network Server on the default host(localhost) and the default port(1527) unless derby.drda.portNumber and derby.drda.host are set.

 new NetworkServerControl() 

 is equivalent to calling

 new NetworkServerControl(InetAddress.getByName("localhost"),1527);
 

Throws:
java.lang.Exception - on error
Method Detail

main

public static void main(java.lang.String[] args)
main routine for NetworkServerControl

Parameters:
args - array of arguments indicating command to be executed. See class comments for more information

start

public void start(java.io.PrintWriter consoleWriter)
           throws java.lang.Exception
Start a Network Server This method will launch a separate thread and start Network Server. This method may return before the server is ready to accept connections. Use the ping method to verify that the server has started.

Note: an alternate method to starting the Network Server with the API, is to use the derby.drda.startNetworkServer property in derby.properties.

Parameters:
consoleWriter - PrintWriter to which server console will be output. Null will disable console output.
Throws:
java.lang.Exception - if there is an error starting the server.
See Also:
shutdown()

shutdown

public void shutdown()
              throws java.lang.Exception
Shutdown a Network Server. Shuts down the Network Server listening on the port and InetAddress specified in the constructor for this NetworkServerControl object.

Throws:
java.lang.Exception - throws an exception if an error occurs

ping

public void ping()
          throws java.lang.Exception
Check if Network Server is started Excecutes and returns without error if the server has started

Throws:
java.lang.Exception - throws an exception if an error occurs

trace

public void trace(boolean on)
           throws java.lang.Exception
Turn tracing on or off for the specified connection on the Network Server.

Parameters:
on - true to turn tracing on, false to turn tracing off.
Throws:
java.lang.Exception - throws an exception if an error occurs

trace

public void trace(int connNum,
                  boolean on)
           throws java.lang.Exception
Turn tracing on or off for all connections on the Network Server.

Parameters:
connNum - connection number. Note: Connection numbers will print in the Derby error log if logConnections is on
on - true to turn tracing on, false to turn tracing off.
Throws:
java.lang.Exception - throws an exception if an error occurs

logConnections

public void logConnections(boolean on)
                    throws java.lang.Exception
Turn logging connections on or off. When logging is turned on a message is written to the Derby error log each time a connection is made.

Parameters:
on - true to turn on, false to turn off
Throws:
java.lang.Exception - throws an exception if an error occurs

setTraceDirectory

public void setTraceDirectory(java.lang.String traceDirectory)
                       throws java.lang.Exception
Set directory for trace files. The directory must be on the machine where the server is running.

Parameters:
traceDirectory - directory for trace files on machine where server is running
Throws:
java.lang.Exception - throws an exception if an error occurs

getSysinfo

public java.lang.String getSysinfo()
                            throws java.lang.Exception
Return classpath and version information about the running Network Server.

Returns:
sysinfo output
Throws:
java.lang.Exception - throws an exception if an error occurs

getRuntimeInfo

public java.lang.String getRuntimeInfo()
                                throws java.lang.Exception
Return detailed session runtime information about sessions, prepared statements, and memory usage for the running Network Server.

Returns:
run time information
Throws:
java.lang.Exception - throws an exception if an error occurs

setMaxThreads

public void setMaxThreads(int max)
                   throws java.lang.Exception
Set Network Server maxthread parameter. This is the maximum number of threads that will be used for JDBC client connections. setTimeSlice should also be set so that clients will yield appropriately.

Parameters:
max - maximum number of connection threads. If <= 0, connection threads will be created when there are no free connection threads.
Throws:
java.lang.Exception - throws an exception if an error occurs
See Also:
setTimeSlice(int)

getMaxThreads

public int getMaxThreads()
                  throws java.lang.Exception
Returns the current maxThreads setting for the running Network Server

Returns:
maxThreads setting
Throws:
java.lang.Exception - throws an exception if an error occurs
See Also:
setMaxThreads(int)

setTimeSlice

public void setTimeSlice(int timeslice)
                  throws java.lang.Exception
Set Network Server connection time slice parameter. This should be set and is only relevant if setMaxThreads > 0.

Parameters:
timeslice - number of milliseconds given to each session before yielding to another session, if <=0, never yield.
Throws:
java.lang.Exception - throws an exception if an error occurs
See Also:
setMaxThreads(int)

getTimeSlice

public int getTimeSlice()
                 throws java.lang.Exception
Return the current timeSlice setting for the running Network Server

Returns:
timeSlice setting
Throws:
java.lang.Exception - throws an exception if an error occurs
See Also:
setTimeSlice(int)

getCurrentProperties

public java.util.Properties getCurrentProperties()
                                          throws java.lang.Exception
Get current Network server properties

Returns:
Properties object containing Network server properties
Throws:
java.lang.Exception - throws an exception if an error occurs

setClientLocale

protected void setClientLocale(java.lang.String locale)
set the client locale. Used by servlet for localization

Parameters:
locale - Locale to use

Built on Thu 2012-05-31 12:19:36-0700, from revision 1344872

Apache Derby 10.9 API Documentation - Copyright © 2004,2012 The Apache Software Foundation. All Rights Reserved.