Class JavaLogFactory

java.lang.Object

org.snmp4j.log.LogFactory

org.snmp4j.log.JavaLogFactory

public class JavaLogFactory
extends LogFactory

The JavaLogFactory implements a SNMP4J LogFactory for Java logging. In order to use Java's java.util.logging for logging SNMP4J log messages the static LogFactory.setLogFactory(LogFactory) method has to be used before any SNMP4J class is referenced or instantiated.

Version:

3.4.1

Author:

Frank Fock

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JavaLogFactory.JavaLogAdapterIterator

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_COUNT
static final String	DEFAULT_LIMIT
static final String	DEFAULT_PATTERN
static final String	FH_ATTR_APPEND
static final String	FH_ATTR_COUNT
static final String	FH_ATTR_FORMATTER
static final String	FH_ATTR_LIMIT
static final String	FH_ATTR_PATTERN
static final String	JAVA_CONSOLE_HANDLER
static final String	JAVA_FILE_HANDLER
static final String	SF_ATTR_FORMAT

Fields inherited from class LogFactory

SNMP4J_LOG_FACTORY_LOG_HANDLER_DEFAULT_PREFIX, SNMP4J_LOG_FACTORY_LOGGER_DEFAULT_PREFIX, SNMP4J_LOG_FACTORY_SYSTEM_PROPERTY, SNMP4J_LOG_HANDLER, SNMP4J_LOG_HANDLER_LIST, SNMP4J_LOG_ID, SNMP4J_LOG_LEVEL

Constructor Summary

Constructors

Constructor	Description
JavaLogFactory()
JavaLogFactory(boolean removeExistingHandlers)

Method Summary

Modifier and Type	Method	Description
protected void	addHandler(LogAdapter logAdapter, String handlerName, Map<String,String> handlerConfig)
protected LogAdapter	createLogger(Class<?> c)	Creates a Logger for the specified class.
protected LogAdapter	createLogger(String className)	Creates a Logger for the specified class.
LogAdapter	getRootLogger()	Returns the top level logger.
Iterator<LogAdapter>	loggers()	Returns all available LogAdapters in depth first order.
protected void	removeAllHandlers(LogAdapter logAdapter)

Methods inherited from class LogFactory

getLogFactory, getLogger, getLogger, getLoggerConfigPrefix, getLogHandlerConfigPrefix, reset, resetLogger, setLogFactory, setLoggerConfigPrefix, setLogHandlerConfigPrefix, updateConfiguration, updateLogger, writeConfiguration, writeConfiguration, writeConfiguration

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

JAVA_CONSOLE_HANDLER

public static final String JAVA_CONSOLE_HANDLER

See Also:

• Constant Field Values

JAVA_FILE_HANDLER

public static final String JAVA_FILE_HANDLER

See Also:

• Constant Field Values

FH_ATTR_PATTERN

public static final String FH_ATTR_PATTERN

See Also:

• Constant Field Values

DEFAULT_PATTERN

public static final String DEFAULT_PATTERN

See Also:

• Constant Field Values

FH_ATTR_COUNT

public static final String FH_ATTR_COUNT

See Also:

• Constant Field Values

DEFAULT_COUNT

public static final String DEFAULT_COUNT

See Also:

• Constant Field Values

FH_ATTR_APPEND

public static final String FH_ATTR_APPEND

See Also:

• Constant Field Values

FH_ATTR_LIMIT

public static final String FH_ATTR_LIMIT

See Also:

• Constant Field Values

DEFAULT_LIMIT

public static final String DEFAULT_LIMIT

See Also:

• Constant Field Values

FH_ATTR_FORMATTER

public static final String FH_ATTR_FORMATTER

See Also:

• Constant Field Values

SF_ATTR_FORMAT

public static final String SF_ATTR_FORMAT

See Also:

• Constant Field Values

Constructor Details

JavaLogFactory

public JavaLogFactory()

JavaLogFactory

public JavaLogFactory(boolean removeExistingHandlers)

Method Details

createLogger

protected LogAdapter createLogger(Class<?> c)

Description copied from class: LogFactory

Creates a Logger for the specified class. This method returns the NoLogger logger instance which disables logging. Overwrite this method the return a custom logger to enable logging for SNMP4J.

Overrides:

createLogger in class LogFactory

Parameters:

c - the class for which a logger needs to be created.

Returns:

the LogAdapter instance.

createLogger

protected LogAdapter createLogger(String className)

Description copied from class: LogFactory

Creates a Logger for the specified class. This method returns the NoLogger logger instance which disables logging. Overwrite this method the return a custom logger to enable logging for SNMP4J.

Overrides:

createLogger in class LogFactory

Parameters:

className - the class name for which a logger needs to be created.

Returns:

the LogAdapter instance.

getRootLogger

public LogAdapter getRootLogger()

Description copied from class: LogFactory

Returns the top level logger.

Overrides:

getRootLogger in class LogFactory

Returns:

a LogAdapter instance.

loggers

public Iterator<LogAdapter> loggers()

Description copied from class: LogFactory

Returns all available LogAdapters in depth first order.

Overrides:

loggers in class LogFactory

Returns:

a read-only Iterator.

addHandler

protected void addHandler(LogAdapter logAdapter,
 String handlerName,
 Map<String,String> handlerConfig)

Overrides:

addHandler in class LogFactory

removeAllHandlers

protected void removeAllHandlers(LogAdapter logAdapter)

Overrides:

removeAllHandlers in class LogFactory