step.grid.filemanager.FileManagerConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of step-grid-api Show documentation
There is a newer version: 2.2.0
/*******************************************************************************
 * Copyright (C) 2020, exense GmbH
 *
 * This file is part of STEP
 *
 * STEP is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * STEP is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with STEP.  If not, see .
 ******************************************************************************/
package step.grid.filemanager;

import java.util.concurrent.TimeUnit;

public class FileManagerConfiguration {

	private TimeUnit configurationTimeUnit = TimeUnit.MINUTES;

	private long cleanupLastAccessTimeThresholdMinutes = 120;

	private boolean cleanupJobEnabled = true;

	private long cleanupIntervalMinutes = 60;

	public FileManagerConfiguration() {
	}

	/**
	 * @return the period of time in minutes since the last access of a cached file before it becomes eligible for cleanup. Refer to the cleanup job for details {@link AbstractFileManager#scheduleCleanupJob() }
	 */
	public long getCleanupLastAccessTimeThresholdMinutes() {
		return cleanupLastAccessTimeThresholdMinutes;
	}

	public void setCleanupLastAccessTimeThresholdMinutes(long cleanupLastAccessTimeThresholdMinutes) {
		this.cleanupLastAccessTimeThresholdMinutes = cleanupLastAccessTimeThresholdMinutes;
	}

	/**
	 * @return whether the {@link AbstractFileManager#scheduleCleanupJob() cleanup job} should be enabled
	 */
	public boolean isCleanupJobEnabled() {
		return cleanupJobEnabled;
	}

	public void setCleanupJobEnabled(boolean cleanupJobEnabled) {
		this.cleanupJobEnabled = cleanupJobEnabled;
	}

	/**
	 * @return the frequency of cleanup job in minutes. Refer to {@link AbstractFileManager#scheduleCleanupJob() } for more details
	 */
	public long getCleanupIntervalMinutes() {
		return cleanupIntervalMinutes;
	}

	public void setCleanupIntervalMinutes(long cleanupIntervalMinutes) {
		this.cleanupIntervalMinutes = cleanupIntervalMinutes;
	}

	public TimeUnit getConfigurationTimeUnit() {
		return configurationTimeUnit;
	}

	/**
	 * Change the time unit used for the cleanup scheduled job for junit tests, default time unit is Minutes
	 * @param configurationTimeUnit
	 */
	protected void setConfigurationTimeUnit(TimeUnit configurationTimeUnit) {
		this.configurationTimeUnit = configurationTimeUnit;
	}
}