|
|||||||||
| Home >> All >> org >> apache >> derby >> [ drda overview ] | PREV CLASS NEXT CLASS | ||||||||
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD |
DETAIL: FIELD | CONSTR | METHOD | ||||||||
org.apache.derby.drda
Class NetworkServerControl
java.lang.Objectorg.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:
- 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 and disconnections on and off. Connections and disconnections 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 clousdcape.system.home
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 and disconnections. 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();
| Field Summary | |
static int |
DEFAULT_PORTNUMBER
|
private org.apache.derby.impl.drda.NetworkServerControlImpl |
serverImpl
|
| 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. |
|
| 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
serverImpl
private org.apache.derby.impl.drda.NetworkServerControlImpl serverImpl
| Constructor Detail |
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);
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);
| Method Detail |
main
public static void main(java.lang.String[] args)
- main routine for NetworkServerControl
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 cloudscape.properties.
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.
ping
public void ping()
throws java.lang.Exception
- Check if Network Server is started
Excecutes and returns without error if the server has started
trace
public void trace(boolean on)
throws java.lang.Exception
- Turn tracing on or off for the specified connection
on the Network Server.
trace
public void trace(int connNum,
boolean on)
throws java.lang.Exception
- Turn tracing on or off for all connections on the Network Server.
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
connects or disconnects.
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.
getSysinfo
public java.lang.String getSysinfo() throws java.lang.Exception
- Return classpath and version information about the running
Network Server.
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.
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.
getMaxThreads
public int getMaxThreads()
throws java.lang.Exception
- Returns the current maxThreads setting for the running Network Server
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.
getTimeSlice
public int getTimeSlice()
throws java.lang.Exception
- Return the current timeSlice setting for the running Network Server
getCurrentProperties
public java.util.Properties getCurrentProperties() throws java.lang.Exception
- Get current Network server properties
setClientLocale
protected void setClientLocale(java.lang.String locale)
- set the client locale. Used by servlet for localization
|
|||||||||
| Home >> All >> org >> apache >> derby >> [ drda overview ] | PREV CLASS NEXT CLASS | ||||||||
|
SUMMARY: JAVADOC | SOURCE | DOWNLOAD | NESTED | FIELD | CONSTR | METHOD |
DETAIL: FIELD | CONSTR | METHOD | ||||||||