step.grid.filemanager.FileManagerClient 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;

/**
 * Interface for {@link FileManager} clients 
 * 
 * A {@link FileManagerClient} is responsible for the retrieval and caching of 
 * {@link FileVersion} objects on the client side.
 * 
 * On the server side, {@link FileVersion} objects are served by a {@link FileManager}
 *
 */
public interface FileManagerClient extends AutoCloseable {

	/**
	 * Request the specific version of a file.
	 * 
	 * @param fileVersionId the version of the File to be retrieved
	 * @param cleanableFromClientCache if this version of the file can be cleaned-up from the client cache at runtime. Refer to the cleanup job for details {@link AbstractFileManager#scheduleCleanupJob() }
	 * @return the {@link FileVersion} corresponding to the version specified or null if the version isn't available
	 * @throws FileManagerException
	 */
	FileVersion requestFileVersion(FileVersionId fileVersionId, boolean cleanableFromClientCache) throws FileManagerException;
	
	/**
	 * Delete a specific version of a file from the cache
	 * 
	 * @param fileVersionId the version of the File to be removed from the cache
	 */
	void removeFileVersionFromCache(FileVersionId fileVersionId);

	/**
	 * Removes all cache entries of this cache
	 */
	public void cleanupCache();

}