org.objectweb.util.monolog.wrapper.log4jMini

Class MonologCategory

Implemented Interfaces:
Handler, Logger, TopicalLogger

public class MonologCategory
extends java.lang.Object
implements TopicalLogger

Copyright (C) 2001-2003 France Telecom R&D This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Nested Class Summary

class
MonologCategory.OwPriority

Field Summary

protected Category
category
protected boolean
enable
protected Hashtable
handlers
protected MonologCategory.OwPriority
interPriority

Fields inherited from interface org.objectweb.util.monolog.api.Handler

APPEND_MODE_ATTRIBUTE, BUFFER_ATTRIBUTE, CONSOLE_HANDLER_TYPE, FILE_HANDLER_TYPE, FILE_NUMBER_ATTRIBUTE, GENERIC_HANDLER_TYPE, LEVEL_ATTRIBUTE, LOGGER_HANDLER_TYPE, MAX_SIZE_ATTRIBUTE, OUTPUT_ATTRIBUTE, PATTERN_ATTRIBUTE, ROLLING_FILE_HANDLER_TYPE

Constructor Summary

MonologCategory(Category category)

Method Summary

void
addHandler(Handler h)
Add a handler in the Handler list of the topicalLogger
void
addTopic(String topic)
Add a topic to the topicalLogger
boolean
getAdditivity()
It retrieves the additivity flag for this logger instance.
Object
getAttribute(String name)
It retrieves the value of an attribute value of the handler.
String[]
getAttributeNames()
It retrieves the attributes of the handler
int
getCurrentIntLevel()
Return the current Level of the logger
Level
getCurrentLevel()
Returns the current level value under the Level format
Handler[]
getHandler()
It returns the list of the handler associated to this logger.
Handler
getHandler(String hn)
It returns the handler which the name is equals to the parameter
String
getName()
It retrieves the name of the handler
String[]
getTopic()
This method allows getting a topic list of this TopicalLogger.
Enumeration
getTopics()
Returns the list of the different names of the topicalLogger
String
getType()
It retrieves the Handler type
boolean
isLoggable(int level)
Check if the level parameter are not filtered by the logger
boolean
isLoggable(Level l)
Check if a message of the given level would actually be logged by this logger.
boolean
isOn()
Is the handler enabled
void
log(int level, Object o)
Log an object with a specific level.
void
log(int level, Object o, Object location, Object method)
Log an object and a trowable with a specific level.
void
log(int level, Object o, Throwable t)
Log an object and a trowable with a specific level.
void
log(int level, Object o, Throwable t, Object location, Object method)
Log an object and a trowable with a specific level.
void
log(Level l, Object o)
Log a message, with no arguments.
void
log(Level l, Object o, Object location, Object method)
Log a message, with a location and method arguments.
void
log(Level l, Object o, Throwable t)
Log a message, with a throwable arguments which can represent an error or a context..
void
log(Level l, Object o, Throwable t, Object location, Object method)
Log a message, with a location, method and throwable arguments.
void
removeAllHandlers()
A TopicalLogger manages a list of Handler instances.
void
removeHandler(Handler h)
Remove a handler from the Handler list of the topicalLogger
void
removeTopic(String topic)
Remove a topic from the topicalLogger
void
setAdditivity(boolean a)
It assigns the additivity flag for this logger instance.
Object
setAttribute(String name, Object value)
It assigns an attributte to the handler.
void
setIntLevel(int level)
Set the current level of the logger
void
setLevel(Level l)
Permits to set the level with a Level instance.
void
setName(String name)
It assigns the name of the handler
void
turnOff()
Disable the handler
void
turnOn()
Enable the handler

Field Details

category

protected Category category


enable

protected boolean enable


handlers

protected Hashtable handlers


interPriority

protected MonologCategory.OwPriority interPriority

Constructor Details

MonologCategory

public MonologCategory(Category category)

Method Details

addHandler

public void addHandler(Handler h)
            throws Exception
Add a handler in the Handler list of the topicalLogger
Specified by:
addHandler in interface TopicalLogger


addTopic

public void addTopic(String topic)
            throws Exception
Add a topic to the topicalLogger
Specified by:
addTopic in interface TopicalLogger


getAdditivity

public boolean getAdditivity()
It retrieves the additivity flag for this logger instance.
Specified by:
getAdditivity in interface TopicalLogger


getAttribute

public Object getAttribute(String name)
It retrieves the value of an attribute value of the handler.
Specified by:
getAttribute in interface Handler

Parameters:
name - is an attribute name


getAttributeNames

public String[] getAttributeNames()
It retrieves the attributes of the handler
Specified by:
getAttributeNames in interface Handler


