org.apache.logging.log4j.core.appender.routing

Class IdlePurgePolicy

java.lang.Object

org.apache.logging.log4j.core.AbstractLifeCycle

org.apache.logging.log4j.core.appender.routing.IdlePurgePolicy

All Implemented Interfaces:

Serializable, Runnable, PurgePolicy, LifeCycle

@Plugin(name="IdlePurgePolicy",
        category="Core",
        printObject=true)
@Scheduled
public class IdlePurgePolicy
extends AbstractLifeCycle
implements PurgePolicy, Runnable

Policy is purging appenders that were not in use specified time in minutes

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.LifeCycle

LifeCycle.State

Constructor Summary

Constructors

Constructor and Description
IdlePurgePolicy(long timeToLive, ConfigurationScheduler scheduler)

Method Summary

Methods

Modifier and Type	Method and Description
static PurgePolicy	createPurgePolicy(String timeToLive, String timeUnit, Configuration configuration) Create the PurgePolicy
void	initialize(RoutingAppender routingAppender) Initialize with routing appender
void	purge() Purging appenders that were not in use specified time
void	run()
void	stop()
String	toString()
void	update(String key, LogEvent event)

Methods inherited from class org.apache.logging.log4j.core.AbstractLifeCycle

equalsImpl, getState, hashCodeImpl, initialize, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping, start

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IdlePurgePolicy

public IdlePurgePolicy(long timeToLive,
               ConfigurationScheduler scheduler)

Method Detail

initialize

public void initialize(RoutingAppender routingAppender)

Description copied from interface: PurgePolicy

Initialize with routing appender

Specified by:

initialize in interface PurgePolicy

stop

public void stop()

Specified by:

stop in interface LifeCycle

Overrides:

stop in class AbstractLifeCycle

purge

public void purge()

Purging appenders that were not in use specified time

Specified by:

purge in interface PurgePolicy

update

public void update(String key,
          LogEvent event)

Specified by:

update in interface PurgePolicy

run

public void run()

Specified by:

run in interface Runnable

createPurgePolicy

@PluginFactory
public static PurgePolicy createPurgePolicy(@PluginAttribute(value="timeToLive")
                                          String timeToLive,
                                          @PluginAttribute(value="timeUnit")
                                          String timeUnit,
                                          @PluginConfiguration
                                          Configuration configuration)

Create the PurgePolicy

Parameters:

timeToLive - the number of increments of timeUnit before the Appender should be purged.

timeUnit - the unit of time the timeToLive is expressed in.

Returns:

The Routes container.

toString

public String toString()

Overrides:

toString in class Object