BasicFactory (Monolog API)

Overview

Package

Class

Use

Tree

Serialized

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.objectweb.util.monolog.wrapper.config
Class BasicFactory

java.lang.Object
  org.objectweb.util.monolog.wrapper.config.BasicFactory

All Implemented Interfaces:: HandlerFactory, LevelFactory, LoggerFactory, MonologFactory, java.io.Serializable

public class BasicFactory
extends java.lang.Object
implements MonologFactory, java.io.Serializable

This class is a basic implementation of the monolog factories (HandlerFactory, LoggerFactory and LevelFactory). It does not linked to an any underlying log system.

Author:: Sebastien Chassande-Barrioz
See Also:: Serialized Form

Field Summary
`protected java.util.HashMap`	`handlers` This field references the handler instance by their names. key = a String object which is an handler name.
`protected java.util.HashMap`	`intToNames` This field reference the level names by their integer value. key = a java.lang.Integer which the value is the level value = a String or an ArrayList of String.
`protected java.util.HashMap`	`loggers` This field references the handler instance by their names. key = a String object which is a logger topic.
`protected java.util.HashMap`	`nameToLevel` This field references the level instances by their names. key = a level name value = the unique Level instance linked to the name.
`protected java.lang.String`	`resourceBundleName` The resource bundle linked to the LoggerFactory.

Fields inherited from interface org.objectweb.util.monolog.api.MonologFactory
`DEFAULT, LOG_CONFIGURATION_FILE, LOG_CONFIGURATION_FILE_USE_CLASSPATH, LOG_CONFIGURATION_TYPE, PROPERTY, XML`

Constructor Summary
`BasicFactory()` It intializes the data struture, defines the default level and the root logger.

Method Summary
`void`	`addMonologFactoryListener(MonologFactoryListener mfl)` register a listener for the events of this MonologFactory
`void`	`configure(java.util.Properties prop)` This method permits to order to a monolog wrapper to configure the underlying log system.
`Handler`	`createHandler(java.lang.String hn, java.lang.String handlertype)` It retrieves a new instance of an handler which the type is specified by the parameter.
`protected void`	`defineDefaultLevels()` It initializes the default monolog level: DEBUG: 10 000 INFO: 20 000 WARN: 30 000 ERROR: 40 000 FATAL: 50 000
`Level`	`defineLevel(java.lang.String name, int value)` It defines a new Level with a name and an integer value.
`Level`	`defineLevel(java.lang.String name, java.lang.String value)` It defines a new Level with a name and a string value.
`protected void`	`defineRootLogger()` It defines the level of the root logger to WARN.
`Handler`	`getHandler(java.lang.String hn)` It retrieves the handler which the name is specified by the parameter
`Handler[]`	`getHandlers()` It retrieves all handler managed by this factory.
`Level`	`getLevel(int value)` It retrieves a Level instance which the integer value is equals to the parameter.
`Level`	`getLevel(java.lang.String name)` It retrieves a Level instance which the name is equals to the parameter.
`Level[]`	`getLevels()` It retrieves all Level instances defined in this manager.
`Logger`	`getLogger(java.lang.String _key)` This method permits to fetch a Logger.
`Logger`	`getLogger(java.lang.String key, java.lang.String resourceBundleName)` This method permits to fetch a Logger.
`Logger[]`	`getLoggers()` It retrieves a list of all loggers.
`java.lang.String`	`getResourceBundleName()` Accessors to a resource bundle name associated to a LoggerFactory.
`Handler`	`removeHandler(java.lang.String hn)` It removes the handler which the name is specified by the parameter
`void`	`removeLevel(java.lang.String name)` It removes a Level instance to this manager.
`void`	`removeLogger(Logger logger)`
`void`	`removeMonologFactoryListener(MonologFactoryListener mfl)` forget a listener for the events of this MonologFactory
`void`	`setResourceBundleName(java.lang.String rbn)` Accessors to a resource bundle name associated to a LoggerFactory.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

nameToLevel

protected java.util.HashMap nameToLevel

This field references the level instances by their names.
key = a level name
value = the unique Level instance linked to the name.

intToNames

protected java.util.HashMap intToNames

This field reference the level names by their integer value.
key = a java.lang.Integer which the value is the level
value = a String or an ArrayList of String. The strings represent the name which match to the integer value. Indeed both name can be associated to the same integer value.

handlers

protected java.util.HashMap handlers

This field references the handler instance by their names.
key = a String object which is an handler name. value = the unique handler instance which has the key for name.

loggers

protected java.util.HashMap loggers

This field references the handler instance by their names.
key = a String object which is a logger topic. value = the unique handler instance which has the key for name.

resourceBundleName

protected java.lang.String resourceBundleName

The resource bundle linked to the LoggerFactory.

Constructor Detail

BasicFactory

public BasicFactory()

It intializes the data struture, defines the default level and the root logger.

Method Detail

defineDefaultLevels

protected void defineDefaultLevels()

It initializes the default monolog level:

DEBUG: 10 000
INFO: 20 000
WARN: 30 000
ERROR: 40 000
FATAL: 50 000

defineRootLogger

protected void defineRootLogger()

It defines the level of the root logger to WARN.

addMonologFactoryListener

public void addMonologFactoryListener(MonologFactoryListener mfl)

Description copied from interface: MonologFactory

Specified by:: addMonologFactoryListener in interface MonologFactory

removeMonologFactoryListener

public void removeMonologFactoryListener(MonologFactoryListener mfl)

Description copied from interface: MonologFactory

forget a listener for the events of this MonologFactory

Specified by:: removeMonologFactoryListener in interface MonologFactory