org.apache.ratis.server.storage.RaftStorageMetadataFile Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of ratis-server-api Show documentation

There is a newer version: 3.1.0

/*
 * 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.ratis.server.storage;

import java.io.IOException;

/**
 * Represent a file on disk which persistently stores the metadata of a raft storage.
 * The file is updated atomically.
 */
public interface RaftStorageMetadataFile {
  /** @return the metadata persisted in this file. */
  RaftStorageMetadata getMetadata() throws IOException;

  /** Persist the given metadata. */
  void persist(RaftStorageMetadata newMetadata) throws IOException;
}