Apache Derby Database Engine and Embedded JDBC Driver 10.17.1.0 · org.apache.derby.iapi.jdbc.DRDAServerStarter

Field Summary

Modifier and Type	Field and Description
private PrintWriter	consoleWriter
private InetAddress	listenAddress
private String	passwordArg
private int	portNumber
private Method	runServerMethod Reflect reference to the method to run the server.
private Object	server The instance of the NetworkServerControlImpl being used to run the server.
private Class<?>	serverClass
private static final String	serverClassName
private Method	serverShutdownMethod Reflect reference to the method to directly shutdown the server.
private Thread	serverThread
private String	userArg

Constructor Summary

Access	Constructor and Description
public	DRDAServerStarter()

Method Summary

Modifier and Type	Method and Description
public void	boot(boolean True if the database should be created create, Properties Configuration properties properties) Implements org.apache.derby.iapi.services.monitor.ModuleControl.boot. Boot this module with the given properties.
private void	findStartStopMethods(final Class<?> serverClass) Find the methods to start and shutdown the server.
private static ModuleFactory	getMonitor() Must be private so that user code can't call this entry point.
public void	run() Implements java.lang.Runnable.run. Runs this operation.
public void	setStartInfo(InetAddress InetAddress to listen on listenAddress, int portNumber to listen on portNumber, String the user name for actions requiring authorization userName, String the password for actions requiring authorization password, PrintWriter the diagnostic log writer consoleWriter) Sets configuration information for the network server to be started.
public void	setStartInfo(InetAddress listenAddress, int portNumber, PrintWriter consoleWriter)
public void	stop() Implements org.apache.derby.iapi.services.monitor.ModuleControl.stop. Stop the module.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

consoleWriter	back to summary
private PrintWriter consoleWriter

listenAddress	back to summary
private InetAddress listenAddress

passwordArg	back to summary
private String passwordArg

portNumber	back to summary
private int portNumber

runServerMethod	back to summary
private Method runServerMethod Reflect reference to the method to run the server. NetworkServerControlImpl.blockingStart

server	back to summary
private Object server The instance of the NetworkServerControlImpl being used to run the server.

serverClass	back to summary
private Class<?> serverClass

serverClassName	back to summary
private static final String serverClassName

serverShutdownMethod	back to summary
private Method serverShutdownMethod Reflect reference to the method to directly shutdown the server. NetworkServerControlImpl.directShutdown

serverThread	back to summary
private Thread serverThread

userArg	back to summary
private String userArg

Constructor Detail

DRDAServerStarter	back to summary
public DRDAServerStarter()

Method Detail

boot	back to summary
public void boot(boolean create, Properties properties) Implements org.apache.derby.iapi.services.monitor.ModuleControl.boot. Doc from org.apache.derby.iapi.services.monitor.ModuleControl.boot. Boot this module with the given properties. Creates a module instance that can be found using the findModule() methods of Monitor. The module can only be found using one of these findModule() methods once this method has returned. An implementation's boot method can throw StandardException. If it is thrown the module is not registered by the monitor and therefore cannot be found through a findModule(). In this case the module's stop() method is not called, thus throwing this exception must free up any resources. When create is true the contents of the properties object will be written to the service.properties of the persistent service. Thus any code that requires an entry in service.properties must explicitly place the value in this properties set using the put method. Typically the properties object contains one or more default properties sets, which are not written out to service.properties. These default sets are how callers modify the create process. In a JDBC connection database create the first set of defaults is a properties object that contains the attributes that were set on the jdbc:derby: URL. This attributes properties set has the second default properties set as its default. This set (which could be null) contains the properties that the user set on their DriverManager.getConnection() call, and are thus not owned by Derby code, and thus must not be modified by Derby code. When create is false the properties object contains all the properties set in the service.properties file plus a limited number of attributes from the JDBC URL attributes or connection properties set. This avoids properties set by the user compromising the boot process. An example of a property passed in from the JDBC world is the bootPassword for encrypted databases. Code should not hold onto the passed in properties reference after boot time as its contents may change underneath it. At least after the complete boot is completed, the links to all the default sets will be removed. Parameters create:boolean True if the database should be created properties:Properties Configuration properties

