io.graphenee.util.storage.FileStorage Maven / Gradle / Ivy

Go to download
/*******************************************************************************
 * Copyright (c) 2016, 2018 Farrukh Ijaz
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *******************************************************************************/
package io.graphenee.util.storage;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.net.URI;
import java.util.concurrent.Future;

public interface FileStorage {

	/**
	 * The default implementation of method returns "folder/fileName"
	 * 
	 * @param folder - must be a valid folder path where file needs to upload.
	 * @param filePath - file to upload.
	 * @return - depends on implementation and should return logical resource
	 * path.
	 */
	default String resourcePath(String folder, String filePath) {
		if (folder == null || filePath == null) {
			return filePath;
		}
		File file = new File(filePath);
		return folder + File.separator + file.getName();
	}

	default InputStream resolve(String resourcePath) throws ResolveFailedException {
		File file = new File(resourcePath);
		try {
			return new FileInputStream(file);
		} catch (FileNotFoundException e) {
			throw new ResolveFailedException("Failed to resolve resource " + resourcePath);
		}
	}

	boolean exists(String resourcePath);

	default boolean exists(String folder, String filePath) {
		return exists(resourcePath(folder, filePath));
	}

	default URI resolveToURI(String resourcePath) throws ResolveFailedException {
		try {
			File file = new File(resourcePath);
			return file.toURI();
		} catch (Exception e) {
			throw new ResolveFailedException("Failed to resolve resource " + resourcePath);
		}
	}

	default Future save(String folder, String fileToSave) throws SaveFailedException {
		File file = new File(fileToSave);
		if (file.isFile()) {
			try {
				FileInputStream inputStream = new FileInputStream(file);
				return save(folder, file.getName(), inputStream);
			} catch (IOException e) {
				throw new SaveFailedException(e);
			}
		}
		throw new SaveFailedException(fileToSave + " is not a file");
	}

	Future save(String folder, String fileName, InputStream inputStream) throws SaveFailedException;

	public static interface FileStorageDelegate {
		void onComplete(FileMetaData fileMetaData);
	}

	public static class FileMetaData {
		private String resourcePath;
		private int fileSize;
		private String checksum;
		private String fileName;

		public FileMetaData(String resourcePath, String fileName, int fileSize, String checksum) {
			this.resourcePath = resourcePath;
			this.fileName = fileName;
			this.fileSize = fileSize;
			this.checksum = checksum;
		}

		public String getResourcePath() {
			return resourcePath;
		}

		public String getFileName() {
			return fileName;
		}

		public void setFileName(String fileName) {
			this.fileName = fileName;
		}

		public int getFileSize() {
			return fileSize;
		}

		public void setFileSize(int fileSize) {
			this.fileSize = fileSize;
		}

		public String getChecksum() {
			return checksum;
		}

	}

}