public interface TopicalLogger extends Logger
A TopicalLogger dispatches events to a set of Handlers. A TopicalLogger is a sort of message router.
A topic is associated with each TopicalLogger. A topic is represented by a dotted string, which is used to build a hierarchical namespace. The latter should typically be aligned with the Java packaging namespace.
The name hierarchy of TopicalLogger allows adding properties inheritance. For example, a TopicalLogger with the "a.b.c" name can inherit of the Handlers list and the level from the "a.b" parent.
Another property for a TopicalLogger is the capacity to have several topics. This is important when a component is used by several other components. This will allow events logged by the shared component to appear for each component using this shared component. A consequence of this property is that a Logger may have several parents
The additivity flag indicates if the current TopicalLogger inherits the handlers of its parents. The default value is true.
APPEND_MODE_ATTRIBUTE, BUFFER_ATTRIBUTE, CONSOLE_HANDLER_TYPE, FILE_HANDLER_TYPE, FILE_NUMBER_ATTRIBUTE, GENERIC_HANDLER_TYPE, JMX_HANDLER_TYPE, LEVEL_ATTRIBUTE, LOGGER_HANDLER_TYPE, MAX_SIZE_ATTRIBUTE, OUTPUT_ATTRIBUTE, PATTERN_ATTRIBUTE, ROLLING_FILE_HANDLER_TYPE
Modifier and Type | Method and Description |
---|---|
void |
addHandler(Handler h)
A TopicalLogger manages a list of Handler instances.
|
void |
addTopic(java.lang.String topic)
This method allows adding a topic to a TopicalLogger.
|
boolean |
getAdditivity()
It retrieves the additivity flag for this logger instance.
|
Handler[] |
getHandler()
It returns the list of the handler associated to this logger.
|
Handler |
getHandler(java.lang.String hn)
It returns the handler which the name is equals to the parameter
|
java.lang.String[] |
getTopic()
This method allows getting a topic list of this TopicalLogger.
|
java.util.Enumeration |
getTopics()
This method allows getting a topic list of this TopicalLogger.
|
void |
removeAllHandlers()
A TopicalLogger manages a list of Handler instances.
|
void |
removeHandler(Handler h)
A TopicalLogger manages a list of Handler instances.
|
void |
removeTopic(java.lang.String topic)
This method allows removing a topic to a TopicalLogger.
|
void |
setAdditivity(boolean a)
It assigns the additivity flag for this logger instance.
|
getCurrentIntLevel, getCurrentLevel, isLoggable, isLoggable, isOn, log, log, log, log, log, log, log, log, setIntLevel, setLevel, turnOff, turnOn
getAttribute, getAttributeNames, getName, getType, setAttribute, setName
void addHandler(Handler h) throws java.lang.Exception
java.lang.Exception
Handler[] getHandler()
Handler getHandler(java.lang.String hn)
void removeHandler(Handler h) throws java.lang.Exception
java.lang.Exception
void removeAllHandlers() throws java.lang.Exception
java.lang.Exception
void setAdditivity(boolean a)
boolean getAdditivity()
void addTopic(java.lang.String topic) throws java.lang.Exception
java.lang.Exception
java.lang.String[] getTopic()
java.util.Enumeration getTopics()
void removeTopic(java.lang.String topic) throws java.lang.Exception
java.lang.Exception