Apache Derby Database Engine and Embedded JDBC Driver 10.17.1.0 · org.apache.derby.impl.services.stream.SingleStream

Modifier and Type	Field and Description
private String	PBfileName
private PrintWriterGetHeader	PBheader
private HeaderPrintWriter	theStream

Access	Constructor and Description
public	SingleStream() The no-arg public constructor for ModuleControl's use.

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 HeaderPrintWriter	createDefaultStream(PrintWriterGetHeader header) Used when no configuration information exists for a stream.
private static ModuleFactory	getMonitor() Must be private so that user code can't call this entry point.
private HeaderPrintWriter	makeFieldHPW(String fieldAccess, PrintWriterGetHeader header)
private HeaderPrintWriter	makeFileHPW(String fileName, PrintWriterGetHeader header)
private PrintWriterGetHeader	makeHeader() Return a new header object.
private HeaderPrintWriter	makeHPW(PrintWriterGetHeader header) create a HeaderPrintWriter based on the header.
private HeaderPrintWriter	makeMethodHPW(String methodInvocation, PrintWriterGetHeader header, boolean canClose)
private HeaderPrintWriter	makeStream() Make the stream; note that service properties override application and system properties.
private HeaderPrintWriter	makeStyleHPW(String style, PrintWriterGetHeader header)
private HeaderPrintWriter	makeValueHPW(Member whereFrom, Object value, PrintWriterGetHeader header, String name, boolean canClose)
private HeaderPrintWriter	PBmakeFileHPW(String fileName, PrintWriterGetHeader header) Make a header print writer out of a file name.
public final HeaderPrintWriter	run()
public void	stop() Implements org.apache.derby.iapi.services.monitor.ModuleControl.stop. Stop the module.
public HeaderPrintWriter	stream() Implements org.apache.derby.shared.common.stream.InfoStreams.stream. Return the default stream.
private HeaderPrintWriter	useDefaultStream(PrintWriterGetHeader header) Used when creating a stream creates an error.
private HeaderPrintWriter	useDefaultStream(PrintWriterGetHeader header, Throwable t)

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

PBfileName	back to summary
private String PBfileName

PBheader	back to summary
private PrintWriterGetHeader PBheader

theStream	back to summary
private HeaderPrintWriter theStream

SingleStream	back to summary
public SingleStream() The no-arg public constructor for ModuleControl's use.

Method Detail

boot back to summary

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 See Also `org.apache.derby.iapi.services.monitor.ModuleControl#boot`

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

createDefaultStream	back to summary
private HeaderPrintWriter createDefaultStream(PrintWriterGetHeader header) Used when no configuration information exists for a stream.

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

makeFieldHPW	back to summary
private HeaderPrintWriter makeFieldHPW(String fieldAccess, PrintWriterGetHeader header)

makeFileHPW	back to summary
private HeaderPrintWriter makeFileHPW(String fileName, PrintWriterGetHeader header)

makeHeader	back to summary
private PrintWriterGetHeader makeHeader() Return a new header object.

makeHPW	back to summary
private HeaderPrintWriter makeHPW(PrintWriterGetHeader header) create a HeaderPrintWriter based on the header. Will still need to determine the target type.

makeMethodHPW	back to summary
private HeaderPrintWriter makeMethodHPW(String methodInvocation, PrintWriterGetHeader header, boolean canClose)

makeStream	back to summary
private HeaderPrintWriter makeStream() Make the stream; note that service properties override application and system properties.

makeStyleHPW	back to summary
private HeaderPrintWriter makeStyleHPW(String style, PrintWriterGetHeader header)

makeValueHPW	back to summary
private HeaderPrintWriter makeValueHPW(Member whereFrom, Object value, PrintWriterGetHeader header, String name, boolean canClose)

PBmakeFileHPW	back to summary
private HeaderPrintWriter PBmakeFileHPW(String fileName, PrintWriterGetHeader header) Make a header print writer out of a file name. If it is a relative path name then it is taken as relative to derby.system.home if that is set, otherwise relative to the current directory. If the path name is absolute then it is taken as absolute.

run	back to summary
public final HeaderPrintWriter run()

stop back to summary

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. See Also `org.apache.derby.iapi.services.monitor.ModuleControl#stop`

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.

See Also: org.apache.derby.iapi.services.monitor.ModuleControl#stop

stream back to summary

stream	back to summary
public HeaderPrintWriter stream() Implements org.apache.derby.shared.common.stream.InfoStreams.stream. Doc from org.apache.derby.shared.common.stream.InfoStreams.stream. Return the default stream. If the default stream could not be set up as requested then it points indirectly to System.err. Returns:HeaderPrintWriter the default stream. See Also `org.apache.derby.shared.common.stream.InfoStreams#stream`

public HeaderPrintWriter stream()

Implements org.apache.derby.shared.common.stream.InfoStreams.stream.

Doc from org.apache.derby.shared.common.stream.InfoStreams.stream.

Return the default stream. If the default stream could not be set up as requested then it points indirectly to System.err.

Returns:HeaderPrintWriter: the default stream.
See Also: org.apache.derby.shared.common.stream.InfoStreams#stream

useDefaultStream	back to summary
private HeaderPrintWriter useDefaultStream(PrintWriterGetHeader header) Used when creating a stream creates an error.

useDefaultStream	back to summary
private HeaderPrintWriter useDefaultStream(PrintWriterGetHeader header, Throwable t)

public final Class SingleStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail