|
| |
|
| java.lang.Object
 org.apache.derby.drda.NetworkServerControl
| NetworkServerControl | | public class NetworkServerControl (Code) | | 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:
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();
|
| Constructor Summary | |
| public | NetworkServerControl(InetAddress address, int portNumber)
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.
Parameters:
portNumber - port number server is to used. | | public | 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. |
| Method Summary | |
| public Properties | getCurrentProperties()
| | public int | getMaxThreads()
| | public String | getRuntimeInfo()
Return detailed session runtime information about sessions,
prepared statements, and memory usage for the running Network Server. | | public String | getSysinfo()
Return classpath and version information about the running
Network Server. | | public int | getTimeSlice()
| | public void | logConnections(boolean on)
Turn logging connections on or off. | | public static void | main(String args)
| | public void | ping()
| | protected void | setClientLocale(String locale)
set the client locale. | | public void | setMaxThreads(int max)
Set Network Server maxthread parameter. | | public void | setTimeSlice(int timeslice)
Set Network Server connection time slice parameter. | | public void | setTraceDirectory(String traceDirectory)
Set directory for trace files. | | public void | shutdown()
Shutdown a Network Server. | | public void | start(PrintWriter consoleWriter)
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
cloudscape.properties.
Parameters:
consoleWriter - PrintWriter to which server console will be output. | | public void | trace(boolean on)
Turn tracing on or off for the specified connection
on the Network Server. | | public void | trace(int connNum, boolean on)
Turn tracing on or off for all connections on the Network Server.
Parameters:
connNum - connection number. |
| DEFAULT_PORTNUMBER | | final public static int DEFAULT_PORTNUMBER(Code) | | |
| NetworkServerControl | | public NetworkServerControl(InetAddress address, int portNumber) throws Exception(Code) | | 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.
Parameters:
portNumber - port number server is to used. If <= 0,default port number is used
throws:
Exception - on error |
| NetworkServerControl | | public NetworkServerControl() throws Exception(Code) | | 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:
Exception - on error |
| getCurrentProperties | | public Properties getCurrentProperties() throws Exception(Code) | | Get current Network server properties
Properties object containing Network server properties
exception:
Exception - throws an exception if an error occurs |
| getRuntimeInfo | | public String getRuntimeInfo() throws Exception(Code) | | Return detailed session runtime information about sessions,
prepared statements, and memory usage for the running Network Server.
run time information
exception:
Exception - throws an exception if an error occurs |
| getSysinfo | | public String getSysinfo() throws Exception(Code) | | Return classpath and version information about the running
Network Server.
sysinfo output
exception:
Exception - throws an exception if an error occurs |
| logConnections | | public void logConnections(boolean on) throws Exception(Code) | | 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
exception:
Exception - throws an exception if an error occurs |
| main | | public static void main(String args)(Code) | | main routine for NetworkServerControl
Parameters:
args - array of arguments indicating command to be executed.See class comments for more information |
| ping | | public void ping() throws Exception(Code) | | Check if Network Server is started
Excecutes and returns without error if the server has started
exception:
Exception - throws an exception if an error occurs |
| setClientLocale | | protected void setClientLocale(String locale)(Code) | | set the client locale. Used by servlet for localization
Parameters:
locale - Locale to use |
| setMaxThreads | | public void setMaxThreads(int max) throws Exception(Code) | | 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.
exception:
Exception - throws an exception if an error occurs
See Also: NetworkServerControl.setTimeSlice |
| setTimeSlice | | public void setTimeSlice(int timeslice) throws Exception(Code) | | 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.
exception:
Exception - throws an exception if an error occurs
See Also: NetworkServerControl.setMaxThreads |
| setTraceDirectory | | public void setTraceDirectory(String traceDirectory) throws Exception(Code) | | 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
exception:
Exception - throws an exception if an error occurs |
| shutdown | | public void shutdown() throws Exception(Code) | | Shutdown a Network Server.
Shuts down the Network Server listening on the port and InetAddress
specified in the constructor for this NetworkServerControl object.
exception:
Exception - throws an exception if an error occurs |
| start | | public void start(PrintWriter consoleWriter) throws Exception(Code) | | 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
cloudscape.properties.
Parameters:
consoleWriter - PrintWriter to which server console will be output. Null will disable console output.
exception:
Exception - if there is an error starting the server.
See Also: NetworkServerControl.shutdown |
| trace | | public void trace(boolean on) throws Exception(Code) | | 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.
exception:
Exception - throws an exception if an error occurs |
| trace | | public void trace(int connNum, boolean on) throws Exception(Code) | | Turn tracing on or off for all connections on the Network Server.
Parameters:
connNum - connection number. Note: Connection numbers will printin the Derby error log if logConnections is on
Parameters:
on - true to turn tracing on, false to turn tracing off.
exception:
Exception - throws an exception if an error occurs |
|
|
|