public class NetworkServerControl
extends java.lang.Object
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();
Modifier and Type | Field | Description |
---|---|---|
static int |
DEFAULT_PORTNUMBER |
|
private static java.lang.String |
DERBY_HOSTNAME_WILDCARD |
|
private static java.lang.String |
DERBYNET_JAR |
|
private static java.lang.String |
IPV6_HOSTNAME_WILDCARD |
|
private static java.lang.String |
POLICY_FILE_PROPERTY |
|
private static java.lang.String |
POLICY_FILENAME |
|
private NetworkServerControlImpl |
serverImpl |
|
private static java.lang.String |
SOCKET_PERMISSION_HOSTNAME_WILDCARD |
Constructor | Description |
---|---|
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.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.
|
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.
|
Modifier and Type | Method | Description |
---|---|---|
private static java.lang.String |
getCodeSourcePrefix(NetworkServerControlImpl server,
java.net.URL url) |
|
private static java.net.URL |
getCodeSourceURL(NetworkServerControlImpl server) |
Find the url of the library directory which holds derby.jar and
derbynet.jar.
|
java.util.Properties |
getCurrentProperties() |
Get current Network server properties
|
private static java.lang.String |
getHostNameForSocketPermission(NetworkServerControlImpl server) |
Get the hostname as a value suitable for substituting into the
default server policy file.
|
int |
getMaxThreads() |
Returns the current maxThreads setting for the running Network Server
|
private static java.lang.String |
getPolicyFileURL() |
Get the URL of the policy file.
|
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
|
private static boolean |
hostnamesEqual(java.lang.String left,
java.lang.String right) |
|
private static void |
installSecurityManager(NetworkServerControlImpl server) |
Install a SecurityManager governed by the Basic startup policy.
|
private static boolean |
isIPV6Address(java.lang.String hostname) |
|
void |
logConnections(boolean on) |
Turn logging connections on or off.
|
static void |
main(java.lang.String[] args) |
main routine for NetworkServerControl
|
private static boolean |
needsSecurityManager(NetworkServerControlImpl server,
int command) |
Return true if we need to install a Security Manager.
|
void |
ping() |
Check if the Network Server is 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.
|
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.
|
private static void |
verifySecurityState(NetworkServerControlImpl server) |
Verify that all prerequisites are met before bringing up a security
manager.
|
public static final int DEFAULT_PORTNUMBER
private static final java.lang.String DERBYNET_JAR
private static final java.lang.String POLICY_FILENAME
private static final java.lang.String POLICY_FILE_PROPERTY
private static final java.lang.String DERBY_HOSTNAME_WILDCARD
private static final java.lang.String IPV6_HOSTNAME_WILDCARD
private static final java.lang.String SOCKET_PERMISSION_HOSTNAME_WILDCARD
private NetworkServerControlImpl serverImpl
public NetworkServerControl(java.net.InetAddress address, int portNumber, java.lang.String userName, java.lang.String password) throws java.lang.Exception
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 useduserName
- The user name for actions requiring authorization.password
- The password for actions requiring authorization.java.lang.Exception
- on errorpublic NetworkServerControl(java.lang.String userName, java.lang.String password) throws java.lang.Exception
userName
- The user name for actions requiring authorization.password
- The password for actions requiring authorization.java.lang.Exception
- on errorpublic NetworkServerControl(java.net.InetAddress address, int portNumber) throws java.lang.Exception
Examples:
To configure for port 1621 and listen on the loopback address:
NetworkServerControl util = new NetworkServerControl(InetAddress.getByName("localhost"), 1621);
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 usedjava.lang.Exception
- on errorpublic NetworkServerControl() throws java.lang.Exception
new NetworkServerControl() is equivalent to calling new NetworkServerControl(InetAddress.getByName("localhost"),1527);
java.lang.Exception
- on errorpublic static void main(java.lang.String[] args)
args
- array of arguments indicating command to be executed.
See class comments for more informationpublic void start(java.io.PrintWriter consoleWriter) throws java.lang.Exception
Note: an alternate method to starting the Network Server with the API, is to use the derby.drda.startNetworkServer property in derby.properties.
consoleWriter
- PrintWriter to which server console will be
output. Null will disable console output.java.lang.Exception
- if there is an error starting the server.shutdown()
public void shutdown() throws java.lang.Exception
java.lang.Exception
- throws an exception if an error occurspublic void ping() throws java.lang.Exception
java.lang.Exception
- throws an exception if an error occurspublic void trace(boolean on) throws java.lang.Exception
on
- true to turn tracing on, false to turn tracing off.java.lang.Exception
- throws an exception if an error occurspublic void trace(int connNum, boolean on) throws java.lang.Exception
connNum
- connection number. Note: Connection numbers will print
in the Derby error log if logConnections is onon
- true to turn tracing on, false to turn tracing off.java.lang.Exception
- throws an exception if an error occurspublic void logConnections(boolean on) throws java.lang.Exception
on
- true to turn on, false to turn offjava.lang.Exception
- throws an exception if an error occurspublic void setTraceDirectory(java.lang.String traceDirectory) throws java.lang.Exception
traceDirectory
- directory for trace files on machine
where server is runningjava.lang.Exception
- throws an exception if an error occurspublic java.lang.String getSysinfo() throws java.lang.Exception
java.lang.Exception
- throws an exception if an error occurspublic java.lang.String getRuntimeInfo() throws java.lang.Exception
java.lang.Exception
- throws an exception if an error occurspublic void setMaxThreads(int max) throws java.lang.Exception
max
- maximum number of connection threads.
If <= 0, connection threads will be created when
there are no free connection threads.java.lang.Exception
- throws an exception if an error occurssetTimeSlice(int)
public int getMaxThreads() throws java.lang.Exception
java.lang.Exception
- throws an exception if an error occurssetMaxThreads(int)
public void setTimeSlice(int timeslice) throws java.lang.Exception
timeslice
- number of milliseconds given to each session before yielding to
another session, if <=0, never yield.java.lang.Exception
- throws an exception if an error occurssetMaxThreads(int)
public int getTimeSlice() throws java.lang.Exception
java.lang.Exception
- throws an exception if an error occurssetTimeSlice(int)
public java.util.Properties getCurrentProperties() throws java.lang.Exception
java.lang.Exception
- throws an exception if an error occursprotected void setClientLocale(java.lang.String locale)
locale
- Locale to useprivate static boolean needsSecurityManager(NetworkServerControlImpl server, int command) throws java.lang.Exception
java.lang.Exception
private static void verifySecurityState(NetworkServerControlImpl server) throws java.lang.Exception
java.lang.Exception
private static void installSecurityManager(NetworkServerControlImpl server) throws java.lang.Exception
java.lang.Exception
private static java.lang.String getHostNameForSocketPermission(NetworkServerControlImpl server) throws java.lang.Exception
java.lang.Exception
private static boolean hostnamesEqual(java.lang.String left, java.lang.String right)
private static boolean isIPV6Address(java.lang.String hostname)
private static java.net.URL getCodeSourceURL(NetworkServerControlImpl server) throws java.lang.Exception
Find the url of the library directory which holds derby.jar and derbynet.jar. The Basic policy assumes that both jar files live in the same directory.
java.lang.Exception
private static java.lang.String getCodeSourcePrefix(NetworkServerControlImpl server, java.net.URL url) throws java.lang.Exception
java.lang.Exception
private static java.lang.String getPolicyFileURL() throws java.lang.Exception
Get the URL of the policy file. Typically, this will be some pointer into derbynet.jar.
java.lang.Exception
Apache Derby V10.14 Internals - Copyright © 2004,2018 The Apache Software Foundation. All Rights Reserved.