ca.bc.gov.open.cpf.plugin.api.log

Class AppLog

java.lang.Object

ca.bc.gov.open.cpf.plugin.api.log.AppLog

public class AppLog
extends Object

The AppLog class is a logging API for use by a BusinessApplicationPlugin class. Plug-in classes can record error, info and debug messages in the execute method. These messages will be recorded in the Log4j log file (if that log level is enabled in the worker for the AppLog class). The message will also be recorded in the module log file on the master if that log level is enabled for the business application. This functionality allows viewing the logs for the all the workers from the CPF admin console.

The plug-in must implement the following method on the BusinessApplicationPlugin class to obtain a AppLog instance for this request.

private AppLog appLog;

public void setAppLog(final AppLog appLog) {
  this.appLog = appLog;
}

Constructor Summary

Constructors

Constructor and Description
AppLog(String name)
AppLog(String name, String logLevel)
AppLog(String moduleName, String businessApplicationName, String groupId, String logLevel)

Method Summary

Modifier and Type	Method and Description
void	debug(String message) Record the info message in the log if isInfoEnabled() is true.
void	error(String message) Record the error message in the log.
void	error(String message, Throwable exception) Record the error message in the log with the exception.
String	getLogLevel() Get the logging level (ERROR, INFO, DEBUG).
void	info(String message) Record the info message in the log if isInfoEnabled() is true.
boolean	isDebugEnabled() Check to see if debug level logging is enabled.
boolean	isInfoEnabled() Check to see if info or debug level logging is enabled.
void	setLogLevel(String logLevel) Set the current logging level (ERROR, INFO, DEBUG).
String	toString()
void	warn(String message) Record the warning message in the log.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AppLog

public AppLog(String name)

AppLog

public AppLog(String name,
              String logLevel)

AppLog

public AppLog(String moduleName,
              String businessApplicationName,
              String groupId,
              String logLevel)

Method Detail

debug

public void debug(String message)

Record the info message in the log if isInfoEnabled() is true.

Parameters:

message - The message.

error

public void error(String message)

Record the error message in the log.

Parameters:

message - The message.

error

public void error(String message,
                  Throwable exception)

Record the error message in the log with the exception.

Parameters:

message - The message.

getLogLevel

public String getLogLevel()

Get the logging level (ERROR, INFO, DEBUG).

Returns:

The logging level (ERROR, INFO, DEBUG).

info

public void info(String message)

Record the info message in the log if isInfoEnabled() is true.

Parameters:

message - The message.

isDebugEnabled

public boolean isDebugEnabled()

Check to see if debug level logging is enabled. Use this in an if block around logging operations that create large amounts of log data to prevent that data from being created if logging is not enabled.

Returns:

True if debug level logging is enabled.

isInfoEnabled

public boolean isInfoEnabled()

Check to see if info or debug level logging is enabled. Use this in an if block around logging operations that create large amounts of log data to prevent that data from being created if logging is not enabled.

Returns:

True if info or debug level logging is enabled.

setLogLevel

public void setLogLevel(String logLevel)

Set the current logging level (ERROR, INFO, DEBUG).

Parameters:

logLevel - The logging level (ERROR, INFO, DEBUG).

toString

public String toString()

Overrides:

toString in class Object

warn

public void warn(String message)

Record the warning message in the log.

Parameters:

message - The warning.