Package io.atomix.raft.partition

Class RaftPartitionGroup

java.lang.Object

io.atomix.raft.partition.RaftPartitionGroup

All Implemented Interfaces:

ManagedPartitionGroup, PartitionGroup, Configured<PartitionGroupConfig>

public final class RaftPartitionGroup
extends Object
implements ManagedPartitionGroup

Raft partition group.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RaftPartitionGroup.Builder	Raft partition group builder.
static class	RaftPartitionGroup.Type	Raft partition group type.

Field Summary

Fields

Modifier and Type	Field	Description
static final RaftPartitionGroup.Type	TYPE

Constructor Summary

Constructors

Constructor	Description
RaftPartitionGroup(RaftPartitionGroupConfig config)

Method Summary

Modifier and Type	Method	Description
static RaftPartitionGroup.Builder	builder(String name)	Returns a new Raft partition group builder.
CompletableFuture<Void>	close()	Closes the partition group.
RaftPartitionGroupConfig	config()
CompletableFuture<ManagedPartitionGroup>	connect(PartitionManagementService managementService)	Connects to the partition group.
RaftPartition	getPartition(int partitionId)	Returns a partition by ID.
RaftPartition	getPartition(PartitionId partitionId)	Returns a partition by ID.
List<PartitionId>	getPartitionIds()	Returns a sorted list of partition IDs.
Collection<Partition>	getPartitions()	Returns a collection of all partitions.
CompletableFuture<ManagedPartitionGroup>	join(PartitionManagementService managementService)	Joins the partition group.
String	name()	Returns the partition group name.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.atomix.primitive.partition.PartitionGroup

getPartition, getPartitionsWithMember

Field Details

TYPE

public static final RaftPartitionGroup.Type TYPE

Constructor Details

RaftPartitionGroup

public RaftPartitionGroup(RaftPartitionGroupConfig config)

Method Details

builder

public static RaftPartitionGroup.Builder builder(String name)

Returns a new Raft partition group builder.

Parameters:

name - the partition group name

Returns:

a new partition group builder

name

public String name()

Description copied from interface: PartitionGroup

Returns the partition group name.

Specified by:

name in interface PartitionGroup

Returns:

the partition group name

getPartition

public RaftPartition getPartition(int partitionId)

Description copied from interface: PartitionGroup

Returns a partition by ID. Assumes that the partition ID belongs to this group.

Specified by:

getPartition in interface PartitionGroup

Parameters:

partitionId - the partition identifier

Returns:

the partition or null if no partition with the given identifier exists

getPartition

public RaftPartition getPartition(PartitionId partitionId)

Description copied from interface: PartitionGroup

Returns a partition by ID.

Specified by:

getPartition in interface PartitionGroup

Parameters:

partitionId - the partition identifier

Returns:

the partition or null if no partition with the given identifier exists

getPartitions

public Collection<Partition> getPartitions()

Description copied from interface: PartitionGroup

Returns a collection of all partitions.

Specified by:

getPartitions in interface PartitionGroup

Returns:

a collection of all partitions

getPartitionIds

public List<PartitionId> getPartitionIds()

Description copied from interface: PartitionGroup

Returns a sorted list of partition IDs.

Specified by:

getPartitionIds in interface PartitionGroup

Returns:

a sorted list of partition IDs

config

public RaftPartitionGroupConfig config()

Specified by:

config in interface Configured<PartitionGroupConfig>

toString

public String toString()

Overrides:

toString in class Object

join

public CompletableFuture<ManagedPartitionGroup> join(PartitionManagementService managementService)

Description copied from interface: ManagedPartitionGroup

Joins the partition group.

Specified by:

join in interface ManagedPartitionGroup

Parameters:

managementService - the partition management service

Returns:

a future to be completed once the partition group has been joined

connect

public CompletableFuture<ManagedPartitionGroup> connect(PartitionManagementService managementService)

Description copied from interface: ManagedPartitionGroup

Connects to the partition group.

Specified by:

connect in interface ManagedPartitionGroup

Parameters:

managementService - the partition management service

Returns:

a future to be completed once the partition group has been connected

close

public CompletableFuture<Void> close()

Description copied from interface: ManagedPartitionGroup

Closes the partition group.

Specified by:

close in interface ManagedPartitionGroup

Returns:

a future to be completed once the partition group has been closed