/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.hertzbeat.manager.service;

import java.io.InputStream;
import java.util.List;
import org.apache.hertzbeat.manager.pojo.dto.FileDTO;
import org.apache.hertzbeat.manager.pojo.dto.ObjectStoreDTO;

/**
 * File storage service
 */
public interface ObjectStoreService {

    /**
     * save file
     * @param filePath file path，eg：hertzbeat/111.json
     * @param is       input stream
     */
    boolean upload(String filePath, InputStream is);

    /**
     * remove file
     * @param filePath file path，eg：hertzbeat/111.json
     */
    void remove(String filePath);

    /**
     * whether the file exists
     * @param filePath file path，eg：hertzbeat/111.json
     */
    boolean isExist(String filePath);

    /**
     * read file
     * @param filePath file path，eg：hertzbeat/111.json
     * @return file
     */
    FileDTO download(String filePath);

    /**
     * Enumeration file
     * @param dir file catalog
     * @return file list
     */
    List<FileDTO> list(String dir);

    ObjectStoreDTO.Type type();

}
