Description

Writes a log entry with a warning severity to the ColdFusion logger. The entry includes the severity, thread ID, date, time, and a text message.

Category

Event Gateway Development

Syntax

warn(String message)
warn(Throwable th)
warn(String message, Throwable th)

See also

debugerrorfatalinfogetLogger, Logging events and using log files in Building an event gateway in the Developing ColdFusion Applications

Parameters

Parameter

Description

message

The message to include in the log entry.

th

A throwable object, normally an exception. ColdFusion logs the exception information in the exception.log file in the ColdFusion logs directory.

Usage

Use this method to send a warning message to the ColdFusion logging subsystem. ColdFusion writes messages with a severity of "warning" to the log file specified in the getLogger method that returned the Logger instance (or the default log file).

Example

The ColdFusion example SocketWatcherGateway class includes the following code in its constructor to load a configuration file. If it cannot load the file, it converts the exception information to a string and logs a warning that includes the gateway ID, and the exception information. It also passes the exception to the warn method

propsFilePath=configpath;
try {
FileInputStream propsFile = new FileInputStream(propsFilePath);
properties.load(propsFile);
propsFile.close();
this.loadProperties();
}
catch (IOException e) {
// do nothing. use default value for port.
log.warn("SocketGateway(" + gatewayID + ") Unable to read configuration file
" + propsFilePath + ": " + e.ToString() + ".Using default port.", e);
}

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy