org.apache.log4j.varia

Class ExternallyRolledFileAppender

public class ExternallyRolledFileAppender extends RollingFileAppender

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.

Since: version 0.9.0

Author: Ceki Gülcü

Field Summary
static StringOK
The string constant sent to acknowledge a roll over.
static StringROLL_OVER
The string constant sent to initiate a roll over.
Constructor Summary
ExternallyRolledFileAppender()
The default constructor does nothing but calls its super-class constructor.
Method Summary
voidactivateOptions()
Start listening on the port specified by a preceding call to ExternallyRolledFileAppender.
intgetPort()
Returns value of the Port option.
voidsetPort(int port)
The Port [roperty is used for setting the port for listening to external roll over messages.

Field Detail

OK

public static final String OK
The string constant sent to acknowledge a roll over. Current value of this string constant is OK.

ROLL_OVER

public static final String ROLL_OVER
The string constant sent to initiate a roll over. Current value of this string constant is RollOver.

Constructor Detail

ExternallyRolledFileAppender

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

Method Detail

activateOptions

public void activateOptions()
Start listening on the port specified by a preceding call to ExternallyRolledFileAppender.

getPort

public int getPort()
Returns value of the Port option.

setPort

public void setPort(int port)
The Port [roperty is used for setting the port for listening to external roll over messages.
Copyright 2000-2005 Apache Software Foundation.