ca.bc.gov.open.cpf.plugin.api.log.AppLog Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cpf-api-plugin Show documentation
Concurrent Processing Framework Business Application Plugin API
There is a newer version: 5.1.1-RELEASE
/*
 * Copyright © 2008-2016, Province of British Columbia
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package ca.bc.gov.open.cpf.plugin.api.log;

import org.apache.log4j.Level;
import org.apache.log4j.Logger;

import ca.bc.gov.open.cpf.plugin.api.BusinessApplicationPlugin;

/**
 * The AppLog class is a logging API for use by a {@link 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 {@link BusinessApplicationPlugin} class
 * to obtain a AppLog instance for this request.
 *
 * private AppLog appLog;

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

  /** The logging level (ERROR, INFO, WARN, DEBUG). */
  private String logLevel = "ERROR";

  private final Logger log;

  public AppLog(final String name) {
    this(name, "ERROR");
  }

  public AppLog(final String name, final String logLevel) {
    this.log = Logger.getLogger(name);
    setLogLevel(logLevel);
  }

  public AppLog(final String moduleName, final String businessApplicationName, String groupId,
    final String logLevel) {
    if (groupId == null || groupId.trim().length() == 0) {
      groupId = String.valueOf(System.currentTimeMillis());
    }
    this.log = Logger.getLogger(moduleName + "." + businessApplicationName + "." + groupId);
    setLogLevel(logLevel);
  }

  /**
   * Record the info message in the log if {@link #isInfoEnabled()} is true.
   *
   * @param message The message.
   */
  public void debug(final String message) {
    if (isDebugEnabled()) {
      this.log.debug(message);
    }
  }

  /**
   * Record the error message in the log.
   *
   * @param message The message.
   */
  public void error(final String message) {
    this.log.error(message);
  }

  /**
   * Record the error message in the log with the exception.
   *
   * @param message The message.
   */
  public void error(final String message, final Throwable exception) {
    this.log.error(message, exception);
  }

  /**
   * Get the logging level (ERROR, INFO, DEBUG).
   *
   * @return The logging level (ERROR, INFO, DEBUG).
   */
  public String getLogLevel() {
    return this.logLevel;
  }

  /**
   * Record the info message in the log if {@link #isInfoEnabled()} is true.
   *
   * @param message The message.
   */
  public void info(final String message) {
    if (isInfoEnabled()) {
      this.log.info(message);
    }
  }

  /**
   * 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.
   *
   * @return True if debug level logging is enabled.
   */
  public boolean isDebugEnabled() {
    return this.logLevel.equals("DEBUG");
  }

  /**
   * 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.
   *
   * @return True if info or debug level logging is enabled.
   */
  public boolean isInfoEnabled() {
    return this.logLevel.equals("DEBUG") || this.logLevel.equals("INFO");
  }

  /**
   * Set the current logging level (ERROR, INFO, DEBUG).
   *
   * @param logLevel The logging level (ERROR, INFO, DEBUG).
   */
  public void setLogLevel(final String logLevel) {
    this.logLevel = logLevel;
    final Level level = Level.toLevel(logLevel);
    this.log.setLevel(level);
  }

  @Override
  public String toString() {
    return this.log.getName();
  }

  /**
   * Record the warning message in the log.
   *
   * @param message The warning.
   */
  public void warn(final String message) {
    this.log.warn(message);
  }
}