boot

back to summary

public void boot(boolean create, Properties properties)

Implements org.apache.derby.iapi.services.monitor.ModuleControl.boot.

Doc from org.apache.derby.iapi.services.monitor.ModuleControl.boot.

Boot this module with the given properties. Creates a module instance that can be found using the findModule() methods of Monitor. The module can only be found using one of these findModule() methods once this method has returned.

An implementation's boot method can throw StandardException. If it is thrown the module is not registered by the monitor and therefore cannot be found through a findModule(). In this case the module's stop() method is not called, thus throwing this exception must free up any resources.

When create is true the contents of the properties object will be written to the service.properties of the persistent service. Thus any code that requires an entry in service.properties must explicitly place the value in this properties set using the put method.
Typically the properties object contains one or more default properties sets, which are not written out to service.properties. These default sets are how callers modify the create process. In a JDBC connection database create the first set of defaults is a properties object that contains the attributes that were set on the jdbc:derby: URL. This attributes properties set has the second default properties set as its default. This set (which could be null) contains the properties that the user set on their DriverManager.getConnection() call, and are thus not owned by Derby code, and thus must not be modified by Derby code.

When create is false the properties object contains all the properties set in the service.properties file plus a limited number of attributes from the JDBC URL attributes or connection properties set. This avoids properties set by the user compromising the boot process. An example of a property passed in from the JDBC world is the bootPassword for encrypted databases.

Code should not hold onto the passed in properties reference after boot time as its contents may change underneath it. At least after the complete boot is completed, the links to all the default sets will be removed.

Parameters

create:boolean: True if the database should be created
properties:Properties: Configuration properties

findStartStopMethods	back to summary
private void findStartStopMethods(final Class<?> serverClass) throws NoSuchMethodException Find the methods to start and shutdown the server. Perfomed through reflection so that the engine code is not dependent on the network server code.

getMonitor	back to summary
private static ModuleFactory getMonitor() Must be private so that user code can't call this entry point.

run	back to summary
public void run() Implements java.lang.Runnable.run. Doc from java.lang.Runnable.run. Runs this operation.

run

back to summary

public void run()

Implements java.lang.Runnable.run.

Doc from java.lang.Runnable.run.

Runs this operation.

setStartInfo	back to summary
public void setStartInfo(InetAddress listenAddress, int portNumber, String userName, String password, PrintWriter consoleWriter) Sets configuration information for the network server to be started. Parameters listenAddress:InetAddress InetAddress to listen on portNumber:int portNumber to listen on userName:String the user name for actions requiring authorization password:String the password for actions requiring authorization consoleWriter:PrintWriter the diagnostic log writer

setStartInfo

back to summary

public void setStartInfo(InetAddress listenAddress, int portNumber, String userName, String password, PrintWriter consoleWriter)

Sets configuration information for the network server to be started.

Parameters

listenAddress:InetAddress: InetAddress to listen on
portNumber:int: portNumber to listen on
userName:String: the user name for actions requiring authorization
password:String: the password for actions requiring authorization
consoleWriter:PrintWriter: the diagnostic log writer

setStartInfo	back to summary
public void setStartInfo(InetAddress listenAddress, int portNumber, PrintWriter consoleWriter)

stop	back to summary
public void stop() Implements org.apache.derby.iapi.services.monitor.ModuleControl.stop. Doc from org.apache.derby.iapi.services.monitor.ModuleControl.stop. Stop the module. The module may be found via a findModule() method until some time after this method returns. Therefore the factory must be prepared to reject requests to it once it has been stopped. In addition other modules may cache a reference to the module and make requests of it after it has been stopped, these requests should be rejected as well.

stop

back to summary

public void stop()

Implements org.apache.derby.iapi.services.monitor.ModuleControl.stop.

Doc from org.apache.derby.iapi.services.monitor.ModuleControl.stop.

Stop the module. The module may be found via a findModule() method until some time after this method returns. Therefore the factory must be prepared to reject requests to it once it has been stopped. In addition other modules may cache a reference to the module and make requests of it after it has been stopped, these requests should be rejected as well.

public final Class DRDAServerStarter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail