logbox.system.logging

Class Logger

lucee.Component
    extended by logbox.system.logging.Logger

Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp www.ortussolutions.com --- This is a logging object that allows for all kinds of logging to occur within its appender

Class Attributes:
  • synchronized : false
    •  
  • accessors : true
    •  
  • persistent : false
    •  
    Property Summary
    type property default serializable required
    struct appenders
          Appenders linked to this logger.

    • access = public
    • returntype = any
    		 true false
    any category
          Category for this logger.

    • access = public
    • returntype = any
    		 true false
    any levelMax
          Level Max.

    • access = public
    • returntype = any
    		 true false
    any levelMin
          Level Min.

    • access = public
    • returntype = any
    		 true false
    any rootLogger
          Root Logger reference.

    • access = public
    • returntype = any
    		 true false
    Constructor Summary
    init(any category, [numeric levelMin='0'], [numeric levelMax='4'], [struct appenders='[runtime expression]'])
          Constructor.
    Method Summary
    Logger addAppender(any newAppender)
         Add a new appender to the list of appenders for this logger.
    boolean appenderExists(any name)
         Check if an appender exists.
    boolean canDebug()
         Can I log a DEBUG message.
    boolean canError()
         Can I log a ERROR message.
    boolean canFatal()
         Can I log a fatal message.
    boolean canInfo()
         Can I log a INFO message.
    boolean canLog(any level)
         Checks wether a log can be made on this Logger using a passed in level.
    boolean canWarn()
         Can I log a WARN message.
    any debug(any message, [any extraInfo=''])
         Log a debug message.
    any error(any message, [any extraInfo=''])
         Log an error message.
    any fatal(any message, [any extraInfo=''])
         Log a fatal message.
    any getAppender(any name)
         Get an appender reference, if the appender does not exist it will throw an exception.
    any getAppenders()
         Stupid ACF10 not working on getters.
    string getCategory()
    string getLevelMax()
    string getLevelMin()
    string getRootLogger()
    any hasAppenders()
         Do we have any appenders.
    any info(any message, [any extraInfo=''])
         Log a info message.
    Logger logMessage(any message, any severity, [any extraInfo=''])
         Write an entry into the loggers registered with this LogBox variables.
    Logger removeAllAppenders()
         Remove all appenders registered.
    boolean removeAppender(any name)
         Unregister an appender from this Logger.
    any setAppenders(struct appenders)
    any setCategory(any category)
    Logger setLevelMax(any levelMax)
         Set the max level.
    Logger setLevelMin(any levelMin)
         Set the min level.
    any setRootLogger(any rootLogger)
    any warn(any message, [any extraInfo=''])
         Log a warn message.
     
    Methods inherited from class lucee.Component
    None
    Constructor Detail

    init

    public init(any category, [numeric levelMin='0'], [numeric levelMax='4'], [struct appenders='[runtime expression]'])

    Constructor

    Parameters:
    category - The category name to use this logger with
    levelMin - The default log level for this appender, by default it is 0. Optional. ex: LogBox.logLevels.WARN
    levelMax - The default log level for this appender, by default it is 0. Optional. ex: LogBox.logLevels.WARN
    appenders - A struct of already created appenders for this category, or blank to use the root logger.
    Property Detail

    appenders

    property struct appenders

    Appenders linked to this logger

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    category

    property any category

    Category for this logger

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    levelMax

    property any levelMax

    Level Max

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    levelMin

    property any levelMin

    Level Min

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    rootLogger

    property any rootLogger

    Root Logger reference

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true
    Method Detail

    addAppender

    public Logger addAppender(any newAppender)

    Add a new appender to the list of appenders for this logger. If the appender already exists, then it will not be added.

    Parameters:
    newAppender - An appender object reference
    Throws:
    Logger.InvalidAppenderNameException

    appenderExists

    public boolean appenderExists(any name)

    Check if an appender exists

    Parameters:
    name - The name of the appender

    canDebug

    public boolean canDebug()

    Can I log a DEBUG message

    canError

    public boolean canError()

    Can I log a ERROR message

    canFatal

    public boolean canFatal()

    Can I log a fatal message

    canInfo

    public boolean canInfo()

    Can I log a INFO message

    canLog

    public boolean canLog(any level)

    Checks wether a log can be made on this Logger using a passed in level

    Parameters:
    level - The numeric or string level representation

    canWarn

    public boolean canWarn()

    Can I log a WARN message

    debug

    public any debug(any message, [any extraInfo=''])

    Log a debug message

    Parameters:
    message - The message to log
    extraInfo - Extra information to send to appenders
    Returns:
    Logger

    error

    public any error(any message, [any extraInfo=''])

    Log an error message

    Parameters:
    message - The message to log
    extraInfo - Extra information to send to appenders
    Returns:
    Logger

    fatal

    public any fatal(any message, [any extraInfo=''])

    Log a fatal message

    Parameters:
    message - The message to log
    extraInfo - Extra information to send to appenders
    Returns:
    Logger

    getAppender

    public any getAppender(any name)

    Get an appender reference, if the appender does not exist it will throw an exception

    Parameters:
    name - The appender's name
    Throws:
    Logger.AppenderNotFound

    getAppenders

    public any getAppenders()

    Stupid ACF10 not working on getters

    getCategory

    public string getCategory()

    getLevelMax

    public string getLevelMax()

    getLevelMin

    public string getLevelMin()

    getRootLogger

    public string getRootLogger()

    hasAppenders

    public any hasAppenders()

    Do we have any appenders

    info

    public any info(any message, [any extraInfo=''])

    Log a info message

    Parameters:
    message - The message to log
    extraInfo - Extra information to send to appenders
    Returns:
    Logger

    logMessage

    public Logger logMessage(any message, any severity, [any extraInfo=''])

    Write an entry into the loggers registered with this LogBox variables

    Parameters:
    message - The message to log
    severity - The severity level to log, if invalid, it will default to **Info**
    extraInfo - Extra information to send to appenders

    removeAllAppenders

    public Logger removeAllAppenders()

    Remove all appenders registered

    removeAppender

    public boolean removeAppender(any name)

    Unregister an appender from this Logger. True if successful or false otherwise.

    Parameters:
    name

    setAppenders

    public any setAppenders(struct appenders)

    Parameters:
    appenders

    setCategory

    public any setCategory(any category)

    Parameters:
    category

    setLevelMax

    public Logger setLevelMax(any levelMax)

    Set the max level

    Parameters:
    levelMax - the level to set
    Throws:
    Logger.InvalidLogLevelException

    setLevelMin

    public Logger setLevelMin(any levelMin)

    Set the min level

    Parameters:
    levelMin - the level to set
    Throws:
    Logger.InvalidLogLevelException

    setRootLogger

    public any setRootLogger(any rootLogger)

    Parameters:
    rootLogger

    warn

    public any warn(any message, [any extraInfo=''])

    Log a warn message

    Parameters:
    message - The message to log
    extraInfo - Extra information to send to appenders
    Returns:
    Logger