blackboard.platform.log
Interface Log

All Known Subinterfaces:
AggregatingLogger, LogService

public interface Log

Interface to represent interaction with a physical log. All messages logged are filtered by verbosityLevel. Messages higher than verbosityLevel are ignored, and not written.

Since:
Bb 5.5

Method Summary
 java.lang.String getLogFileName()
          Returns filename for this log.
 java.lang.String getLogName()
          Returns the name used to register this log.
 LogService.Verbosity getVerbosityLevel()
          Returns the verbosity level for this log.
 boolean isDebugEnabled()
          Indicates whether debug logging is enabled.
 void log(java.lang.String message, LogService.Verbosity verbosity)
          Logs the specified message at the appropriate verbosity.
 void log(java.lang.String message, java.lang.Throwable error, LogService.Verbosity verbosity)
          Logs the specified message at the appropriate verbosity.
 void logAudit(java.lang.String message)
          Logs the specified message at the "audit" level.
 void logAudit(java.lang.String message, java.lang.Throwable error)
          Logs the specified message at the "audit" level.
 void logDebug(java.lang.String message)
          Logs the specified message at the "debug" level.
 void logDebug(java.lang.String message, java.lang.Throwable error)
          Logs the specified message at the "debug" level.
 void logError(java.lang.String message)
          Logs the specified message at the "error" level.
 void logError(java.lang.String message, java.lang.Throwable error)
          Logs the specified message at the "error" level.
 void logFatal(java.lang.String message)
          Logs specified message at "fatal" level
 void logFatal(java.lang.String message, java.lang.Throwable error)
          Logs the specified message at the "fatal" level.
 void logInfo(java.lang.String message)
          Logs the specified message at the "info" level.
 void logInfo(java.lang.String message, java.lang.Throwable error)
          Logs the specified message at the "info" level.
 void logSqlWarnings(java.sql.Connection con)
          Logs output associated with the SQLWarnings associated with the specified Connection.
 void logSqlWarnings(java.sql.Connection con, java.sql.Statement stmt, java.sql.ResultSet results)
          Logs output associated with the SQLWarnings associated with the Connection, Statement and ResultSet.
 void logSqlWarnings(java.sql.ResultSet results)
          Logs output associated with the SQLWarnings associated with the specified ResultSet.
 void logSqlWarnings(java.sql.Statement stmt)
          Logs output associated with the SQLWarnings associated with the specified Statement.
 void logSqlWarnings(java.lang.String message, java.sql.SQLWarning errors)
          Logs the specified message, and attaches output associated with the specified SQLWarning.
 void logWarning(java.lang.String message)
          Logs the specified message at the "warning" level.
 void logWarning(java.lang.String message, java.lang.Throwable error)
          Logs the specified message at the "warning" level.
 void setVerbosityLevel(LogService.Verbosity verbosity)
          Sets the verbosity level for this log.
 

Method Detail

getLogFileName

java.lang.String getLogFileName()
Returns filename for this log.

Returns:
filename for the log

getLogName

java.lang.String getLogName()
Returns the name used to register this log.

Returns:
Name for the log

setVerbosityLevel

void setVerbosityLevel(LogService.Verbosity verbosity)
Sets the verbosity level for this log.

Parameters:
verbosity - Verbosity level.

getVerbosityLevel

LogService.Verbosity getVerbosityLevel()
Returns the verbosity level for this log.

Returns:
Verbosity level.

log

void log(java.lang.String message,
         LogService.Verbosity verbosity)
Logs the specified message at the appropriate verbosity. Messages higher than getVerbosityLevel() will not be written.

Parameters:
message - Message to log
verbosity - Verbosity for this message.

log

void log(java.lang.String message,
         java.lang.Throwable error,
         LogService.Verbosity verbosity)
Logs the specified message at the appropriate verbosity. Messages higher than getVerbosityLevel() will not be written.

Parameters:
message - Message to log
error - Exception or Throwable that caused this message to be logged.
verbosity - Verbosity for this message

logFatal

void logFatal(java.lang.String message)
Logs specified message at "fatal" level

Parameters:
message - Message to log

logFatal

void logFatal(java.lang.String message,
              java.lang.Throwable error)
Logs the specified message at the "fatal" level.

Parameters:
message - Message to log
error - Exception or Throwable to associate with this message

logError

void logError(java.lang.String message)
Logs the specified message at the "error" level.

Parameters:
message - Message to log

logError

void logError(java.lang.String message,
              java.lang.Throwable error)
Logs the specified message at the "error" level.

Parameters:
message - Message to log
error - Exception or Throwable to associate with this message

logWarning

void logWarning(java.lang.String message)
Logs the specified message at the "warning" level.

Parameters:
message - Message to log

logWarning

void logWarning(java.lang.String message,
                java.lang.Throwable error)
Logs the specified message at the "warning" level.

Parameters:
message - Message to log
error - Exception or Throwable to associate with this message

logInfo

void logInfo(java.lang.String message)
Logs the specified message at the "info" level.

Parameters:
message - Message to log

logInfo

void logInfo(java.lang.String message,
             java.lang.Throwable error)
Logs the specified message at the "info" level.

Parameters:
message - Message to log
error - Exception or Throwable to associate with this message

logDebug

void logDebug(java.lang.String message)
Logs the specified message at the "debug" level.

Parameters:
message - Message to log

logDebug

void logDebug(java.lang.String message,
              java.lang.Throwable error)
Logs the specified message at the "debug" level.

Parameters:
message - Message to log
error - Exception or Throwable to associate with this message

logAudit

void logAudit(java.lang.String message)
Logs the specified message at the "audit" level.

Parameters:
message - Message to log

logAudit

void logAudit(java.lang.String message,
              java.lang.Throwable error)
Logs the specified message at the "audit" level.

Parameters:
message - Message to log
error - Exception or Throwable to associate with this message

logSqlWarnings

void logSqlWarnings(java.lang.String message,
                    java.sql.SQLWarning errors)
                    throws java.sql.SQLException
Logs the specified message, and attaches output associated with the specified SQLWarning.

Parameters:
message - Message to log
errors - SQLWarnings associated with this message
Throws:
java.sql.SQLException

logSqlWarnings

void logSqlWarnings(java.sql.ResultSet results)
                    throws java.sql.SQLException
Logs output associated with the SQLWarnings associated with the specified ResultSet.

Parameters:
results - ResultSet containing warnings
Throws:
java.sql.SQLException

logSqlWarnings

void logSqlWarnings(java.sql.Connection con)
                    throws java.sql.SQLException
Logs output associated with the SQLWarnings associated with the specified Connection.

Parameters:
con - Connection containing warnings
Throws:
java.sql.SQLException

logSqlWarnings

void logSqlWarnings(java.sql.Connection con,
                    java.sql.Statement stmt,
                    java.sql.ResultSet results)
                    throws java.sql.SQLException
Logs output associated with the SQLWarnings associated with the Connection, Statement and ResultSet.

Parameters:
con - Connection containing warnings
stmt - Statement
results - ResultSet containing warnings
Throws:
java.sql.SQLException

logSqlWarnings

void logSqlWarnings(java.sql.Statement stmt)
                    throws java.sql.SQLException
Logs output associated with the SQLWarnings associated with the specified Statement.

Parameters:
stmt - Statement containing warnings
Throws:
java.sql.SQLException

isDebugEnabled

boolean isDebugEnabled()
Indicates whether debug logging is enabled.



Copyright 2011 Blackboard, Inc. All Rights Reserved.