|
ColdBox Platform Version 3.7.0 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.logging.config.LogBoxConfig
public class LogBoxConfig
This is a LogBox configuration object. You can use it to configure a log box instance
Constructor Summary | |
---|---|
init([any XMLConfig=''], [any CFCConfig], [any CFCConfigPath])
Constructor |
Method Summary | |
---|---|
any |
DEBUG()
Add categories to the DEBUG level |
any |
ERROR()
Add categories to the ERROR level |
any |
FATAL()
Add categories to the FATAL level |
any |
INFO()
Add categories to the INFO level |
any |
OFF()
Add categories to the OFF level |
any |
WARN()
Add categories to the WARN level |
any |
appender(any name, any class, [any<struct> properties='[runtime expression]'], [any layout=''], [any levelMin='0'], [any levelMax='4'])
Add an appender configuration |
any |
category(any name, [any levelMin='0'], [any levelMax='4'], [any appenders='*'])
Add a new category configuration with appender(s) |
any<boolean> |
categoryExists(any name)
Check if a category definition exists |
private any<struct> |
convertLevels(any<struct> target='')
Convert levels from an incoming structure of data |
any<struct> |
getAllAppenders()
Get all the configured appenders |
any<struct> |
getAllCategories()
Get the configured categories |
any<struct> |
getCategory(any name)
Get a specifed category definition |
any<struct> |
getMemento()
Get the instance data |
any<struct> |
getRoot()
Get the root logger definition |
private void |
levelChecks(any levelMin, any levelMax)
Level checks or throw |
void |
loadDataDSL(any<struct> rawDSL)
Load a data configuration CFC data DSL |
void |
parseAndLoad(any xmlDoc)
Parse and load a config xml object |
void |
reset()
Reset the configuration |
void |
resetAppenders()
Reset the appender configurations |
void |
resetCategories()
Reset the set categories |
void |
resetRoot()
Reset the root logger |
any |
root([any levelMin='0'], [any levelMax='4'], any appenders)
Register the root logger in this configuration |
void |
validate()
Validates the configuration |
Methods inherited from class WEB-INF.cftags.component |
---|
|
Constructor Detail |
---|
public init([any XMLConfig=''], [any CFCConfig], [any CFCConfigPath])
XMLConfig
- The xml configuration file to use instead of a programmatic approachCFCConfig
- The logBox Data Configuration CFCCFCConfigPath
- The logBox Data Configuration CFC path to useMethod Detail |
---|
public any DEBUG()
public any ERROR()
public any FATAL()
public any INFO()
public any OFF()
public any WARN()
public any appender(any name, any class, [any<struct> properties='[runtime expression]'], [any layout=''], [any levelMin='0'], [any levelMax='4'])
name
- A unique name for the appender to register. Only unique names can be registered per instance.class
- The appender's class to register. We will create, init it and register it for you.properties
- The structure of properties to configure this appender with.layout
- The layout class path to use in this appender for custom message rendering.levelMin
- The default log level for the root logger, by default it is 0 (FATAL). Optional. ex: config.logLevels.WARNlevelMax
- The default log level for the root logger, by default it is 4 (DEBUG). Optional. ex: config.logLevels.WARNpublic any category(any name, [any levelMin='0'], [any levelMax='4'], [any appenders='*'])
name
- A unique name for the appender to register. Only unique names can be registered per instance.levelMin
- The default min log level for this category. Defaults to the lowest level 0 or FATALlevelMax
- The max default log level for this category. If not passed it defaults to the highest level possibleappenders
- A list of appender names to configure this category with. By default it uses all the registered appenderspublic any<boolean> categoryExists(any name)
name
- The category to retrieveprivate any<struct> convertLevels(any<struct> target='')
target
- The structure to look for elements: LevelMin and LevelMaxpublic any<struct> getAllAppenders()
public any<struct> getAllCategories()
public any<struct> getCategory(any name)
name
- The category to retrievepublic any<struct> getMemento()
public any<struct> getRoot()
private void levelChecks(any levelMin, any levelMax)
levelMin
levelMax
public void loadDataDSL(any<struct> rawDSL)
rawDSL
- The data configuration DSL structurepublic void parseAndLoad(any xmlDoc)
xmlDoc
- The xml document object to use for parsing.public void reset()
public void resetAppenders()
public void resetCategories()
public void resetRoot()
public any root([any levelMin='0'], [any levelMax='4'], any appenders)
levelMin
- The default log level for the root logger, by default it is 0 (FATAL). Optional. ex: config.logLevels.WARNlevelMax
- The default log level for the root logger, by default it is 4 (DEBUG). Optional. ex: config.logLevels.WARNappenders
- A list of appenders to configure the root logger with. Send a * to add all appenderspublic void validate()
|
ColdBox Platform Version 3.7.0 | ||||
FRAMES |