WEB-INF.cftags.component coldbox.system.logging.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 |
---|
None |
Constructor Detail |
---|
Constructor called by a Concrete Appender
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 |
---|
Facade for cfabort
Facade for cfmx dump
var
isAbort
- Abort alsoLog an internal message to the ColdFusion facilities. Used when errors ocurrs or diagnostics
severity
- The severity to use.message
- The message to logRethrow facade
throwObject
- The cfcatch objectFacade for cfthrow
message
detail
type
Checks wether a log can be made on this appender using a passed in level
level
- The level to check if it can be logged in this AppenderGet the ColdBox application controller LogBox is linked to. If not set, it will return an empty string.
Get the custom layout object
Get this appender's unique ID
Get this appender's name
Get properties structure map
Get a property, throws exception if not found.
property
- The key of the property to return.Create and return a util object
Get the level Max setting
Get the level min setting
Whether a custom layout has been set or not.
Checks if the appender's internal variables are initialized.
Write an entry into the appender. You must implement this method yourself.
logEvent
- The logging event to log.Runs after the appender has been created and registered. Implemented by Concrete appender
Runs before the appender is unregistered from LogBox. Implemented by Concrete appender
Checks wether a given property exists or not.
property
- The property nameSet the ColdBox application link
coldbox
Set's the appender's internal variables flag to initalized.
initialized
Set the appender's default levelMax
levelMax
Set the appender's default levelMin
levelMin
Set the entire properties structure map
properties
Set a property
property
- The property name to set.value
- The value of the property.convert a severity to a string
severity
- The numeric severity to convert