getCurrentIntLevel

public int getCurrentIntLevel()
Return the current Level of the logger
Specified by:
getCurrentIntLevel in interface Logger


getCurrentLevel

public Level getCurrentLevel()
Returns the current level value under the Level format
Specified by:
getCurrentLevel in interface Logger


getHandler

public Handler[] getHandler()
It returns the list of the handler associated to this logger.
Specified by:
getHandler in interface TopicalLogger

Returns:
an array of Handler or an empty array.


getHandler

public Handler getHandler(String hn)
It returns the handler which the name is equals to the parameter
Specified by:
getHandler in interface TopicalLogger

Returns:
an Handler or a null value.


getName

public String getName()
It retrieves the name of the handler
Specified by:
getName in interface Handler


getTopic

public String[] getTopic()
This method allows getting a topic list of this TopicalLogger.
Specified by:
getTopic in interface TopicalLogger


getTopics

public Enumeration getTopics()
Returns the list of the different names of the topicalLogger
Specified by:
getTopics in interface TopicalLogger


getType

public String getType()
It retrieves the Handler type
Specified by:
getType in interface Handler


isLoggable

public boolean isLoggable(int level)
Check if the level parameter are not filtered by the logger
Specified by:
isLoggable in interface Logger


isLoggable

public boolean isLoggable(Level l)
Check if a message of the given level would actually be logged by this logger.
Specified by:
isLoggable in interface Logger


isOn

public boolean isOn()
Is the handler enabled
Specified by:
isOn in interface Logger


log

public void log(int level,
                Object o)
Log an object with a specific level. If the level parameter is loggable the object is handled.
Specified by:
log in interface Logger


log

public void log(int level,
                Object o,
                Object location,
                Object method)
Log an object and a trowable with a specific level. This method permits to specify an object instance and a method.
Specified by:
log in interface Logger


log

public void log(int level,
                Object o,
                Throwable t)
Log an object and a trowable with a specific level.
Specified by:
log in interface Logger


log

public void log(int level,
                Object o,
                Throwable t,
                Object location,
                Object method)
Log an object and a trowable with a specific level. This method permits to specify an object instance and a method.
Specified by:
log in interface Logger


log

public void log(Level l,
                Object o)
Log a message, with no arguments. If the logger is currently enabled for the given message level then the given message is treated
Specified by:
log in interface Logger


log

public void log(Level l,
                Object o,
                Object location,
                Object method)
Log a message, with a location and method arguments. The location parameter can be the object instance which logs the event, or a string representation of the object. The method argument can be a java.lang.reflect.Method or a string which represents the method name.
Specified by:
log in interface Logger


log

public void log(Level l,
                Object o,
                Throwable t)
Log a message, with a throwable arguments which can represent an error or a context..
Specified by:
log in interface Logger


log

public void log(Level l,
                Object o,
                Throwable t,
                Object location,
                Object method)
Log a message, with a location, method and throwable arguments. The location parameter can be the object instance which logs the event, or a string representation of the object.. The method argument can be a java.lang.reflect.Method or a string which represents the method name. The throwable parameter permits to log an Exception.
Specified by:
log in interface Logger


removeAllHandlers

public void removeAllHandlers()
            throws Exception
A TopicalLogger manages a list of Handler instances. This method allows removing all handler.
Specified by:
removeAllHandlers in interface TopicalLogger


removeHandler

public void removeHandler(Handler h)
            throws Exception
Remove a handler from the Handler list of the topicalLogger
Specified by:
removeHandler in interface TopicalLogger


removeTopic

public void removeTopic(String topic)
            throws Exception
Remove a topic from the topicalLogger
Specified by:
removeTopic in interface TopicalLogger


setAdditivity

public void setAdditivity(boolean a)
It assigns the additivity flag for this logger instance.
Specified by:
setAdditivity in interface TopicalLogger


setAttribute

public Object setAttribute(String name,
                           Object value)
It assigns an attributte to the handler.
Specified by:
setAttribute in interface Handler

Parameters:
name - is the attribute name
value - is the attribute value

Returns:
the old value is the attribute was already defined


setIntLevel

public void setIntLevel(int level)
Set the current level of the logger
Specified by:
setIntLevel in interface Logger


setLevel

public void setLevel(Level l)
Permits to set the level with a Level instance.
Specified by:
setLevel in interface Logger


setName

public void setName(String name)
It assigns the name of the handler
Specified by:
setName in interface Handler


turnOff

public void turnOff()
Disable the handler
Specified by:
turnOff in interface Logger


turnOn

public void turnOn()
Enable the handler
Specified by:
turnOn in interface Logger