|
|||||||||
| Home >> All >> org >> apache >> derby >> impl >> services >> [ stream overview ] | PREV CLASS NEXT CLASS | ||||||||
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD |
DETAIL: FIELD | CONSTR | METHOD | ||||||||
org.apache.derby.impl.services.stream
Class SingleStream
java.lang.Objectorg.apache.derby.impl.services.stream.SingleStream
- All Implemented Interfaces:
- org.apache.derby.iapi.services.stream.InfoStreams, org.apache.derby.iapi.services.monitor.ModuleControl, java.security.PrivilegedAction
- public class SingleStream
- extends java.lang.Object
- implements org.apache.derby.iapi.services.stream.InfoStreams, org.apache.derby.iapi.services.monitor.ModuleControl, java.security.PrivilegedAction
- extends java.lang.Object
The Basic Services provide InfoStreams for reporting information. Two streams are provided: trace and error. It is configurable where these streams are directed.
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)
| Field Summary | |
private java.lang.String |
PBfileName
|
private org.apache.derby.iapi.services.stream.PrintWriterGetHeader |
PBheader
|
private org.apache.derby.iapi.services.stream.HeaderPrintWriter |
theStream
|
| Constructor Summary | |
SingleStream()
The no-arg public constructor for ModuleControl's use. |
|
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
theStream
private org.apache.derby.iapi.services.stream.HeaderPrintWriter theStream
PBfileName
private java.lang.String PBfileName
PBheader
private org.apache.derby.iapi.services.stream.PrintWriterGetHeader PBheader
| Constructor Detail |
SingleStream
public SingleStream()
- The no-arg public constructor for ModuleControl's use.
| Method Detail |
boot
public void boot(boolean create,
java.util.Properties properties)
- Description copied from interface:
org.apache.derby.iapi.services.monitor.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 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.
- Specified by:
bootin interfaceorg.apache.derby.iapi.services.monitor.ModuleControl
stop
public void stop()
- Description copied from interface:
org.apache.derby.iapi.services.monitor.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:
stopin interfaceorg.apache.derby.iapi.services.monitor.ModuleControl
stream
public org.apache.derby.iapi.services.stream.HeaderPrintWriter stream()
- Description copied from interface:
org.apache.derby.iapi.services.stream.InfoStreams - Return the default stream. If the default stream could not be set up as requested then
it points indirectly to System.err.
- Specified by:
streamin interfaceorg.apache.derby.iapi.services.stream.InfoStreams
makeStream
private org.apache.derby.iapi.services.stream.HeaderPrintWriter makeStream()
- Make the stream; note that service properties override
application and system properties.
makeHeader
private org.apache.derby.iapi.services.stream.PrintWriterGetHeader makeHeader()
- Return a new header object.
makeHPW
private org.apache.derby.iapi.services.stream.HeaderPrintWriter makeHPW(org.apache.derby.iapi.services.stream.PrintWriterGetHeader header)
- create a HeaderPrintWriter based on the header.
Will still need to determine the target type.
PBmakeFileHPW
private org.apache.derby.iapi.services.stream.HeaderPrintWriter PBmakeFileHPW(java.lang.String fileName, org.apache.derby.iapi.services.stream.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.
makeMethodHPW
private org.apache.derby.iapi.services.stream.HeaderPrintWriter makeMethodHPW(java.lang.String methodInvocation, org.apache.derby.iapi.services.stream.PrintWriterGetHeader header)
makeFieldHPW
private org.apache.derby.iapi.services.stream.HeaderPrintWriter makeFieldHPW(java.lang.String fieldAccess, org.apache.derby.iapi.services.stream.PrintWriterGetHeader header)
makeValueHPW
private org.apache.derby.iapi.services.stream.HeaderPrintWriter makeValueHPW(java.lang.reflect.Member whereFrom, java.lang.Object value, org.apache.derby.iapi.services.stream.PrintWriterGetHeader header, java.lang.String name)
createDefaultStream
private org.apache.derby.iapi.services.stream.HeaderPrintWriter createDefaultStream(org.apache.derby.iapi.services.stream.PrintWriterGetHeader header)
- Used when no configuration information exists for a stream.
useDefaultStream
private org.apache.derby.iapi.services.stream.HeaderPrintWriter useDefaultStream(org.apache.derby.iapi.services.stream.PrintWriterGetHeader header)
- Used when creating a stream creates an error.
useDefaultStream
private org.apache.derby.iapi.services.stream.HeaderPrintWriter useDefaultStream(org.apache.derby.iapi.services.stream.PrintWriterGetHeader header, java.lang.Throwable t)
makeFileHPW
private org.apache.derby.iapi.services.stream.HeaderPrintWriter makeFileHPW(java.lang.String fileName, org.apache.derby.iapi.services.stream.PrintWriterGetHeader header)
run
public final java.lang.Object run()
- Description copied from interface:
java.security.PrivilegedAction - This method performs an operation that requires higher privileges to
perform. It is called when a section of code invokes
AccessController.doPrivileged().- Specified by:
runin interfacejava.security.PrivilegedAction
|
|||||||||
| Home >> All >> org >> apache >> derby >> impl >> services >> [ stream overview ] | PREV CLASS NEXT CLASS | ||||||||
|
SUMMARY: JAVADOC | SOURCE | DOWNLOAD | NESTED | FIELD | CONSTR | METHOD |
DETAIL: FIELD | CONSTR | METHOD | ||||||||