com.ibm.ras.mgr
Class RASManager
- java.lang.Object
com.ibm.ras.mgr.RASManager
Deprecated. As of WAS 6.0, recommend using java.util.logging
- public class RASManager
- extends java.lang.Object
- implements RASConstants, RASIManager
RASManager
is a manager of RAS objects. It is an
additional feature to the RAS Toolkit. That is, an application
can use the RAS Tookit without a RAS Manager by creating
all of the required toolkit objects in an application. This may be
suitable for "smaller" applications in which the trace state and output
device can be hard-coded, or passed to the application when it starts.
In more complex environments, an application can be written to use a
RAS Manager to acquire its RASLoggers
. This generally
lightens the load on the application programmer.
The RAS Manager can also provide RAS configuration information to a graphical program, which would allow an end-user or administrator to reconfigure the RAS system -- turning specific loggers on or off, for example.
The RAS Manager deals primarily in configuration data. That is, it must be told which RAS objects it can create, what their options are and how they are connected. When an object, such as a message logger, is requested by an application, the RAS Manager creates it from its configuration data and returns the object. Only one instance of a RAS object is created. This allows different applications, or components of a single application, to share RAS objects.
The RAS Manager configuration is organized as one or more "groups." Groups are a way for an application to distinguish its loggers and handlers from others that may be controlled by the RAS Manager. It is recommended that each application organize its loggers into one or more RAS groups. Handlers are usually considered to be system-wide resources and are, therfore, typically contained in the "base group."
This base group can also contain other groups. The RAS Manager thus implements a "flat tree" of groups. That is, groups may only be added to the base group. An application can impose a logical structure of groups within groups by carefully selecting group names. One way to do this is to use a naming scheme similar to Java package names. This would be very useful to a graphical program that wished to display RAS configurations to an end-user.
An application normally only uses the getMessageLogger
and getTraceLogger
methods. The RAS Manager will attach
to the logger any handlers which are included in the logger's
configuration and any formatters which are included in the handler's
configuration. The RAS Manager will search the group containing the
logger and then the base group for the handler configuration
information. If no handlers are included in the logger's
configuration, the RAS Manager will use the set of default handlers.
Formatter configurations are searched for in the same manner as
handler configurations.
In some environments, a RAS Manager may be able to get its
initial configuration from persistent storage (such as a properties
file or an LDAP database) and, possibly, save it there as well. This
medium is represented by the RASIDataStore
interface, whose
restoreConfig
and
saveConfig
methods
provide this function. Two examples of a RASIDataStore
are
provided in this package:
-
RASDefaultDataStore
assumes that no persistent store is available. TherestoreConfig
andsaveConfig
methods perform no function. -
RASPropertyDataStore
gets its configuration from a properties file of a specific format.
RASBaseGroup
and zero or more
RASGroups
and passing this to the
RAS Manager through the setBaseGroup
method.
However, the preferred approach is to use persistent storage.
Field Summary
Modifier and Type | Field and Description |
---|---|
|
dsLock
Deprecated. An object on which the manager can synchronize for data store
operations.
|
|
getMgrLock
Deprecated. An object on which the manager can synchronize when getting the
manager.
|
|
getObjLock
Deprecated. An object on which the manager can synchronize when getting a
RAS object such as a logger.
|
Constructor Summary
Modifier | Constructor and Description |
---|---|
|
RASManager(RASIDataStore store)
Deprecated. Creates a
RASManager .
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
addDataStore(RASIDataStore store)
Deprecated. Adds a
RASIDataStore to this manager.
|
|
addFormatters(RASIHandler handler,RASConfig cfg,RASGroup group)
Deprecated. Add formatters to a newly-created handler, according to the handler's
configuration.
|
|
addHandlers(RASILogger logger,RASConfig cfg,RASGroup group)
Deprecated. Add handlers to a logger, according to the logger's configuration.
|
|
finalize()
Deprecated. Clean up resources in use before the garbage collector destroys this
object.
|
getBaseGroup()
Deprecated. Gets the entire RAS configuration.
|
|
|
getDataStores()
Deprecated. Gets the data store objects in use by this manager.
|
getFormatter(java.lang.String name)
Deprecated. Gets a formatter from the base group.
|
|
getFormatter(java.lang.String name,RASGroup group)
Deprecated. Gets a formatter from a group.
|
|
getFormatter(java.lang.String name,java.lang.String groupName)
Deprecated. Gets a formatter from the named group.
|
|
getHandler(java.lang.String name)
Deprecated. Gets a handler from the base group.
|
|
getHandler(java.lang.String name,RASGroup group)
Deprecated. Gets a handler from a group.
|
|
getHandler(java.lang.String name,java.lang.String groupName)
Deprecated. Gets a handler from the named group.
|
|
|
getManager()
Deprecated. Gets the
RASManager .
|
|
getManager(RASIDataStore store)
Deprecated. Gets the
RASManager .
|
getMessageLogger(java.lang.String name)
Deprecated. Gets a message logger from the base group.
|
|
getMessageLogger(java.lang.String name,RASGroup group)
Deprecated. Gets a message logger from a group.
|
|
getMessageLogger(java.lang.String name,java.lang.String groupName)
Deprecated. Gets a message logger from the named group.
|
|
|
getObject(RASConfig cfg)
Deprecated. Gets a
RASObject from its configuration.
|
getTraceLogger(java.lang.String name)
Deprecated. Gets a trace logger from the base group.
|
|
getTraceLogger(java.lang.String name,RASGroup group)
Deprecated. Gets a trace logger from a group.
|
|
getTraceLogger(java.lang.String name,java.lang.String groupName)
Deprecated. Gets a trace logger from the named group.
|
|
|
removeDataStore(RASIDataStore store)
Deprecated. Removes a
RASIDataStore from this manager.
|
|
removeFormatters(RASIHandler handler,RASGroup group)
Deprecated. Removes formatters from a handler.
|
|
removeHandlers(RASILogger logger,RASGroup group)
Deprecated. Removes handlers from a logger.
|
|
restoreConfig()
Deprecated. Restores the
RASManager configuration from persistent
storage.
|
|
returnFormatter(RASIFormatter formatter)
Deprecated. Returns a formatter to its group.
|
|
returnFormatter(RASIFormatter formatter,RASGroup group)
Deprecated. Returns a formatter to a group.
|
|
returnFormatter(RASIFormatter formatter,java.lang.String groupName)
Deprecated. Returns a formatter to the named group.
|
|
returnHandler(RASIHandler handler)
Deprecated. Returns a handler to its group.
|
|
returnHandler(RASIHandler handler,RASGroup group)
Deprecated. Returns a handler to a group.
|
|
returnHandler(RASIHandler handler,java.lang.String groupName)
Deprecated. Returns a handler to the named group.
|
|
returnMessageLogger(RASIMessageLogger logger)
Deprecated. Returns a message logger to its group.
|
|
returnMessageLogger(RASIMessageLogger logger,RASGroup group)
Deprecated. Returns a message logger to a group.
|
|
returnMessageLogger(RASIMessageLogger logger,java.lang.String groupName)
Deprecated. Returns a message logger to the named group.
|
|
returnTraceLogger(RASITraceLogger logger)
Deprecated. Returns a trace logger to its group.
|
|
returnTraceLogger(RASITraceLogger logger,RASGroup group)
Deprecated. Returns a trace logger to a group.
|
|
returnTraceLogger(RASITraceLogger logger,java.lang.String groupName)
Deprecated. Returns a trace logger to the named group.
|
|
saveConfig()
Deprecated. Saves the
RASManager configuration to persistent
storage.
|
|
setBaseGroup(RASBaseGroup baseGroup)
Deprecated. Sets the entire RAS configuration.
|
Methods inherited from class java.lang.Object |
---|
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail
dsLock
- protected static final java.lang.Object dsLock
getMgrLock
- protected static final java.lang.Object getMgrLock
getObjLock
- protected static final java.lang.Object getObjLock
Constructor Detail
RASManager
- protected RASManager(RASIDataStore store)
RASManager
. This method is protected to
force applications to use the factory method getManager
.
store
- An object which implements the
RASIDataStore
interface. Method Detail
getManager
- public static RASManager getManager( )
RASManager
. If the RAS Manager has already been
created through a previous call to getManager
, that
manager is returned. Otherwise, a new manager is created and returned.
A manager created with this method has no data store from which it
can read a configuration. The addDataStore
method
can be used to add a data store to an existing manager.
getManager
- public static RASManager getManager( RASIDataStore store)
RASManager
. If the RAS Manager has already been
created through a previous call to getManager
, that
manager is returned. Otherwise, a new manager is created and returned.
store
- An object which implements the
RASIDataStore
interface. addDataStore
- public void addDataStore(RASIDataStore store)
RASIDataStore
to this manager. After adding
a data store, use restoreConfig
to restore the
configuration from the data store.
Only one data store is supported in this implementation. A new data store replaces the current store.
addDataStore
in interface RASIManager
store
- An object which implements the RASIDataStore
interface. removeDataStore
- public void removeDataStore(RASIDataStore store)
RASIDataStore
from this manager.
Only one data store is supported in this implementation. If the requested store is in use, it is removed. Otherwise, nothing is changed.
removeDataStore
in interface RASIManager
store
- An object which implements the RASIDataStore
interface. getDataStores
- public java.util.Enumeration getDataStores( )
Only one data store is supported in this implementation. It is
returned in a Vector
(to support future enhancements).
getDataStores
in interface RASIManager
Enumeration
of data stores. restoreConfig
- public void restoreConfig()
- throws RASIOException
RASManager
configuration from persistent
storage. If the RAS Manager has not been given a
RASIDataStore
to use, this method does nothing.
restoreConfig
in interface RASIManager
saveConfig
- public void saveConfig()
- throws RASIOException
RASManager
configuration to persistent
storage. If the RAS Manager has not been given a
RASIDataStore
to use, this method does nothing.
saveConfig
in interface RASIManager
getMessageLogger
- public RASIMessageLogger getMessageLogger( java.lang.String name)
If the logger configuration includes handlers, they will
automatically be attached to the logger. It should not be necessary
for an application to use the getHandler
method.
getMessageLogger
in interface RASIManager
name
- The name of the message logger. null
if the requested
logger was not found. getMessageLogger
- public RASIMessageLogger getMessageLogger( java.lang.String name,
- java.lang.String groupName)
If the logger configuration includes handlers, they will
automatically be attached to the logger. It should not be necessary
for an application to use the getHandler
method.
getMessageLogger
in interface RASIManager
name
- The name of the message logger. groupName
- The name of the RASGroup
. null
if the requested
logger was not found. getMessageLogger
- public RASIMessageLogger getMessageLogger( java.lang.String name,
- RASGroup group)
If the logger configuration includes handlers, they will
automatically be attached to the logger. It should not be necessary
for an application to use the getHandler
method.
getMessageLogger
in interface RASIManager
name
- The name of the message logger. group
- The RASGroup
. null
if the requested
logger was not found. returnMessageLogger
- public void returnMessageLogger( RASIMessageLogger logger)
null
, this method does nothing.
If the logger configuration includes handlers, they will
automatically be detached from the logger. It should not be necessary
for an application to use the returnHandler
method.
returnMessageLogger
in interface RASIManager
logger
- The logger being returned. returnMessageLogger
- public void returnMessageLogger( RASIMessageLogger logger,
- java.lang.String groupName)
null
, this method does
nothing.
If the logger configuration includes handlers, they will
automatically be detached from the logger. It should not be necessary
for an application to use the returnHandler
method.
returnMessageLogger
in interface RASIManager
returnMessageLogger
- public void returnMessageLogger( RASIMessageLogger logger,
- RASGroup group)
null
, this method does
nothing.
If the logger configuration includes handlers, they will
automatically be detached from the logger. It should not be necessary
for an application to use the returnHandler
method.
returnMessageLogger
in interface RASIManager
getTraceLogger
- public RASITraceLogger getTraceLogger( java.lang.String name)
If the logger configuration includes handlers, they will
automatically be attached to the logger. It should not be necessary
for an application to use the getHandler
method.
getTraceLogger
in interface RASIManager
name
- The name of the trace logger. null
if the requested
logger was not found. getTraceLogger
- public RASITraceLogger getTraceLogger( java.lang.String name,
- java.lang.String groupName)
If the logger configuration includes handlers, they will
automatically be attached to the logger. It should not be necessary
for an application to use the getHandler
method.
getTraceLogger
in interface RASIManager
name
- The name of the trace logger. groupName
- The name of the RASGroup
. null
if the requested
logger was not found. getTraceLogger
- public RASITraceLogger getTraceLogger( java.lang.String name,
- RASGroup group)
If the logger configuration includes handlers, they will
automatically be attached to the logger. It should not be necessary
for an application to use the getHandler
method.
getTraceLogger
in interface RASIManager
name
- The name of the trace logger. group
- The RASGroup
. null
if the requested
logger was not found. returnTraceLogger
- public void returnTraceLogger(RASITraceLogger logger)
null
, this method does nothing.
If the logger configuration includes handlers, they will
automatically be detached from the logger. It should not be necessary
for an application to use the returnHandler
method.
returnTraceLogger
in interface RASIManager
logger
- The logger being returned. returnTraceLogger
- public void returnTraceLogger(RASITraceLogger logger,
- java.lang.String groupName)
null
, this method does
nothing.
If the logger configuration includes handlers, they will
automatically be detached from the logger. It should not be necessary
for an application to use the returnHandler
method.
returnTraceLogger
in interface RASIManager
returnTraceLogger
- public void returnTraceLogger(RASITraceLogger logger,
- RASGroup group)
null
, this method does
nothing.
If the logger configuration includes handlers, they will
automatically be detached from the logger. It should not be necessary
for an application to use the returnHandler
method.
returnTraceLogger
in interface RASIManager
getHandler
- public RASIHandler getHandler(java.lang.String name)
If the logger configuration includes handlers, they will
automatically be attached to the logger. It should not be necessary
for an application to use the getHandler
method.
getHandler
in interface RASIManager
name
- The name of the handler. null
if the requested
handler was not found. getHandler
- public RASIHandler getHandler(java.lang.String name,
- java.lang.String groupName)
If the logger configuration includes handlers, they will
automatically be attached to the logger. It should not be necessary
for an application to use the getHandler
method.
getHandler
in interface RASIManager
name
- The name of the handler. groupName
- The name of the RASGroup
. null
if the requested
handler was not found. getHandler
- public RASIHandler getHandler(java.lang.String name,
- RASGroup group)
If the logger configuration includes handlers, they will
automatically be attached to the logger. It should not be necessary
for an application to use the getHandler
method.
getHandler
in interface RASIManager
name
- The name of the handler. group
- The RASGroup
. null
if the requested
handler was not found. returnHandler
- public void returnHandler(RASIHandler handler)
null
, this method does nothing.
If the logger configuration includes handlers, they will
automatically be detached from the logger. It should not be necessary
for an application to use the returnHandler
method.
returnHandler
in interface RASIManager
handler
- The handler being returned. returnHandler
- public void returnHandler(RASIHandler handler,
- java.lang.String groupName)
null
, this method does
nothing.
If the logger configuration includes handlers, they will
automatically be detached from the logger. It should not be necessary
for an application to use the returnHandler
method.
returnHandler
in interface RASIManager
returnHandler
- public void returnHandler(RASIHandler handler,
- RASGroup group)
null
, this method does
nothing.
If the logger configuration includes handlers, they will
automatically be detached from the logger. It should not be necessary
for an application to use the returnHandler
method.
returnHandler
in interface RASIManager
getFormatter
- public RASIFormatter getFormatter( java.lang.String name)
If the handler configuration includes formatters, they will
automatically be attached to the handler. It should not be necessary
for an application to use the getFormatter
method.
getFormatter
in interface RASIManager
name
- The name of the formatter. null
if the requested
formatter was not found. getFormatter
- public RASIFormatter getFormatter( java.lang.String name,
- java.lang.String groupName)
If the handler configuration includes formatters, they will
automatically be attached to the handler. It should not be necessary
for an application to use the getFormatter
method.
getFormatter
in interface RASIManager
name
- The name of the formatter. groupName
- The name of the RASGroup
. null
if the requested
formatter was not found. getFormatter
- public RASIFormatter getFormatter( java.lang.String name,
- RASGroup group)
If the handler configuration includes formatters, they will
automatically be attached to the handler. It should not be necessary
for an application to use the getFormatter
method.
getFormatter
in interface RASIManager
name
- The name of the formatter. group
- The RASGroup
. null
if the requested
formatter was not found. returnFormatter
- public void returnFormatter(RASIFormatter formatter)
null
, this method does nothing.
If the handler configuration includes formatters, they will
automatically be detached from the handler. It should not be necessary
for an application to use the returnFormatter
method.
returnFormatter
in interface RASIManager
formatter
- The formatter being returned. returnFormatter
- public void returnFormatter(RASIFormatter formatter,
- java.lang.String groupName)
null
, this method does
nothing.
If the handler configuration includes formatters, they will
automatically be detached from the handler. It should not be necessary
for an application to use the returnFormatter
method.
returnFormatter
in interface RASIManager
returnFormatter
- public void returnFormatter(RASIFormatter formatter,
- RASGroup group)
null
, this method does
nothing.
If the handler configuration includes formatters, they will
automatically be detached from the handler. It should not be necessary
for an application to use the returnFormatter
method.
returnFormatter
in interface RASIManager
getBaseGroup
- public RASBaseGroup getBaseGroup( )
getBaseGroup
in interface RASIManager
setBaseGroup
- public void setBaseGroup(RASBaseGroup baseGroup)
setBaseGroup
in interface RASIManager
baseGroup
- The base RAS group containing the entire configuration. getObject
RASObject
from its configuration. If the object
has been created already, it is returned. If not, a new object is
instantiated and returned.
cfg
- The configuration of the object. null
if the requested
object was not found. addHandlers
- protected void addHandlers(RASILogger logger,
- RASConfig cfg,
- RASGroup group)
logger
- The RAS logger. cfg
- The RAS logger configuration. group
- The RASGroup
in which the logger configuration
was found. removeHandlers
- protected void removeHandlers(RASILogger logger,
- RASGroup group)
logger
- The RAS logger. group
- The RASGroup
in which the logger
configuration was found. addFormatters
- protected void addFormatters(RASIHandler handler,
- RASConfig cfg,
- RASGroup group)
handler
- The RAS handler. cfg
- The RAS handler configuration. group
- The RASGroup
in which the handler
configuration was found. removeFormatters
- protected void removeFormatters( RASIHandler handler,
- RASGroup group)
handler
- The RAS handler. group
- The RASGroup
in which the handler
configuration was found. finalize
- protected void finalize()
- throws java.lang.Throwable
finalize
in class java.lang.Object
java.lang.Throwable