InternalPartitionServiceImpl (Hazelcast Root 3.10 API)

java.lang.Object
- com.hazelcast.internal.partition.impl.InternalPartitionServiceImpl

All Implemented Interfaces:

ClusterStateListener, ClusterVersionListener, InternalPartitionService, CoreService, EventPublishingService<PartitionEvent,PartitionEventListener<PartitionEvent>>, ManagedService, IPartitionService, PartitionAwareService
```
public class InternalPartitionServiceImpl
extends Object
implements InternalPartitionService, ManagedService, EventPublishingService<PartitionEvent,PartitionEventListener<PartitionEvent>>, PartitionAwareService, ClusterStateListener, ClusterVersionListener
```
The InternalPartitionService implementation.

Field Summary
- Fields inherited from interface com.hazelcast.internal.partition.InternalPartitionService
  MIGRATION_EVENT_TOPIC, MIGRATION_RETRY_COUNT, MIGRATION_RETRY_PAUSE, PARTITION_LOST_EVENT_TOPIC
- Fields inherited from interface com.hazelcast.spi.partition.IPartitionService
  SERVICE_NAME

Constructor Summary

Constructors
Constructor and Description

InternalPartitionServiceImpl(Node node)

Constructors
Constructor and Description
`InternalPartitionServiceImpl(Node node)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`addLocalPartitionLostListener(PartitionLostListener listener)`
`String`	`addMigrationListener(MigrationListener listener)`
`void`	`addPartitionListener(PartitionListener listener)`
`String`	`addPartitionLostListener(PartitionLostListener listener)`
`PartitionRuntimeState`	`createPartitionState()` Creates the current partition runtime state.
`PartitionRuntimeState`	`createPartitionStateInternal()` Returns a copy of the partition table or `null` if not initialized.
`PartitionTableView`	`createPartitionTableView()`
`void`	`dispatchEvent(PartitionEvent partitionEvent, PartitionEventListener partitionEventListener)` Notifies the service of a published event.
`void`	`firstArrangement()` Causes the partition table to be arranged and published to members if : the instance has started the cluster is `ClusterState.ACTIVE` if it has not already been arranged if there is no cluster membership change If this node is not the master, it will trigger the master to assign the partitions.
`InternalMigrationListener`	`getInternalMigrationListener()`
`InternalPartition[]`	`getInternalPartitions()`
`int`	`getMaxAllowedBackupCount()` Returns maximum allowed backup count according to current cluster formation and partition group configuration.
`int`	`getMemberGroupsSize()`
`List<Integer>`	`getMemberPartitions(Address target)` Returns partition ID list assigned to given target.
`List<Integer>`	`getMemberPartitionsIfAssigned(Address target)` Returns partition ID list assigned to given target if partitions are assigned when method is called.
`Map<Address,List<Integer>>`	`getMemberPartitionsMap()` Gets member partition IDs.
`MigrationManager`	`getMigrationManager()`
`long`	`getMigrationQueueSize()`
`List<ReplicaFragmentSyncInfo>`	`getOngoingReplicaSyncRequests()`
`InternalPartition`	`getPartition(int partitionId)` Returns the `IPartition` for a given partition ID.
`InternalPartition`	`getPartition(int partitionId, boolean triggerOwnerAssignment)` Returns the `IPartition` for a given partition ID.
`int`	`getPartitionCount()` Returns the number of partitions.
`PartitionEventManager`	`getPartitionEventManager()`
`int`	`getPartitionId(Data key)` Returns the partition ID for a `Data` key.
`int`	`getPartitionId(Object key)` Returns the partition ID for a given object.
`long`	`getPartitionMigrationTimeout()`
`Address`	`getPartitionOwner(int partitionId)` Gets the owner of the partition if it's set.
`Address`	`getPartitionOwnerOrWait(int partitionId)` Gets the owner of the partition.
`PartitionReplicaStateChecker`	`getPartitionReplicaStateChecker()`
`PartitionReplicaVersionManager`	`getPartitionReplicaVersionManager()`
`IPartition[]`	`getPartitions()` Returns an array of `IPartition` instances.
`PartitionServiceProxy`	`getPartitionServiceProxy()`
`PartitionStateManager`	`getPartitionStateManager()`
`int`	`getPartitionStateVersion()`
`PartitionReplicaManager`	`getReplicaManager()`
`List<ScheduledEntry<ReplicaFragmentSyncInfo,Void>>`	`getScheduledReplicaSyncRequests()`
`boolean`	`hasOnGoingMigration()` Checks if there are any cluster-wide migrations.
`boolean`	`hasOnGoingMigrationLocal()` Checks if there are any local migrations.
`void`	`init(NodeEngine nodeEngine, Properties properties)` Initializes this service.
`boolean`	`isMemberAllowedToJoin(Address address)`
`boolean`	`isMemberStateSafe()` Queries and returns if this member in a safe state or not.
`boolean`	`isMigrationAllowed()`
`boolean`	`isPartitionOwner(int partitionId)` Check if this node is the owner of a partition.
`void`	`memberAdded(MemberImpl member)`
`void`	`memberRemoved(MemberImpl member)`
`void`	`onClusterStateChange(ClusterState newState)` Called when cluster state is changed
`void`	`onClusterVersionChange(Version newVersion)` Invoked on registered listeners after the new cluster version has been applied.
`void`	`onPartitionLost(IPartitionLostEvent event)` Invoked when a partition lost is detected
`void`	`onShutdownRequest(Address address)`
`void`	`onShutdownResponse()`
`void`	`pauseMigration()` Pause all migrations
`boolean`	`prepareToSafeShutdown(long timeout, TimeUnit unit)`
`boolean`	`processPartitionRuntimeState(PartitionRuntimeState partitionState)` Sets the `partitionState` if the node is started and the state is sent by the master known by this node.
`boolean`	`removeMigrationListener(String registrationId)`
`boolean`	`removePartitionLostListener(String registrationId)`
`void`	`replaceAddress(Address oldAddress, Address newAddress)`
`void`	`reset()` Resets this service back to its initial state.
`void`	`resetInternalMigrationListener()`
`void`	`resumeMigration()` Resume all migrations
`void`	`setInitialState(PartitionTableView partitionTable)` Sets the initial partition table and state version.
`void`	`setInternalMigrationListener(InternalMigrationListener listener)`
`void`	`shutdown(boolean terminate)` Shuts down this service.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - InternalPartitionServiceImpl
```
public InternalPartitionServiceImpl(Node node)
```
- Method Detail
  - init
```
public void init(NodeEngine nodeEngine,
                 Properties properties)
