Package org.opendaylight.controller.cluster.datastore.shardmanager

Interface ShardManagerInfoMBean

public interface ShardManagerInfoMBean

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ShardManagerInfoMBean.TargetBehavior	Behaviours we can switch to.

Method Summary

Modifier and Type	Method	Description
List<String>	getLocalShards()	Returns the list of all the local shard names.
String	getMemberName()	Returns the name of the local member.
boolean	getSyncStatus()	Returns the overall sync status for all shards.
void	switchAllLocalShardsState(ShardManagerInfoMBean.TargetBehavior targetBehavior, long term)	Switches the raft behavior of all the local shards to the newBehavior.
void	switchShardState(String shardName, ShardManagerInfoMBean.TargetBehavior targetBehavior, long term)	Switches the raft behavior of the shard specified by shardName to the newBehavior.

Method Details

getLocalShards

List<String> getLocalShards()

Returns the list of all the local shard names.

Returns:

a list of all the local shard names

getSyncStatus

boolean getSyncStatus()

Returns the overall sync status for all shards.

Returns:

true if all local shards are in sync with their corresponding leaders

getMemberName

String getMemberName()

Returns the name of the local member.

Returns:

the local member name

switchAllLocalShardsState

void switchAllLocalShardsState(ShardManagerInfoMBean.TargetBehavior targetBehavior,
 long term)

Switches the raft behavior of all the local shards to the newBehavior.

Parameters:

targetBehavior - a ShardManagerInfoMBean.TargetBehavior

term - when switching to the Leader specifies for which term the Shard would be the Leader. Any modifications made to state will be written with this term. This term will then be used by the Raft replication implementation to decide which modifications should stay and which ones should be removed. Ideally the term provided when switching to a new Leader should always be higher than the previous term.

switchShardState

void switchShardState(String shardName,
 ShardManagerInfoMBean.TargetBehavior targetBehavior,
 long term)

Switches the raft behavior of the shard specified by shardName to the newBehavior.

Parameters:

shardName - a shard that is local to this shard manager

targetBehavior - a ShardManagerInfoMBean.TargetBehavior

term - when switching to the Leader specifies for which term the Shard would be the Leader. Any modifications made to state will be written with this term. This term will then be used by the Raft replication implementation to decide which modifications should stay and which ones should be removed. Ideally the term provided when switching to a new Leader should always be higher than the previous term.