com.hazelcast.internal.partition.impl.PartitionStateManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hazelcast-jdbc Show documentation
Hazelcast JDBC Driver
The newest version!
/*
 * Copyright (c) 2008-2024, Hazelcast, Inc. All Rights Reserved.
 *
 * 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 com.hazelcast.internal.partition.impl;

import com.hazelcast.cluster.Address;
import com.hazelcast.cluster.ClusterState;
import com.hazelcast.cluster.Member;
import com.hazelcast.core.HazelcastException;
import com.hazelcast.instance.impl.NodeExtension;
import com.hazelcast.internal.cluster.ClusterService;
import com.hazelcast.internal.partition.InternalPartition;
import com.hazelcast.internal.partition.PartitionReplica;
import com.hazelcast.internal.partition.PartitionReplicaInterceptor;
import com.hazelcast.internal.partition.PartitionTableView;
import com.hazelcast.internal.util.collection.PartitionIdSet;

import java.util.Collection;
import java.util.Set;
import java.util.UUID;

public interface PartitionStateManager {

    /**
     * Initial value of the partition table stamp.
     * If stamp has this initial value then that means
     * partition table is not initialized yet.
     */
    long INITIAL_STAMP = 0L;

    /**
     * @return {@code true} if there are partitions having {@link
     * InternalPartitionImpl#isMigrating()} flag set, {@code false} otherwise.
     */
    boolean hasMigratingPartitions();

    /**
     * Arranges the partitions if:
     * 
     * this instance {@link NodeExtension#isStartCompleted()}
     * the cluster state allows migrations. See {@link ClusterState#isMigrationAllowed()}
     * 
     * This will also set the manager state to initialized (if not already) and invoke the
     * {@link DefaultPartitionReplicaInterceptor} for all changed replicas which
     * will cancel replica synchronizations and increase the partition state version.
     *
     * @param excludedMembers members which are to be excluded from the new layout
     * @return if the new partition was assigned
     * @throws HazelcastException if the partition state generator failed to arrange the partitions
     */
    boolean initializePartitionAssignments(Set excludedMembers);

    /**
     * Called after a batch of partition replica assignments have been applied. This is an optimization for batch
     * changes, to avoid repeatedly performing costly computations (like updating partition assignments stamp).
     * 
     * If this logic changes, consider also changing the implementation of
     * {@link PartitionReplicaInterceptor#replicaChanged(int, int, PartitionReplica, PartitionReplica)}, which should apply
     * the same logic per partition.
     * 
     *
     * @param partitionIdSet
     */
    void partitionOwnersChanged(PartitionIdSet partitionIdSet);

    /**
     * Sets the initial partition table and state version. If any partition has a replica, the partition state manager is
     * set to initialized, otherwise {@link #isInitialized()} stays uninitialized but the current state will be updated
     * nevertheless.
     *
     * @param partitionTable the initial partition table
     * @throws IllegalStateException if the partition manager has already been initialized
     */
    void setInitialState(PartitionTableView partitionTable);

    void updateMemberGroupsSize();

    int getMemberGroupsSize();

    /**
     * Checks all replicas for all partitions. If the cluster service does not contain the member or the member
     * is a lite member for any address in the partition table, it will remove the address from the partition.
     *
     * @see ClusterService#getMember(Address, UUID)
     */
    void removeUnknownAndLiteMembers();

    boolean isAbsentInPartitionTable(Member member);

    InternalPartition[] getPartitions();


    /**
     * Returns a copy of the current partition table.
     */
    InternalPartition[] getPartitionsCopy(boolean readonly);

    InternalPartitionImpl getPartitionImpl(int partitionId);

    PartitionReplica[][] repartition(Set excludedMembers, Collection partitionInclusionSet);

    boolean trySetMigratingFlag(int partitionId);

    void clearMigratingFlag(int partitionId);

    boolean isMigrating(int partitionId);

    void updateStamp();

    long getStamp();

    int getPartitionVersion(int partitionId);

    /**
     * Increments partition version by delta and updates partition state stamp.
     */
    void incrementPartitionVersion(int partitionId, int delta);

    boolean setInitialized();

    boolean isInitialized();

    void reset();

    int replaceMember(Member oldMember, Member newMember);

    PartitionTableView getPartitionTable();

    void storeSnapshot(UUID crashedMemberUuid);

    Collection snapshots();

    PartitionTableView getSnapshot(UUID crashedMemberUuid);

    void removeSnapshot(UUID memberUuid);

    /** For test usage only */
    void setReplicaUpdateInterceptor(ReplicaUpdateInterceptor interceptor);

    interface ReplicaUpdateInterceptor {
        void onPartitionOwnersChanged();
        void onPartitionStampUpdate();
    }
}