```
    Description copied from interface: ManagedService
    
    Initializes this service.
    
    Specified by:
    
    init in interface ManagedService
    
    Parameters:
    
    nodeEngine - the NodeEngine that this service belongs to
    
    properties - the Properties (can be used to pass settings to the service)
  - getPartitionOwner
```
public Address getPartitionOwner(int partitionId)
```
    Description copied from interface: IPartitionService
    
    Gets the owner of the partition if it's set.
    If the owner of the partition is not set yet, it will trigger partition assignment.
    
    Specified by:
    
    getPartitionOwner in interface IPartitionService
    
    Parameters:
    
    partitionId - the partitionId
    
    Returns:
    
    owner of partition or null if it's not set yet
  - getPartitionOwnerOrWait
```
public Address getPartitionOwnerOrWait(int partitionId)
```
    Description copied from interface: IPartitionService
    
    Gets the owner of the partition.
    If none is set, it will wait till the owner is set.
    
    Specified by:
    
    getPartitionOwnerOrWait in interface IPartitionService
    
    Parameters:
    
    partitionId - the partitionId
    
    Returns:
    
    owner of partition
  - firstArrangement
```
public void firstArrangement()
```
    Description copied from interface: InternalPartitionService
    Causes the partition table to be arranged and published to members if :
    - the instance has started
    - the cluster is ClusterState.ACTIVE
    - if it has not already been arranged
    - if there is no cluster membership change
    If this node is not the master, it will trigger the master to assign the partitions.
    Specified by:
    
    firstArrangement in interface InternalPartitionService
    
    See Also:
    
    PartitionStateManager.initializePartitionAssignments(java.util.Set)
  - setInitialState
```
public void setInitialState(PartitionTableView partitionTable)
```
    Sets the initial partition table and state version. If any partition has a replica, the partition state manager is set to initialized, otherwise #partitionStateManager#isInitialized() stays uninitialized but the current state will be updated nevertheless. This method acquires the partition service lock.
    
    Parameters:
    
    partitionTable - the initial partition table
    
    Throws:
    
    IllegalStateException - if the partition manager has already been initialized
  - getMemberGroupsSize
```
public int getMemberGroupsSize()
```
    Specified by:
    
    getMemberGroupsSize in interface InternalPartitionService
  - getMaxAllowedBackupCount
```
public int getMaxAllowedBackupCount()
```
    Description copied from interface: IPartitionService
    
    Returns maximum allowed backup count according to current cluster formation and partition group configuration.
    The returned number will be in the range of [0, IPartition.MAX_BACKUP_COUNT].
    
    Specified by:
    
    getMaxAllowedBackupCount in interface IPartitionService
    
    Returns:
    
    max allowed backup count
  - isMemberAllowedToJoin
```
public boolean isMemberAllowedToJoin(Address address)
```
    Specified by:
    
    isMemberAllowedToJoin in interface InternalPartitionService
  - memberAdded
```
public void memberAdded(MemberImpl member)
```
    Specified by:
    
    memberAdded in interface InternalPartitionService
  - memberRemoved
```
public void memberRemoved(MemberImpl member)
```
    Specified by:
    
    memberRemoved in interface InternalPartitionService
  - onClusterStateChange
```
public void onClusterStateChange(ClusterState newState)
```
    Description copied from interface: ClusterStateListener
    
    Called when cluster state is changed
    
    Specified by:
    
    onClusterStateChange in interface ClusterStateListener
    
    Parameters:
    
    newState - new cluster state
    
    See Also:
    
    ClusterState
  - onClusterVersionChange
```
public void onClusterVersionChange(Version newVersion)
```
    Description copied from interface: ClusterVersionListener
    
    Invoked on registered listeners after the new cluster version has been applied. Listeners are executed synchronously immediately after ClusterStateManager#version has been updated and while the cluster service lock ClusterServiceImpl#lock is still locked, as part of the commit phase of the transaction changing the cluster version. Unhandled exceptions from listeners implementation will break the new version commit and a slow implementation will stall the system and may cause a transaction timeout. If new cluster version is null and property GroupProperty.INIT_CLUSTER_VERSION is set, the version set by this property will be provided as argument to the listener. If neither are set, running node's codebase version will be used.
    
    Specified by:
    
    onClusterVersionChange in interface ClusterVersionListener
    
    Parameters:
    
    newVersion - the new version
  - createPartitionState
```
public PartitionRuntimeState createPartitionState()
```
    Description copied from interface: InternalPartitionService
    
    Creates the current partition runtime state. May return null if the node should fetch the most recent partition table (e.g. this node is a newly appointed master) or if the partition state manager is not initialized.
    
    Specified by:
    
    createPartitionState in interface InternalPartitionService
    
    Returns:
    
    the current partition state
    
    See Also:
    
    isFetchMostRecentPartitionTableTaskRequired(), FetchPartitionStateOperation, PartitionStateManager.isInitialized()
  - createPartitionStateInternal
```
public PartitionRuntimeState createPartitionStateInternal()
```
    Returns a copy of the partition table or null if not initialized. This method will acquire the partition service lock.
  - processPartitionRuntimeState
```
public boolean processPartitionRuntimeState(PartitionRuntimeState partitionState)
```
    Sets the partitionState if the node is started and the state is sent by the master known by this node.
    
    Parameters:
    
    partitionState - the new partition state
    
    Returns:
    
    true if the partition state was applied
  - getPartitions
```
public IPartition[] getPartitions()
```
    Description copied from interface: IPartitionService
    
    Returns an array of IPartition instances.
    Note: Creates a new array on each invocation, not recommended to use in high-loaded parts of code.
    
    Specified by:
    
    getPartitions in interface IPartitionService
    
    Returns:
    
    array of IPartition instances
  - getInternalPartitions
```
public InternalPartition[] getInternalPartitions()
```
    Specified by:
    
    getInternalPartitions in interface InternalPartitionService
  - getPartition
```
public InternalPartition getPartition(int partitionId)
```
    Description copied from interface: IPartitionService
    
    Returns the IPartition for a given partition ID.
    If the owner of the partition is not set yet, it will trigger partition assignment.
    The IPartition for a given partition ID will never change, so the result can be cached safely.
    
    Specified by:
    
    getPartition in interface InternalPartitionService
    
    Specified by:
    
    getPartition in interface IPartitionService
    
    Parameters:
    
    partitionId - the partition ID
    
    Returns:
    
    the IPartition
  - getPartition
```
public InternalPartition getPartition(int partitionId,
                                      boolean triggerOwnerAssignment)
