org.apache.log4j.varia: public class: ExternallyRolledFileAppender

org.apache.log4j.varia
public class: ExternallyRolledFileAppender [javadoc | source]

java.lang.Object
   org.apache.log4j.AppenderSkeleton
      org.apache.log4j.WriterAppender
         org.apache.log4j.FileAppender
            org.apache.log4j.RollingFileAppender
               org.apache.log4j.varia.ExternallyRolledFileAppender

All Implemented Interfaces:
OptionHandler, Appender

This appender listens on a socket on the port specified by the Port property for a "RollOver" message. When such a message is received, the underlying log file is rolled over and an acknowledgment message is sent back to the process initiating the roll over.

This method of triggering roll over has the advantage of being operating system independent, fast and reliable.

A simple application Roller is provided to initiate the roll over.

Note that the initiator is not authenticated. Anyone can trigger a rollover. In production environments, it is recommended that you add some form of protection to prevent undesired rollovers.

author: Ceki - Gülcü

since: version - 0.9.0

Field Summary
public static final String	ROLL_OVER	The string constant sent to initiate a roll over. Current value of this string constant is RollOver.
public static final String	OK	The string constant sent to acknowledge a roll over. Current value of this string constant is OK.
int	port
HUP	hup

Fields inherited from org.apache.log4j.RollingFileAppender:
maxFileSize, maxBackupIndex

Fields inherited from org.apache.log4j.FileAppender:
fileAppend, fileName, bufferedIO, bufferSize

Fields inherited from org.apache.log4j.WriterAppender:
immediateFlush, encoding, qw

Fields inherited from org.apache.log4j.AppenderSkeleton:
layout, name, threshold, errorHandler, headFilter, tailFilter, closed

Constructor:
public ExternallyRolledFileAppender() { } The default constructor does nothing but calls its super-class constructor.

Constructor:

 public ExternallyRolledFileAppender() {

}

The default constructor does nothing but calls its super-class constructor.

Method from org.apache.log4j.varia.ExternallyRolledFileAppender Summary:
activateOptions, getPort, setPort

Methods from org.apache.log4j.RollingFileAppender:
getMaxBackupIndex, getMaximumFileSize, rollOver, setFile, setMaxBackupIndex, setMaxFileSize, setMaximumFileSize, setQWForFiles, subAppend

Methods from org.apache.log4j.FileAppender:
activateOptions, closeFile, getAppend, getBufferSize, getBufferedIO, getFile, reset, setAppend, setBufferSize, setBufferedIO, setFile, setFile, setQWForFiles

Methods from org.apache.log4j.WriterAppender:
activateOptions, append, checkEntryConditions, close, closeWriter, createWriter, getEncoding, getImmediateFlush, requiresLayout, reset, setEncoding, setErrorHandler, setImmediateFlush, setWriter, subAppend, writeFooter, writeHeader

Methods from org.apache.log4j.AppenderSkeleton:
activateOptions, addFilter, append, clearFilters, doAppend, finalize, getErrorHandler, getFilter, getFirstFilter, getLayout, getName, getThreshold, isAsSevereAsThreshold, setErrorHandler, setLayout, setName, setThreshold

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.apache.log4j.varia.ExternallyRolledFileAppender Detail:
public void activateOptions() { super.activateOptions(); if(port != 0) { if(hup != null) { hup.interrupt(); } hup = new HUP(this, port); hup.setDaemon(true); hup.start(); } } Start listening on the port specified by a preceding call to #setPort .
public int getPort() { return port; } Returns value of the Port option.
public void setPort(int port) { this.port = port; } The Port [roperty is used for setting the port for listening to external roll over messages.

Method from org.apache.log4j.varia.ExternallyRolledFileAppender Detail:

 public  void activateOptions() {
    super.activateOptions();
    if(port != 0) {
      if(hup != null) {
	hup.interrupt();
      }
      hup = new HUP(this, port);
      hup.setDaemon(true);
      hup.start();
    }
}

#setPort

 public int getPort() {
    return port;
}

Port

 public  void setPort(int port) {
    this.port = port;
}

Port