java.security.PrivilegedAction<HeaderPrintWriter>
, ModuleControl
, InfoStreams
public final class SingleStream extends java.lang.Object implements InfoStreams, ModuleControl, java.security.PrivilegedAction<HeaderPrintWriter>
Errors will be printed to the error stream in addition to being sent to the client.
By default both streams are sent to an error log for the system. When creating a message for a stream, you can create an initial entry with header information and then append to it as many times as desired.
Note: if character encodings are needed, the use of java.io.*OutputStream's should be replaced with java.io.*Writer's (assuming the Writer interface remains stable in JDK1.1)
Modifier and Type | Field | Description |
---|---|---|
private java.lang.String |
PBfileName |
|
private PrintWriterGetHeader |
PBheader |
|
private HeaderPrintWriter |
theStream |
Constructor | Description |
---|---|
SingleStream() |
The no-arg public constructor for ModuleControl's use.
|
Modifier and Type | Method | Description |
---|---|---|
void |
boot(boolean create,
java.util.Properties properties) |
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() |
Privileged Monitor lookup.
|
private HeaderPrintWriter |
makeFieldHPW(java.lang.String fieldAccess,
PrintWriterGetHeader header) |
|
private HeaderPrintWriter |
makeFileHPW(java.lang.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(java.lang.String methodInvocation,
PrintWriterGetHeader header,
boolean canClose) |
|
private HeaderPrintWriter |
makeStream() |
Make the stream; note that service properties override
application and system properties.
|
private HeaderPrintWriter |
makeStyleHPW(java.lang.String style,
PrintWriterGetHeader header) |
|
private HeaderPrintWriter |
makeValueHPW(java.lang.reflect.Member whereFrom,
java.lang.Object value,
PrintWriterGetHeader header,
java.lang.String name,
boolean canClose) |
|
private HeaderPrintWriter |
PBmakeFileHPW(java.lang.String fileName,
PrintWriterGetHeader header) |
Make a header print writer out of a file name.
|
HeaderPrintWriter |
run() |
|
void |
stop() |
Stop the module.
|
HeaderPrintWriter |
stream() |
Return the default stream.
|
private HeaderPrintWriter |
useDefaultStream(PrintWriterGetHeader header) |
Used when creating a stream creates an error.
|
private HeaderPrintWriter |
useDefaultStream(PrintWriterGetHeader header,
java.lang.Throwable t) |
private HeaderPrintWriter theStream
private java.lang.String PBfileName
private PrintWriterGetHeader PBheader
public SingleStream()
public void boot(boolean create, java.util.Properties properties)
ModuleControl
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.
boot
in interface ModuleControl
ModuleControl.boot(boolean, java.util.Properties)
public void stop()
ModuleControl
stop
in interface ModuleControl
ModuleControl.stop()
public HeaderPrintWriter stream()
InfoStreams
stream
in interface InfoStreams
InfoStreams.stream()
private HeaderPrintWriter makeStream()
private PrintWriterGetHeader makeHeader()
private HeaderPrintWriter makeHPW(PrintWriterGetHeader header)
private HeaderPrintWriter PBmakeFileHPW(java.lang.String fileName, PrintWriterGetHeader header)
private HeaderPrintWriter makeMethodHPW(java.lang.String methodInvocation, PrintWriterGetHeader header, boolean canClose)
private HeaderPrintWriter makeStyleHPW(java.lang.String style, PrintWriterGetHeader header)
private HeaderPrintWriter makeFieldHPW(java.lang.String fieldAccess, PrintWriterGetHeader header)
private HeaderPrintWriter makeValueHPW(java.lang.reflect.Member whereFrom, java.lang.Object value, PrintWriterGetHeader header, java.lang.String name, boolean canClose)
private HeaderPrintWriter createDefaultStream(PrintWriterGetHeader header)
private HeaderPrintWriter useDefaultStream(PrintWriterGetHeader header)
private HeaderPrintWriter useDefaultStream(PrintWriterGetHeader header, java.lang.Throwable t)
private HeaderPrintWriter makeFileHPW(java.lang.String fileName, PrintWriterGetHeader header)
public final HeaderPrintWriter run()
run
in interface java.security.PrivilegedAction<HeaderPrintWriter>
private static ModuleFactory getMonitor()
Apache Derby V10.14 Internals - Copyright © 2004,2018 The Apache Software Foundation. All Rights Reserved.