/*
 * 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.iotdb.commons.auth.role;

import org.apache.iotdb.commons.auth.entity.Role;
import org.apache.iotdb.commons.snapshot.SnapshotProcessor;

import java.io.IOException;
import java.util.List;

/** This interface manages the serialization/deserialization of the role objects. */
public interface IRoleAccessor extends SnapshotProcessor {

  /**
   * Deserialize a role from lower storage.
   *
   * @throws IOException if IOException is raised when interacting with lower storage.
   */
  Role loadRole(String rolename) throws IOException;

  /**
   * Serialize the role object to lower storage.
   *
   * @param role The role object that is to be saved.
   * @throws IOException if IOException is raised when interacting with lower storage.
   */
  void saveRole(Role role) throws IOException;

  /**
   * Delete a role's in lower storage.
   *
   * @param rolename The name of the role to be deleted.
   * @return True if the role is successfully deleted, false if the role does not exists.
   * @throws IOException if IOException is raised when interacting with lower storage.
   */
  boolean deleteRole(String rolename) throws IOException;

  /**
   * Delete role's folders.
   *
   * @throws IOException
   */
  void cleanRoleFolder();

  /**
   * List all roles in this database.
   *
   * @return A list contains all names of the roles.
   */
  List<String> listAllRoles();

  /** Re-initialize this object. */
  void reset();
}
