001/*
002 * (C) Copyright 2011-2014 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Florent Guillaume
018 */
019package org.nuxeo.ecm.core.blob.binary;
020
021import java.io.File;
022import java.io.IOException;
023
024/**
025 * Interface to store a file or fetch a file or its length.
026 *
027 * @since 5.9.2
028 */
029public interface FileStorage {
030
031    /**
032     * Stores a file based on a key.
033     *
034     * @param key the file key
035     * @param file the file
036     * @throws IOException if a storage error occurred
037     */
038    void storeFile(String key, File file) throws IOException;
039
040    /**
041     * Fetches a file based on its key.
042     *
043     * @param key the file key
044     * @param file the file to use to store the fetched data
045     * @return {@code true} if the file was fetched, {@code false} if the file was not found
046     * @throws IOException if a storage error occurred
047     */
048    boolean fetchFile(String key, File file) throws IOException;
049
050    /**
051     * Fetches the length of a file based on its key.
052     *
053     * @param key the file key
054     * @return the length, or {@code null} if the file was not found
055     * @throws IOException if a storage error occurred
056     */
057    Long fetchLength(String key) throws IOException;
058
059}