Package io.atomix.raft.partition

Class RaftPartition

java.lang.Object

io.atomix.raft.partition.RaftPartition

All Implemented Interfaces:

Partition, HealthMonitorable

public final class RaftPartition
extends Object
implements Partition, HealthMonitorable

Abstract partition.

Constructor Summary

Constructors

Constructor	Description
RaftPartition(PartitionMetadata partitionMetadata, RaftPartitionConfig config, File dataDirectory)

Method Summary

Modifier and Type	Method	Description
void	addFailureListener(FailureListener failureListener)
void	addRoleChangeListener(RaftRoleChangeListener listener)
CompletableFuture<RaftPartition>	bootstrap(PartitionManagementService managementService, ReceivableSnapshotStore snapshotStore)	Bootstraps a partition.
CompletableFuture<Void>	close()	Closes the partition.
String	componentName()
File	dataDirectory()	Returns the partition data directory.
CompletableFuture<Void>	delete()	Deletes the partition.
HealthReport	getHealthReport()
RaftPartitionConfig	getPartitionConfig()
RaftServer.Role	getRole()
RaftPartitionServer	getServer()
PartitionId	id()	Returns the partition identifier.
CompletableFuture<RaftPartition>	join(PartitionManagementService managementService, ReceivableSnapshotStore snapshotStore)
CompletableFuture<RaftPartition>	leave()
Collection<MemberId>	members()	Returns the collection of all members in the partition.
String	name()	Returns the partition name.
void	removeFailureListener(FailureListener failureListener)
void	removeRoleChangeListener(RaftRoleChangeListener listener)
boolean	shouldStepDown()
CompletableFuture<Void>	stepDown()
CompletableFuture<Void>	stepDownIfNotPrimary()	Tries to step down if the following conditions are met: priority election is enabled the partition distributor determined a primary node this node is not the primary
CompletableFuture<Void>	stop()
long	term()	Returns the partition term.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

RaftPartition

public RaftPartition(PartitionMetadata partitionMetadata,
 RaftPartitionConfig config,
 File dataDirectory)

Method Details

addRoleChangeListener

public void addRoleChangeListener(RaftRoleChangeListener listener)

removeRoleChangeListener

public void removeRoleChangeListener(RaftRoleChangeListener listener)

dataDirectory

public File dataDirectory()

Returns the partition data directory.

Returns:

the partition data directory

bootstrap

public CompletableFuture<RaftPartition> bootstrap(PartitionManagementService managementService,
 ReceivableSnapshotStore snapshotStore)

Bootstraps a partition.

join

public CompletableFuture<RaftPartition> join(PartitionManagementService managementService,
 ReceivableSnapshotStore snapshotStore)

leave

public CompletableFuture<RaftPartition> leave()

name

public String name()

Returns the partition name.

Returns:

the partition name

componentName

public String componentName()

Specified by:

componentName in interface HealthMonitorable

getHealthReport

public HealthReport getHealthReport()

Specified by:

getHealthReport in interface HealthMonitorable

addFailureListener

public void addFailureListener(FailureListener failureListener)

Specified by:

addFailureListener in interface HealthMonitorable

removeFailureListener

public void removeFailureListener(FailureListener failureListener)

Specified by:

removeFailureListener in interface HealthMonitorable

close

public CompletableFuture<Void> close()

Closes the partition.

delete

public CompletableFuture<Void> delete()

Deletes the partition.

Returns:

future to be completed once the partition has been deleted

toString

public String toString()

Overrides:

toString in class Object

id

public PartitionId id()

Description copied from interface: Partition

Returns the partition identifier.

Specified by:

id in interface Partition

Returns:

the partition identifier

term

public long term()

Description copied from interface: Partition

Returns the partition term.

Specified by:

term in interface Partition

Returns:

the partition term

members

public Collection<MemberId> members()

Description copied from interface: Partition

Returns the collection of all members in the partition.

Specified by:

members in interface Partition

Returns:

the collection of all members in the partition

getRole

public RaftServer.Role getRole()

getServer

public RaftPartitionServer getServer()

stepDown

public CompletableFuture<Void> stepDown()

stepDownIfNotPrimary

public CompletableFuture<Void> stepDownIfNotPrimary()

Tries to step down if the following conditions are met:

• priority election is enabled
• the partition distributor determined a primary node
• this node is not the primary

shouldStepDown

@VisibleForTesting
public boolean shouldStepDown()

stop

public CompletableFuture<Void> stop()

getPartitionConfig

public RaftPartitionConfig getPartitionConfig()