org.apache.derby.iapi.services.monitor
Interface ModuleControl

All Known Implementing Classes:
AuthenticationServiceBase, B2IFactory, BaseDataFileFactory, BasicDatabase, BCJava, DatabaseClasses, DataDictionaryImpl, DRDAServerStarter, Driver169, ExternalSortFactory, GenericExecutionFactory, GenericLanguageConnectionFactory, GenericLanguageFactory, HeapConglomerateFactory, JCECipherFactory, LogToFile, NodeFactoryImpl, OptimizerFactoryImpl, RAMAccessManager, RawStore, ResourceAdapterImpl, SingleStream, XactFactory

public interface ModuleControl

ModuleControl is optionally implemented by a module's factory class.


Method Summary
 void boot(boolean create, java.util.Properties properties)
          Boot this module with the given properties.
 void stop()
          Stop the module.
 

Method Detail

boot

public void boot(boolean create,
                 java.util.Properties properties)
          throws StandardException
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 cloudscape code, and thus must not be modified by cloudscape 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.

Throws:
StandardException - Module cannot be started.
See Also:
Monitor, ModuleFactory

stop

public void 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.

See Also:
Monitor, ModuleFactory


Apache Derby V10.0 Engine Documentation - Copyright © 1997,2004 The Apache Software Foundation or its licensors, as applicable.