Package org.apache.derby.iapi.jdbc

Class DRDAServerStarter

  • All Implemented Interfaces:
    java.lang.Runnable, ModuleControl
    public final class DRDAServerStarter
extends java.lang.Object
implements ModuleControl, java.lang.Runnable
    Class that starts the network server in its own daemon thread. Works in two situations.
    As a module in the engine's Monitor, booted if the property derby.drda.startNetworkServer is set to true. In this case the boot and shutdown is through the standard ModuleControl methods.
    Direct calls from the NetworkServerControlImpl start methods. This is to centralize the creation of the daemon thread in this class in the engine code, since the Monitor provides the thread. This means that NetworkServerControlImpl calls this class to create a thread which in turn calls back to NetworkServerControlImpl.runServer to start the server.
    See Also:
    ModuleControl.boot(boolean, java.util.Properties), ModuleControl.stop()

    • Field Summary

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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void boot​(boolean create, java.util.Properties properties)
      Boot this module with the given properties.
      private void findStartStopMethods​(java.lang.Class<?> serverClass)
      Find the methods to start and shutdown the server.
      private static ModuleFactory getMonitor()
      Privileged Monitor lookup.
      void run()  
      void setStartInfo​(java.net.InetAddress listenAddress, int portNumber, java.io.PrintWriter consoleWriter)  
      void setStartInfo​(java.net.InetAddress listenAddress, int portNumber, java.lang.String userName, java.lang.String password, java.io.PrintWriter consoleWriter)
      Sets configuration information for the network server to be started.
      void stop()
      Stop the module.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • server

        private java.lang.Object server
        The instance of the NetworkServerControlImpl being used to run the server.

      • runServerMethod

        private java.lang.reflect.Method runServerMethod
        Reflect reference to the method to run the server. NetworkServerControlImpl.blockingStart

      • serverShutdownMethod

        private java.lang.reflect.Method serverShutdownMethod
        Reflect reference to the method to directly shutdown the server. NetworkServerControlImpl.directShutdown

      • serverThread

        private java.lang.Thread serverThread

      • serverClass

        private java.lang.Class<?> serverClass

      • listenAddress

        private java.net.InetAddress listenAddress

      • portNumber

        private int portNumber

      • userArg

        private java.lang.String userArg

      • passwordArg

        private java.lang.String passwordArg

      • consoleWriter

        private java.io.PrintWriter consoleWriter

    • Constructor Detail

      • DRDAServerStarter

        public DRDAServerStarter()

    • Method Detail

      • setStartInfo

        public void setStartInfo​(java.net.InetAddress listenAddress,
                         int portNumber,
                         java.lang.String userName,
                         java.lang.String password,
                         java.io.PrintWriter consoleWriter)
        Sets configuration information for the network server to be started.
        Parameters:
        listenAddress - InetAddress to listen on
        portNumber - portNumber to listen on
        userName - the user name for actions requiring authorization
        password - the password for actions requiring authorization

      • setStartInfo

        public void setStartInfo​(java.net.InetAddress listenAddress,
                         int portNumber,
                         java.io.PrintWriter consoleWriter)

      • findStartStopMethods

        private void findStartStopMethods​(java.lang.Class<?> serverClass)
                           throws java.lang.SecurityException,
                                  java.lang.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.
        Parameters:
        serverClass -
        Throws:
        java.lang.NoSuchMethodException
        java.lang.SecurityException

      • boot

        public void boot​(boolean create,
                 java.util.Properties properties)
        Description copied from interface: ModuleControl
        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.

        Specified by:
        boot in interface ModuleControl
        See Also:
        Monitor, ModuleFactory

      • run

        public void run()
        Specified by:
        run in interface java.lang.Runnable

      • stop

        public void stop()
        Description copied from interface: ModuleControl
        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.
        Specified by:
        stop in interface ModuleControl
        See Also:
        Monitor, ModuleFactory

      • getMonitor

        private static ModuleFactory getMonitor()
        Privileged Monitor lookup. Must be private so that user code can't call this entry point.