org.apache.pulsar.packages.management.core.PackagesStorage Maven / Gradle / Ivy
/**
* 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.pulsar.packages.management.core;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.List;
import java.util.concurrent.CompletableFuture;
public interface PackagesStorage {
/**
* Initialize the packages management service with the given storage.
*/
void initialize();
/**
* Write a input stream to a path.
*
* @param path
* file path
* @param inputStream
* the input file stream
* @return
*/
CompletableFuture writeAsync(String path, InputStream inputStream);
/**
* Read a file to a output stream.
*
* @param path
* file path
* @param outputStream
* the output file stream
* @return
*/
CompletableFuture readAsync(String path, OutputStream outputStream);
/**
* Delete a file.
*
* @param path
* file path
* @return
*/
CompletableFuture deleteAsync(String path);
/**
* List all the file under a path.
*
* @param path
* file path
* @return
*/
CompletableFuture> listAsync(String path);
/**
* Check the file is or not exists.
*
* @param path
* file path
* @return
*/
CompletableFuture existAsync(String path);
/**
* Close storage asynchronously.
*
* @return
*/
CompletableFuture closeAsync();
}