org.snmp4j.log
Interface LogAdapter

All Known Implementing Classes:
ConsoleLogAdapter, JavaLogAdapter, Log4jLogAdapter, LogProxy, NoLogger

public interface LogAdapter

The LogAdapter specifies the logging interface used by SNMP4J. To provide another logging mechanism as the default no-logging the static method LogFactory.setLogFactory(org.snmp4j.log.LogFactory) can be used to assign a different logging adapter factory.

Since:
1.2.1
Version:
1.6.1
Author:
Frank Fock

Method Summary
 void debug(java.io.Serializable message)
          Logs a debug message.
 void error(java.lang.CharSequence message, java.lang.Throwable throwable)
          Logs an error message.
 void error(java.io.Serializable message)
          Logs an error message.
 void fatal(java.lang.CharSequence message, java.lang.Throwable throwable)
          Logs a fatal message.
 void fatal(java.lang.Object message)
          Logs a fatal message.
 LogLevel getEffectiveLogLevel()
          Returns the log level that is effective for this log adapter.
 java.util.Iterator getLogHandler()
          Returns the log handlers associated with this logger.
 LogLevel getLogLevel()
          Returns the log level defined for this log adapter.
 java.lang.String getName()
          Returns the name of the logger.
 void info(java.lang.CharSequence message)
          Logs an informational message.
 boolean isDebugEnabled()
          Checks whether DEBUG level logging is activated for this log adapter.
 boolean isInfoEnabled()
          Checks whether INFO level logging is activated for this log adapter.
 boolean isWarnEnabled()
          Checks whether WARN level logging is activated for this log adapter.
 void setLogLevel(LogLevel level)
          Sets the log level for this log adapter (if applicable).
 void warn(java.io.Serializable message)
          Logs an warning message.
 

Method Detail

isDebugEnabled

boolean isDebugEnabled()
Checks whether DEBUG level logging is activated for this log adapter.

Returns:
true if logging is enabled or false otherwise.

isInfoEnabled

boolean isInfoEnabled()
Checks whether INFO level logging is activated for this log adapter.

Returns:
true if logging is enabled or false otherwise.

isWarnEnabled

boolean isWarnEnabled()
Checks whether WARN level logging is activated for this log adapter.

Returns:
true if logging is enabled or false otherwise.

debug

void debug(java.io.Serializable message)
Logs a debug message.

Parameters:
message - the message to log.

info

void info(java.lang.CharSequence message)
Logs an informational message.

Parameters:
message - the message to log.

warn

void warn(java.io.Serializable message)
Logs an warning message.

Parameters:
message - the message to log.

error

void error(java.io.Serializable message)
Logs an error message.

Parameters:
message - the message to log.

error

void error(java.lang.CharSequence message,
           java.lang.Throwable throwable)
Logs an error message.

Parameters:
message - the message to log.
throwable - the exception that caused to error.

fatal

void fatal(java.lang.Object message)
Logs a fatal message.

Parameters:
message - the message to log.

fatal

void fatal(java.lang.CharSequence message,
           java.lang.Throwable throwable)
Logs a fatal message.

Parameters:
message - the message to log.
throwable - the exception that caused to error.

setLogLevel

void setLogLevel(LogLevel level)
Sets the log level for this log adapter (if applicable).

Parameters:
level - a LogLevel instance.
Since:
1.6.1

getLogLevel

LogLevel getLogLevel()
Returns the log level defined for this log adapter.

Returns:
a LogLevel instance.
Since:
1.6.1

getEffectiveLogLevel

LogLevel getEffectiveLogLevel()
Returns the log level that is effective for this log adapter. The effective log level is the first log level different from LogLevel.NONE to the root.

Returns:
a LogLevel different than LogLevel.NONE.
Since:
1.6.1

getName

java.lang.String getName()
Returns the name of the logger.

Returns:
the name of the logger.

getLogHandler

java.util.Iterator getLogHandler()
Returns the log handlers associated with this logger.

Returns:
an Iterator of log system dependent log handlers.
Since:
1.6.1

Copyright 2005-2011 Frank Fock (SNMP4J.org)

Copyright © 2011 SNMP4J.org. All Rights Reserved.