content: /*
   * 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.asterix.common.storage;
  
  import java.util.List;
  import java.util.Set;
  
  import org.apache.asterix.common.replication.IPartitionReplica;
  import org.apache.hyracks.api.exceptions.HyracksDataException;
  
  public interface IReplicaManager {
  
      /**
       * Adds a replica with the specified {@code id}
       *
       * @param id
       */
      void addReplica(ReplicaIdentifier id);
  
      /**
       * Removes the replica with the specified {@code id}
       *
       * @param id
       */
      void removeReplica(ReplicaIdentifier id);
  
      /**
       * The existing replicas of the partition {@code partition}
       *
       * @param partition
       * @return The list of replicas
       */
      List<IPartitionReplica> getReplicas(int partition);
  
      /**
       * Gets the list of partition to which the current node is
       * the master of.
       *
       * @return The list of partition
       */
      Set<Integer> getPartitions();
  
      /**
       * Sets the node active partitions
       *
       * @param activePartitions
       */
      void setActivePartitions(Set<Integer> activePartitions);
  
      /**
       * Promotes a partition by making this node its master replica
       *
       * @param partition
       */
      void promote(int partition) throws HyracksDataException;
  
      /**
       * Releases a partition by flushing all its resources to disk
       * then removing all partition replicas.
       *
       * @param partition
       * @throws HyracksDataException
       */
      void release(int partition) throws HyracksDataException;
  
      /**
       * A lock that can be used to ensure a single partition replica is being synchronized at a time
       * by this {@link IReplicaManager}
       *
       * @param partition partition
       *
       * @return the synchronization lock
       */
      Object getPartitionSyncLock(int partition);
  
      /**
       * Gets the partition replicas matching {@code id}
       * @param id
       * @return The partition replica if found. Otherwise, null.
       */
      IPartitionReplica getReplica(ReplicaIdentifier id);
  
      /**
       * Gets the list of replicas
       *
       * @return the list of replicas
       */
      List<IPartitionReplica> getReplicas();
  
      /**
       * Returns true if {@code partition} is originated by this node, otherwise false.
       *
       * @param partition
       * @return true if the partition is originated by this node, otherwise false.
       */
      boolean isPartitionOrigin(int partition);
  }
  