ColdBox Platform v3.8.0

coldbox.system.plugins
Class Logger

WEB-INF.cftags.component
        extended by coldbox.system.FrameworkSupertype
            extended by coldbox.system.Plugin
                extended by coldbox.system.plugins.Logger

public class Logger
extends Plugin

This is the frameworks Logger object. It is used for all logging facilities interfacing with LogBox and the ColdBox debugger.

Constructor Summary
init(any controller)
          Constructor
 
Method Summary
 void debug(string message, [any extraInfo=''])
          I log a debug message
 void error(string message, [any extraInfo=''])
          I log an error message
 void fatal(string message, [any extraInfo=''])
          I log a fatal message
 coldbox.system.logging.Logger getLogger()
          This coldbox apps's logger
 void info(string message, [any extraInfo=''])
          I log an information message
 void logEntry(string severity, string message, [any extraInfo=''])
          Log a message to the internal logger object
 void logError(string message, [any exceptionStruct='[runtime expression]'], [any extraInfo=''])
          Log an error into the framework using arguments
 void logErrorWithBean(any exceptionBean)
          Log an error into the framework using a coldbox exceptionBean
 void tracer(string message, [any extraInfo=''])
          Log a trace message to the ColdBox debugger panel, not LOGBOX
 void warn(string message, [any extraInfo=''])
          I log a warning message
 
Methods inherited from class coldbox.system.Plugin
getPluginDescription, getPluginName, getPluginVersion, getRequestCollection, getRequestContext, getpluginAuthor, getpluginAuthorURL, getpluginPath, setPluginDescription, setPluginName, setPluginVersion, setpluginAuthor, setpluginAuthorURL
 
Methods inherited from class coldbox.system.FrameworkSupertype
$abort, $dump, $htmlhead, $include, $rethrow, $throw, addAsset, announceInterception, getColdboxOCM, getController, getDatasource, getDebugMode, getInterceptor, getMailService, getMailSettings, getMemento, getModel, getModuleSettings, getMyPlugin, getNewMail, getPlugin, getResource, getSetting, getSettingStructure, getSettingsBean, getValidationManager, getfwLocale, includeUDF, loadGlobalUDFLibraries, locateDirectoryPath, locateFilePath, persistVariables, populateModel, relocate, renderExternalView, renderLayout, renderView, runEvent, setDebugMode, setNextEvent, setNextRoute, setSetting, setfwLocale, settingExists, validateModel
 
Methods inherited from class WEB-INF.cftags.component
None
 

Constructor Detail

init

public init(any controller)
Constructor

Parameters:
controller
Method Detail

debug

public void debug(string message, [any extraInfo=''])
I log a debug message.

Parameters:
message - The message to log.
extraInfo - Extra information to append.

error

public void error(string message, [any extraInfo=''])
I log an error message.

Parameters:
message - The message to log.
extraInfo - Extra information to append.

fatal

public void fatal(string message, [any extraInfo=''])
I log a fatal message.

Parameters:
message - The message to log.
extraInfo - Extra information to append.

getLogger

public coldbox.system.logging.Logger getLogger()
This coldbox apps's logger.


info

public void info(string message, [any extraInfo=''])
I log an information message.

Parameters:
message - The message to log.
extraInfo - Extra information to append.

logEntry

public void logEntry(string severity, string message, [any extraInfo=''])
Log a message to the internal logger object. DEPRECATED, Please use other methods.

Parameters:
severity - Severity: fatal,error,warn,info,debug,trace
message - The message to log.
extraInfo - Extra information to append.

logError

public void logError(string message, [any exceptionStruct='[runtime expression]'], [any extraInfo=''])
Log an error into the framework using arguments. Facade to logErrorWithBean.

Parameters:
message
exceptionStruct - The CF cfcatch structure.
extraInfo

logErrorWithBean

public void logErrorWithBean(any exceptionBean)
Log an error into the framework using a coldbox exceptionBean

Parameters:
exceptionBean - This is the exception bean

tracer

public void tracer(string message, [any extraInfo=''])
Log a trace message to the ColdBox debugger panel, not LOGBOX

Parameters:
message - The message to log.
extraInfo - Extra information to append.

warn

public void warn(string message, [any extraInfo=''])
I log a warning message.

Parameters:
message - The message to log.
extraInfo - Extra information to append.

ColdBox Platform v3.8.0