filename. The opened filename will become the ouput
destination for this appender.
If the append parameter is true, the file will be
appended to. Otherwise, the file desginated by
filename will be truncated before being opened.
*/
public
RollingGZIPFileAppender(Layout layout, String filename, boolean append)
throws IOException {
super(layout, filename, append);
}
/**
Instantiate a FileAppender and open the file designated by
filename. The opened filename will become the output
destination for this appender.
The file will be appended to. */ public RollingGZIPFileAppender(Layout layout, String filename) throws IOException { super(layout, filename); } /** Returns the value of the MaxBackupIndex option. */ public int getMaxBackupIndex() { return maxBackupIndex; } /** Get the maximum size that the output file is allowed to reach before being rolled over to backup files. @since 1.1 */ public long getMaximumFileSize() { return maxFileSize; } /** Retuns the option names for this component, namely {@link #MAX_FILE_SIZE_OPTION} and {@link #MAX_BACKUP_INDEX_OPTION} in addition to the options of {@link FileAppender#getOptionStrings} @deprecated We now use JavaBeans introspection to configure components. Options strings are no longer needed. */ public String[] getOptionStrings() { return OptionConverter.concatanateArrays(super.getOptionStrings(), new String[] {MAX_FILE_SIZE_OPTION, MAX_BACKUP_INDEX_OPTION}); } /** Implements the usual roll over behaviour.
If MaxBackupIndex is positive, then files
{File.1, ..., File.MaxBackupIndex -1}
are renamed to {File.2, ...,
File.MaxBackupIndex}. Moreover, File is
renamed File.1 and closed. A new File is
created to receive further log output.
If MaxBackupIndex is equal to zero, then the
File is truncated with no backup files created.
*/
public // synchronization not necessary since doAppend is alreasy synched
void rollOver() {
File target = null;
File file = null;
LogLog.debug("rolling over count=" + ((CountingQuietWriter) qw).getCount());
LogLog.debug("maxBackupIndex="+maxBackupIndex);
// If maxBackups <= 0, then there is no file renaming to be done.
if(maxBackupIndex > 0) {
// Delete the oldest file, to keep Windows happy.
file = new File(fileName + '.' + maxBackupIndex + ".gz"); // This file is GZIPed
if (file.exists()) {
file.delete();
} else {
file = new File(fileName + '.' + maxBackupIndex); // This file is NOT GZIPped
file.delete();
}
// Map {(maxBackupIndex - 1), ..., 2, 1} to {maxBackupIndex, ..., 3, 2}
for (int i = maxBackupIndex - 1; i >= 1; i--) {
file = new File(fileName + "." + i + ".gz");
if (file.exists()) { // Rename GZIPed file
target = new File(fileName + "." + (i + 1) + ".gz");
LogLog.debug("Renaming file " + file + " to " + target);
file.renameTo(target);
} else { // Rename file even if not GZIPed.
file = new File(fileName + "." + i);
if (file.exists()) {
target = new File(fileName + "." + (i + 1));
file.renameTo(target);
}
}
}
// Rename fileName to fileName.1 No COMPRESSION
//
// gzip fileName and output to fileName.gz.1
//target = new File(fileName + "." + 1);
try {
FileInputStream fis = new FileInputStream(fileName);
BufferedInputStream br = new BufferedInputStream(fis);
FileOutputStream fo = new FileOutputStream(fileName+".1.gz");
GZIPOutputStream gz = new GZIPOutputStream(fo);
long len = fileName.length();
byte[] buffer = new byte[ 4096 ];
try {
while ( true ) {
int bytesRead = br.read( buffer );
if ( bytesRead == -1 ) break;
gz.write( buffer, 0, bytesRead );
}
gz.finish();
}
catch ( IOException e ) {
System.err.println( "Error moving data from " + br + " to " + gz );
}
finally {
try { gz.close(); } catch ( IOException ioe ) {LogLog.error("IO Error During (Close) in Log File Rollover: ", ioe);}
try { fo.close(); } catch ( IOException ioe ) {LogLog.error("IO Error During (Close) in Log File Rollover: ", ioe);}
try { br.close(); } catch ( IOException ioe ) {LogLog.error("IO Error During (Close) in Log File Rollover: ", ioe);}
try { fis.close();} catch ( IOException ioe ) {LogLog.error("IO Error During (Close) in Log File Rollover: ", ioe);}
}
} catch (FileNotFoundException fnf) {
LogLog.error("File Not Found During Log File Rollover: "+fileName, fnf);
} catch (IOException ioe) {
LogLog.error("IO Error During Log File Rollover: ", ioe);
}
this.closeFile(); // keep windows happy.
file = new File(fileName); // Create new file after roll-over
}
try {
// This will also close the file. This is OK since multiple
// close operations are safe.
this.setFile(fileName, false);
}
catch(IOException e) {
LogLog.error("setFile("+fileName+", false) call failed.", e);
}
}
public
synchronized
void setFile(String fileName, boolean append) throws IOException {
super.setFile(fileName, append);
if(append) {
File f = new File(fileName);
((CountingQuietWriter) qw).setCount(f.length());
}
}
/**
@deprecated Use the setter method for the option directly instead
of the generic setOption method.
*/
public
void setOption(String key, String value) {
super.setOption(key, value);
if(key.equalsIgnoreCase(MAX_FILE_SIZE_OPTION)) {
maxFileSize = OptionConverter.toFileSize(value, maxFileSize + 1);
}
else if(key.equalsIgnoreCase(MAX_BACKUP_INDEX_OPTION)) {
maxBackupIndex = OptionConverter.toInt(value, maxBackupIndex);
}
}
/**
Set the maximum number of backup files to keep around.
The MaxBackupIndex option determines how many backup
files are kept before the oldest is erased. This option takes
a positive integer value. If set to zero, then there will be no
backup files and the log file will be truncated when it reaches
MaxFileSize.
*/
public
void setMaxBackupIndex(int maxBackups) {
this.maxBackupIndex = maxBackups;
}
/**
Set the maximum size that the output file is allowed to reach
before being rolled over to backup files.
@deprecated Use {@link #setMaximumFileSize} instead.
*/
public
void setMaxFileSize(long maxFileSize) {
this.maxFileSize = maxFileSize;
}
/**
Set the maximum size that the output file is allowed to reach
before being rolled over to backup files.
This method is equivalent to {@link #setMaxFileSize} except
that it is required for differentiating the setter taking a
long argument from the setter taking a
String argument by the JavaBeans {@link
java.beans.Introspector Introspector}.
@see #setMaxFileSize(String)
*/
public
void setMaximumFileSize(long maxFileSize) {
this.maxFileSize = maxFileSize;
}
/**
Set the maximum size that the output file is allowed to reach
before being rolled over to backup files.
In configuration files, the MaxFileSize option takes an long integer in the range 0 - 2^63. You can specify the value with the suffixes "KB", "MB" or "GB" so that the integer is interpreted being expressed respectively in kilobytes, megabytes or gigabytes. For example, the value "10KB" will be interpreted as 10240. */ public void setMaxFileSize(String value) { maxFileSize = OptionConverter.toFileSize(value, maxFileSize + 1); } protected void setQWForFiles(Writer writer) { this.qw = new CountingQuietWriter(writer, errorHandler); } /** This method differentiates RollingFileAppender from its super class. @since 0.9.0 */ protected void subAppend(LoggingEvent event) { super.subAppend(event); if((fileName != null) && ((CountingQuietWriter) qw).getCount() >= maxFileSize) this.rollOver(); } }