Package org.kiwiproject.dropwizard.config

Class TimeBasedDirectoryCleanerConfig

java.lang.Object

org.kiwiproject.dropwizard.config.TimeBasedDirectoryCleanerConfig

public class TimeBasedDirectoryCleanerConfig
extends Object

A (Dropwizard) configuration class to configure and schedule a TimeBasedDirectoryCleaner.

Field Summary

Fields

Modifier and Type	Field	Description
static io.dropwizard.util.Duration	DEFAULT_INITIAL_DELAY_MILLIS
static io.dropwizard.util.Duration	SHUTDOWN_DURATION

Constructor Summary

Constructors

Constructor	Description
TimeBasedDirectoryCleanerConfig()

Method Summary

Modifier and Type	Method	Description
TimeBasedDirectoryCleaner	scheduleCleanupUsing(io.dropwizard.setup.Environment environment)	Schedules directory cleanup and registers a TimeBasedDirectoryCleanerHealthCheck health check using the given Environment, returning the TimeBasedDirectoryCleaner instance that was scheduled.
TimeBasedDirectoryCleaner	scheduleCleanupUsing(ScheduledExecutorService cleanupExecutor)	Schedules directory cleanup using the given ScheduledExecutorService, returning the TimeBasedDirectoryCleaner instance that was scheduled.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_INITIAL_DELAY_MILLIS

public static final io.dropwizard.util.Duration DEFAULT_INITIAL_DELAY_MILLIS

SHUTDOWN_DURATION

public static final io.dropwizard.util.Duration SHUTDOWN_DURATION

Constructor Detail

TimeBasedDirectoryCleanerConfig

public TimeBasedDirectoryCleanerConfig()

Method Detail

scheduleCleanupUsing

public TimeBasedDirectoryCleaner scheduleCleanupUsing(ScheduledExecutorService cleanupExecutor)

Schedules directory cleanup using the given ScheduledExecutorService, returning the TimeBasedDirectoryCleaner instance that was scheduled. It can then be used to retrieve delete error information.

Parameters:

cleanupExecutor - the scheduled executor to use

Returns:

a new TimeBasedDirectoryCleaner using the given executor

Implementation Note:

It is assumed that the ScheduledExecutorService is externally managed and has only one thread.

scheduleCleanupUsing

public TimeBasedDirectoryCleaner scheduleCleanupUsing(io.dropwizard.setup.Environment environment)

Schedules directory cleanup and registers a TimeBasedDirectoryCleanerHealthCheck health check using the given Environment, returning the TimeBasedDirectoryCleaner instance that was scheduled. It can then be used to retrieve delete error information.

Parameters:

environment - the Dropwizard Environment to use

Returns:

a new TimeBasedDirectoryCleaner using the given environment