ControlPanelLog.java revision d25372dc8e65a9ed019a88fdf659ca61313f1b31
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License, Version 1.0 only
* (the "License"). You may not use this file except in compliance
* with the License.
*
* You can obtain a copy of the license at
* trunk/opends/resource/legal-notices/OpenDS.LICENSE
* or https://OpenDS.dev.java.net/OpenDS.LICENSE.
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at
* trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
* add the following below this CDDL HEADER, with the fields enclosed
* by brackets "[]" replaced with your own identifying information:
* Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*
*
* Copyright 2008 Sun Microsystems, Inc.
*/
package org.opends.guitools.controlpanel.util;
import java.io.File;
import java.io.IOException;
import java.util.logging.FileHandler;
import java.util.logging.SimpleFormatter;
import java.util.logging.Logger;
import java.util.logging.Level;
import java.util.Date;
import java.text.DateFormat;
/**
* Utilities for setting up Control Panel application log.
*/
public class ControlPanelLog
{
private static String[] packages = {
"org.opends"
};
static private File logFile = null;
/**
* Creates a new file handler for writing log messages to the file indicated
* by <code>file</code>.
* @param file log file to which log messages will be written
* @throws IOException if something goes wrong
*/
static public void initLogFileHandler(File file) throws IOException {
if (!isInitialized())
{
logFile = file;
FileHandler fileHandler = new FileHandler(logFile.getCanonicalPath());
fileHandler.setFormatter(new SimpleFormatter());
for (String packageName : packages)
{
Logger logger = Logger.getLogger(packageName);
logger.setUseParentHandlers(false); // disable logging to console
logger.addHandler(fileHandler);
}
Logger logger = Logger.getLogger(packages[0]);
logger.log(Level.INFO, getInitialLogRecord());
}
}
/**
* Writes messages under a given package in the file handler defined when
* calling initLogFileHandler. Note that initLogFileHandler should be called
* before calling this method.
* @param packageName the package name.
* @throws IOException if something goes wrong
*/
static public void initPackage(String packageName) throws IOException {
FileHandler fileHandler = new FileHandler(logFile.getCanonicalPath());
fileHandler.setFormatter(new SimpleFormatter());
Logger logger = Logger.getLogger(packageName);
logger.setUseParentHandlers(false); // disable logging to console
logger.addHandler(fileHandler);
logger.log(Level.INFO, getInitialLogRecord());
}
/**
* Gets the name of the log file.
* @return File representing the log file
*/
static public File getLogFile() {
return logFile;
}
/**
* Indicates whether or not the log file has been initialized.
* @return true when the log file has been initialized
*/
static public boolean isInitialized() {
return logFile != null;
}
static private String getInitialLogRecord() {
StringBuilder sb = new StringBuilder()
.append("Status application launched " +
DateFormat.getDateTimeInstance(DateFormat.LONG,
DateFormat.LONG).
format(new Date()));
return sb.toString();
}
}