org.jboss.logging.jdk.handlers.FileHandler Maven / Gradle / Ivy
/*
* Copyright 1999-2005 The Apache Software Foundation.
*
* 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 org.jboss.logging.jdk.handlers;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.util.logging.ErrorManager;
import java.util.logging.Formatter;
/**
* FileAppender appends log events to a file.
*
* @author Ceki Gülcü
* @author [email protected]
* @version $Revision: 2786 $
*/
public class FileHandler extends WriterHandler
{
/**
* Controls file truncatation. The default value for this variable
* is true, meaning that by default a
* FileAppender will append to an existing file and not
* truncate it.
*
* This option is meaningful only if the FileAppender opens the
* file.
*/
protected boolean fileAppend = true;
/**
* The name of the log file.
*/
protected String fileName = null;
/**
* The default constructor does not do anything.
*/
public FileHandler()
{
}
/**
* Instantiate a FileHandler and open the file
* designated by filename. The opened filename will
* become the output destination for this appender.
*
* If the append parameter is true, the file will be
* appended to. Otherwise, the file designated by
* filename will be truncated before being opened.
*
* If the bufferedIO parameter is true,
* then buffered IO will be used to write to the output file.
* @param layout
* @param filename
* @param append
* @param bufferedIO
* @param bufferSize
* @throws IOException
*/
public FileHandler(Formatter layout, String filename, boolean append, boolean bufferedIO,
int bufferSize)
throws IOException
{
super.setFormatter(layout);
this.setFile(filename, append, bufferedIO, bufferSize);
}
/**
* Instantiate a FileHandler and open the file designated by
* filename. The opened filename will become the output
* destination for this appender.
*
* If the append parameter is true, the file will be
* appended to. Otherwise, the file designated by
* filename will be truncated before being opened.
* @param layout
* @param filename
* @param append
* @throws IOException
*/
public FileHandler(Formatter layout, String filename, boolean append)
throws IOException
{
this(layout, filename, append, true, 2048);
}
/**
* Instantiate a FileHandler and open the file designated by
* filename. The opened filename will become the output
* destination for this appender.
*
* The file will be appended to.
* @param layout
* @param filename
* @throws IOException
*/
public FileHandler(Formatter layout, String filename) throws IOException
{
this(layout, filename, true);
}
/**
* The File property takes a string value which should be the
* name of the file to append to.
*
* Note: Actual opening of the file is made when {@link
* #activateOptions} is called, not when the options are set.
* @param file
*/
public void setFile(String file)
{
// Trim spaces from both ends. The users probably does not want
// trailing spaces in file names.
String val = file.trim();
fileName = val;
}
/**
* Returns the value of the Append option.
* @return whether to append to the file
*/
public boolean getAppend()
{
return fileAppend;
}
/**
* Returns the value of the File option.
* @return the file name
*/
public String getFile()
{
return fileName;
}
/**
* If the value of File is not null, then {@link
* #setFile(String)} is called with the values of File and
* Append properties.
*
*/
public void activateOptions()
{
if (fileName != null)
{
try
{
setFile(fileName, fileAppend, bufferedIO, bufferSize);
}
catch (java.io.IOException e)
{
reportError("setFile(" + fileName + "," + fileAppend + ") call failed.",
e, ErrorManager.OPEN_FAILURE);
}
}
else
{
reportError("File option not set for appender [" + name + "]."
+" Are you using FileHandler instead of ConsoleAppender?",
null, ErrorManager.OPEN_FAILURE);
}
}
/**
* The Append option takes a boolean value. It is set to
* true by default. If true, then File
* will be opened in append mode by {@link #setFile(String) setFile} (see
* above). Otherwise, {@link #setFile(String) setFile} will open
* File in truncate mode.
*
* Note: Actual opening of the file is made when {@link
* #activateOptions} is called, not when the options are set.
* @param flag
*/
public void setAppend(boolean flag)
{
fileAppend = flag;
}
/**
*
Sets and opens the file where the log output will
* go. The specified file must be writable.
*
* If there was already an opened file, then the previous file
* is closed first.
*
* Do not use this method directly. To configure a FileHandler
* or one of its subclasses, set its properties one by one and then
* call activateOptions.
*
* @param fileName The path to the log file.
* @param append If true will append to fileName. Otherwise will
* truncate fileName.
* @param bufferedIO
* @param bufferSize
* @throws IOException
*/
public synchronized void setFile(String fileName, boolean append, boolean bufferedIO, int bufferSize)
throws IOException
{
// reportError("setFile called: " + fileName + ", " + append, null, ErrorManager.GENERIC_FAILURE);
super.setBufferedIO(bufferedIO);
super.setBufferSize(bufferSize);
FileOutputStream ostream = null;
try
{
// attempt to create file
ostream = new FileOutputStream(fileName, append);
}
catch (FileNotFoundException ex)
{
// if parent directory does not exist then
// attempt to create it and try to create file
String parentName = new File(fileName).getParent();
if (parentName != null)
{
File parentDir = new File(parentName);
if (!parentDir.exists() && parentDir.mkdirs())
{
ostream = new FileOutputStream(fileName, append);
}
else
{
throw ex;
}
}
else
{
throw ex;
}
}
super.setOutputStream(ostream);
this.fileName = fileName;
this.fileAppend = append;
// LogLog.debug("setFile ended");
}
}