```
    Description copied from interface: IPartitionService
    
    Returns the IPartition for a given partition ID.
    If the owner of the partition is not set yet and triggerOwnerAssignment is true, it will trigger partition assignment.
    The IPartition for a given partition ID will never change, so the result can be cached safely.
    
    Specified by:
    
    getPartition in interface InternalPartitionService
    
    Specified by:
    
    getPartition in interface IPartitionService
    
    Parameters:
    
    partitionId - the partition ID
    
    triggerOwnerAssignment - flag to trigger the partition assignment
    
    Returns:
    
    the IPartition
  - prepareToSafeShutdown
```
public boolean prepareToSafeShutdown(long timeout,
                                     TimeUnit unit)
```
    Specified by:
    
    prepareToSafeShutdown in interface InternalPartitionService
  - onShutdownRequest
```
public void onShutdownRequest(Address address)
```
  - onShutdownResponse
```
public void onShutdownResponse()
```
  - isMemberStateSafe
```
public boolean isMemberStateSafe()
```
    Description copied from interface: IPartitionService
    
    Queries and returns if this member in a safe state or not.
    This method just checks for a safe state, it doesn't force this member to be in a safe state.
    
    Specified by:
    
    isMemberStateSafe in interface IPartitionService
    
    Returns:
    
    true if this member in a safe state, otherwise false
  - hasOnGoingMigration
```
public boolean hasOnGoingMigration()
```
    Description copied from interface: IPartitionService
    
    Checks if there are any cluster-wide migrations.
    
    Specified by:
    
    hasOnGoingMigration in interface IPartitionService
    
    Returns:
    
    true if there are migrations, false otherwise.
  - hasOnGoingMigrationLocal
```
public boolean hasOnGoingMigrationLocal()
```
    Description copied from interface: IPartitionService
    
    Checks if there are any local migrations.
    
    Specified by:
    
    hasOnGoingMigrationLocal in interface IPartitionService
    
    Returns:
    
    true if there are migrations, false otherwise.
  - getPartitionId
```
public final int getPartitionId(Data key)
```
    Description copied from interface: IPartitionService
    
    Returns the partition ID for a Data key.
    
    Specified by:
    
    getPartitionId in interface IPartitionService
    
    Parameters:
    
    key - the Data key
    
    Returns:
    
    the partition ID
  - getPartitionId
```
public final int getPartitionId(Object key)
```
    Description copied from interface: IPartitionService
    
    Returns the partition ID for a given object.
    
    Specified by:
    
    getPartitionId in interface IPartitionService
    
    Parameters:
    
    key - the object key
    
    Returns:
    
    the partition ID
  - getPartitionCount
```
public final int getPartitionCount()
```
    Description copied from interface: IPartitionService
    
    Returns the number of partitions.
    
    Specified by:
    
    getPartitionCount in interface IPartitionService
    
    Returns:
    
    the number of partitions
  - getPartitionMigrationTimeout
```
public long getPartitionMigrationTimeout()
```
  - getPartitionReplicaVersionManager
```
public PartitionReplicaVersionManager getPartitionReplicaVersionManager()
```
    Specified by:
    
    getPartitionReplicaVersionManager in interface InternalPartitionService
  - getMemberPartitionsMap
```
public Map<Address,List<Integer>> getMemberPartitionsMap()
```
    Description copied from interface: IPartitionService
    
    Gets member partition IDs.
    Blocks until partitions are assigned.
    
    Specified by:
    
    getMemberPartitionsMap in interface IPartitionService
    
    Returns:
    
    map of member address to partition IDs
  - getMemberPartitions
```
public List<Integer> getMemberPartitions(Address target)
```
    Description copied from interface: IPartitionService
    
    Returns partition ID list assigned to given target.
    If the owner of the partition is not set yet, it will trigger partition assignment.
    
    Specified by:
    
    getMemberPartitions in interface IPartitionService
    
    Returns:
    
    partition ID list assigned to given target
  - getMemberPartitionsIfAssigned
```
public List<Integer> getMemberPartitionsIfAssigned(Address target)
```
    Description copied from interface: InternalPartitionService
    
    Returns partition ID list assigned to given target if partitions are assigned when method is called. Does not trigger partition assignment otherwise.
    
    Specified by:
    
    getMemberPartitionsIfAssigned in interface InternalPartitionService
    
    Returns:
    
    partition ID list assigned to given target if partitions are assigned already
  - reset
```
public void reset()
```
    Description copied from interface: ManagedService
    
    Resets this service back to its initial state.
    TODO: what is the purpose of reset
    
    Specified by:
    
    reset in interface ManagedService
  - pauseMigration
```
public void pauseMigration()
```
    Description copied from interface: InternalPartitionService
    
    Pause all migrations
    
    Specified by:
    
    pauseMigration in interface InternalPartitionService
  - resumeMigration
```
public void resumeMigration()
```
    Description copied from interface: InternalPartitionService
    
    Resume all migrations
    
    Specified by:
    
    resumeMigration in interface InternalPartitionService
  - isMigrationAllowed
```
public boolean isMigrationAllowed()
```
  - shutdown
```
public void shutdown(boolean terminate)
```
    Description copied from interface: ManagedService
    
    Shuts down this service.
    TODO: what is the purpose of the terminate variable
    
    Specified by:
    
    shutdown in interface ManagedService
    
    Parameters:
    
    terminate - true to shut down this service
  - getMigrationQueueSize
```
public long getMigrationQueueSize()
```
    Specified by:
    
    getMigrationQueueSize in interface IPartitionService
  - getPartitionServiceProxy
```
public PartitionServiceProxy getPartitionServiceProxy()
```
  - addMigrationListener
```
public String addMigrationListener(MigrationListener listener)
```
    Specified by:
    
    addMigrationListener in interface IPartitionService
  - removeMigrationListener
```
public boolean removeMigrationListener(String registrationId)
```
    Specified by:
    
    removeMigrationListener in interface IPartitionService
  - addPartitionLostListener
```
public String addPartitionLostListener(PartitionLostListener listener)
```
    Specified by:
    
    addPartitionLostListener in interface IPartitionService
  - addLocalPartitionLostListener
```
public String addLocalPartitionLostListener(PartitionLostListener listener)
```
    Specified by:
    
    addLocalPartitionLostListener in interface IPartitionService
  - removePartitionLostListener
```
public boolean removePartitionLostListener(String registrationId)
```
    Specified by:
    
    removePartitionLostListener in interface IPartitionService
  - dispatchEvent
```
public void dispatchEvent(PartitionEvent partitionEvent,
                          PartitionEventListener partitionEventListener)
