|
ColdBox Platform Version 3.7.0 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.logging.AbstractAppender
coldbox.system.logging.appenders.FileAppender
public class FileAppender
This is a simple implementation of an appender that is file based.
Constructor Summary | |
---|---|
init(any name, [any properties='[runtime expression]'], [any layout=''], [any levelMin='0'], [any levelMax='4'])
Constructor |
Method Summary | |
---|---|
private void |
append(any message)
Append a message to a file |
private void |
ensureDefaultLogDirectory()
Ensures the log directory |
any |
getlockTimeout()
The lock timeout |
any |
getlockname()
The file Lock name |
any |
getlogFullpath()
Get the full log path used |
void |
initLogLocation()
Initialize the file log location if it does not exist |
void |
logMessage(any logEvent)
Write an entry into the appender |
void |
onRegistration()
Runs on registration |
void |
removeLogFile()
Removes the log file |
Methods inherited from class coldbox.system.logging.AbstractAppender |
---|
$abort, $dump, $log, $rethrowit, $throw, canLog, getColdbox, getCustomLayout, getHash, getName, getProperties, getProperty, getUtil, getlevelMax, getlevelMin, hasCustomLayout, isInitialized, onUnRegistration, propertyExists, setColdbox, setInitialized, setLevelMax, setLevelMin, setProperties, setProperty, severityToString
|
Methods inherited from class WEB-INF.cftags.component |
---|
|
Constructor Detail |
---|
public init(any name, [any properties='[runtime expression]'], [any layout=''], [any levelMin='0'], [any levelMax='4'])
name
- The unique name for this appender.properties
- A map of configuration properties for the appenderlayout
- The layout class to use in this appender for custom message rendering.levelMin
- The default log level for this appender, by default it is 0. Optional. ex: LogBox.logLevels.WARNlevelMax
- The default log level for this appender, by default it is 5. Optional. ex: LogBox.logLevels.WARNMethod Detail |
---|
private void append(any message)
message
- The message to appendprivate void ensureDefaultLogDirectory()
public any getlockTimeout()
public any getlockname()
public any getlogFullpath()
public void initLogLocation()
public void logMessage(any logEvent)
logMessage
in class
AbstractAppender
logEvent
- The logging eventpublic void onRegistration()
onRegistration
in class
AbstractAppender
public void removeLogFile()
|
ColdBox Platform Version 3.7.0 | ||||
FRAMES |