|
ColdBox Platform Version 3.7.0 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.logging.AbstractAppender
public class AbstractAppender
This is the abstract interface component for all LogBox Appenders
Constructor Summary | |
---|---|
init(any name, [any<struct> properties='[runtime expression]'], [any layout=''], [any<numeric> levelMin='0'], [any<numeric> levelMax='4'])
Constructor called by a Concrete Appender |
Method Summary | |
---|---|
private void |
$abort()
Facade for cfabort |
private void |
$dump(any var, [boolean isAbort='false'])
Facade for cfmx dump |
private void |
$log(any severity='INFO', any message='')
Log an internal message to the ColdFusion facilities |
private void |
$rethrowit(any throwObject)
Rethrow facade |
private any |
$throw(string message, [string detail=''], [string type='Framework'])
Facade for cfthrow |
any<Boolean> |
canLog(any<numeric> level)
Checks wether a log can be made on this appender using a passed in level |
any |
getColdbox()
Get the ColdBox application controller LogBox is linked to |
any |
getCustomLayout()
Get the custom layout object |
any |
getHash()
Get this appender's unique ID |
any |
getName()
Get this appender's name |
any<struct> |
getProperties()
Get properties structure map |
any |
getProperty(any property)
Get a property, throws exception if not found |
private any |
getUtil()
Create and return a util object |
any<numeric> |
getlevelMax()
Get the level Max setting |
any<numeric> |
getlevelMin()
Get the level min setting |
any<Boolean> |
hasCustomLayout()
Whether a custom layout has been set or not |
any<Boolean> |
isInitialized()
Checks if the appender's internal variables are initialized |
void |
logMessage(LogEvent logEvent)
Write an entry into the appender |
void |
onRegistration()
Runs after the appender has been created and registered |
void |
onUnRegistration()
Runs before the appender is unregistered from LogBox |
any<Boolean> |
propertyExists(any property)
Checks wether a given property exists or not |
void |
setColdbox(any coldbox)
Set the ColdBox application link |
void |
setInitialized(any initialized)
Set's the appender's internal variables flag to initalized |
void |
setLevelMax(any levelMax)
Set the appender's default levelMax |
void |
setLevelMin(any levelMin)
Set the appender's default levelMin |
void |
setProperties(any<struct> properties)
Set the entire properties structure map |
void |
setProperty(any property, any value)
Set a property |
any |
severityToString(any<numeric> severity)
convert a severity to a string |
Methods inherited from class WEB-INF.cftags.component |
---|
|
Constructor Detail |
---|
public init(any name, [any<struct> properties='[runtime expression]'], [any layout=''], [any<numeric> levelMin='0'], [any<numeric> 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 $abort()
private void $dump(any var, [boolean isAbort='false'])
var
isAbort
- Abort alsoprivate void $log(any severity='INFO', any message='')
severity
- The severity to use.message
- The message to logprivate void $rethrowit(any throwObject)
throwObject
- The cfcatch objectprivate any $throw(string message, [string detail=''], [string type='Framework'])
message
detail
type
public any<Boolean> canLog(any<numeric> level)
level
- The level to check if it can be logged in this Appenderpublic any getColdbox()
public any getCustomLayout()
public any getHash()
public any getName()
public any<struct> getProperties()
public any getProperty(any property)
property
- The key of the property to return.private any getUtil()
public any<numeric> getlevelMax()
public any<numeric> getlevelMin()
public any<Boolean> hasCustomLayout()
public any<Boolean> isInitialized()
public void logMessage(LogEvent logEvent)
logEvent
- The logging event to log.public void onRegistration()
public void onUnRegistration()
public any<Boolean> propertyExists(any property)
property
- The property namepublic void setColdbox(any coldbox)
coldbox
public void setInitialized(any initialized)
initialized
public void setLevelMax(any levelMax)
levelMax
public void setLevelMin(any levelMin)
levelMin
public void setProperties(any<struct> properties)
properties
public void setProperty(any property, any value)
property
- The property name to set.value
- The value of the property.public any severityToString(any<numeric> severity)
severity
- The numeric severity to convert
|
ColdBox Platform Version 3.7.0 | ||||
FRAMES |