```
    Description copied from interface: EventPublishingService
    
    Notifies the service of a published event.
    
    Specified by:
    
    dispatchEvent in interface EventPublishingService<PartitionEvent,PartitionEventListener<PartitionEvent>>
    
    Parameters:
    
    partitionEvent - the published event
    
    partitionEventListener - the listener registered for this event
  - addPartitionListener
```
public void addPartitionListener(PartitionListener listener)
```
  - isPartitionOwner
```
public boolean isPartitionOwner(int partitionId)
```
    Description copied from interface: IPartitionService
    
    Check if this node is the owner of a partition.
    
    Specified by:
    
    isPartitionOwner in interface IPartitionService
    
    Parameters:
    
    partitionId - the partition ID
    
    Returns:
    
    true if the node owns the partition, false if the node doesn't own the partition or if the partition hasn't been assigned yet
  - getPartitionStateVersion
```
public int getPartitionStateVersion()
```
    Specified by:
    
    getPartitionStateVersion in interface IPartitionService
  - onPartitionLost
```
public void onPartitionLost(IPartitionLostEvent event)
```
    Description copied from interface: PartitionAwareService
    
    Invoked when a partition lost is detected
    
    Specified by:
    
    onPartitionLost in interface PartitionAwareService
    
    Parameters:
    
    event - The event object that contains the partition ID and the number of replicas that is lost
  - setInternalMigrationListener
```
public void setInternalMigrationListener(InternalMigrationListener listener)
```
  - getInternalMigrationListener
```
public InternalMigrationListener getInternalMigrationListener()
```
  - resetInternalMigrationListener
```
public void resetInternalMigrationListener()
```
  - getOngoingReplicaSyncRequests
```
public List<ReplicaFragmentSyncInfo> getOngoingReplicaSyncRequests()
```
    Returns:
    
    copy of ongoing replica-sync operations
  - getScheduledReplicaSyncRequests
```
public List<ScheduledEntry<ReplicaFragmentSyncInfo,Void>> getScheduledReplicaSyncRequests()
```
    Returns:
    
    copy of scheduled replica-sync requests
  - getPartitionStateManager
```
public PartitionStateManager getPartitionStateManager()
```
  - getMigrationManager
```
public MigrationManager getMigrationManager()
```
  - getReplicaManager
```
public PartitionReplicaManager getReplicaManager()
```
  - getPartitionReplicaStateChecker
```
public PartitionReplicaStateChecker getPartitionReplicaStateChecker()
```
  - getPartitionEventManager
```
public PartitionEventManager getPartitionEventManager()
```
  - replaceAddress
```
public void replaceAddress(Address oldAddress,
                           Address newAddress)
