nstream.persist.store.snapshot.SnapshotWriter Maven / Gradle / Ivy
// Copyright 2015-2024 Nstream, inc.
//
// 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 nstream.persist.store.snapshot;
/**
* A writer to create a new snapshot. Files are added to the snapshot be repeatedly calling
* {@link #pushFile(String, FileSupplier)}. After {@link #close()} is called and completes successfully,
* the snapshot is committed and added to the repository.
*/
public interface SnapshotWriter extends SnapshotResource {
/**
* Add a file to the snapshot.
* @param name The name of the file.
* @param file The contents of the file.
* @throws SnapshotException Failed to write the file to the snapshot.
*/
void pushFile(String name, FileSupplier file) throws SnapshotException;
}