```
  - createPartitionTableView
```
public PartitionTableView createPartitionTableView()
```
    Specified by:
    
    createPartitionTableView in interface InternalPartitionService
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class InternalPartitionServiceImpl

Field Summary

Fields inherited from interface com.hazelcast.internal.partition.InternalPartitionService

Fields inherited from interface com.hazelcast.spi.partition.IPartitionService

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

InternalPartitionServiceImpl

Method Detail

init

getPartitionOwner

getPartitionOwnerOrWait

firstArrangement

setInitialState

getMemberGroupsSize

getMaxAllowedBackupCount

isMemberAllowedToJoin

memberAdded

memberRemoved

onClusterStateChange

onClusterVersionChange

createPartitionState

createPartitionStateInternal

processPartitionRuntimeState

getPartitions

getInternalPartitions

getPartition

getPartition

prepareToSafeShutdown

onShutdownRequest

onShutdownResponse

isMemberStateSafe

hasOnGoingMigration

hasOnGoingMigrationLocal

getPartitionId

getPartitionId

getPartitionCount

getPartitionMigrationTimeout

getPartitionReplicaVersionManager

getMemberPartitionsMap

getMemberPartitions

getMemberPartitionsIfAssigned

reset

pauseMigration

resumeMigration

isMigrationAllowed

shutdown

getMigrationQueueSize

getPartitionServiceProxy

addMigrationListener

removeMigrationListener

addPartitionLostListener

addLocalPartitionLostListener

removePartitionLostListener

dispatchEvent

addPartitionListener

isPartitionOwner

getPartitionStateVersion

onPartitionLost

setInternalMigrationListener

getInternalMigrationListener

resetInternalMigrationListener

getOngoingReplicaSyncRequests

getScheduledReplicaSyncRequests

getPartitionStateManager

getMigrationManager

getReplicaManager

getPartitionReplicaStateChecker

getPartitionEventManager

replaceAddress

createPartitionTableView

toString