org.opendaylight.controller.cluster.datastore.admin

Class ClusterAdminRpcService

java.lang.Object

org.opendaylight.controller.cluster.datastore.admin.ClusterAdminRpcService

All Implemented Interfaces:

ClusterAdminService, org.opendaylight.yangtools.yang.binding.RpcService

public class ClusterAdminRpcService
extends Object
implements ClusterAdminService

Implements the yang RPCs defined in the generated ClusterAdminService interface.

Author:

Thomas Pantelis

Constructor Summary

Constructors

Constructor and Description
ClusterAdminRpcService(DistributedDataStoreInterface configDataStore, DistributedDataStoreInterface operDataStore, org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer serializer)

Method Summary

Modifier and Type	Method and Description
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	addPrefixShardReplica(AddPrefixShardReplicaInput input) Adds a replica of a shard to this node and joins it to an existing cluster.
Future<org.opendaylight.yangtools.yang.common.RpcResult<AddReplicasForAllShardsOutput>>	addReplicasForAllShards() Adds replicas on this node for all currently defined shards.
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	addShardReplica(AddShardReplicaInput input) Adds a replica of a shard to this node and joins it to an existing cluster.
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	backupDatastore(BackupDatastoreInput input) Creates a backup file of the datastore state
Future<org.opendaylight.yangtools.yang.common.RpcResult<ChangeMemberVotingStatesForAllShardsOutput>>	changeMemberVotingStatesForAllShards(ChangeMemberVotingStatesForAllShardsInput input) Changes the voting states, either voting or non-voting, of cluster members for all shards.Non-voting members will no longer participate in leader elections and consensus but will bereplicated.
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	changeMemberVotingStatesForShard(ChangeMemberVotingStatesForShardInput input) Changes the voting states, either voting or non-voting, of cluster members for a shard.Non-voting members will no longer participate in leader elections and consensus but will bereplicated.
Future<org.opendaylight.yangtools.yang.common.RpcResult<FlipMemberVotingStatesForAllShardsOutput>>	flipMemberVotingStatesForAllShards() Flips the voting states of all cluster members for all shards, such that if a memberwas voting it becomes non-voting and vice versa.
Future<org.opendaylight.yangtools.yang.common.RpcResult<GetPrefixShardRoleOutput>>	getPrefixShardRole(GetPrefixShardRoleInput input) Returns the current role for the requested module shard.
Future<org.opendaylight.yangtools.yang.common.RpcResult<GetShardRoleOutput>>	getShardRole(GetShardRoleInput input) Returns the current role for the requested module shard.
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	makeLeaderLocal(MakeLeaderLocalInput input) Attempts to move the shard leader of the given module based shard to the local node.The rpc returns a response after handling of the underlying MakeLeaderLocal message completes.This operation fails if there is no current shard leader due to lack of network connectivity ora cluster majority.
Future<org.opendaylight.yangtools.yang.common.RpcResult<RemoveAllShardReplicasOutput>>	removeAllShardReplicas(RemoveAllShardReplicasInput input) Removes replicas for all shards on this node.
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	removePrefixShardReplica(RemovePrefixShardReplicaInput input) Removes an existing replica of a prefix shard from this node via the RemoveServer mechanism asdescribed in the Raft paper.
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	removeShardReplica(RemoveShardReplicaInput input) Removes an existing replica of a shard from this node via the RemoveServer mechanism asdescribed in the Raft paper.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClusterAdminRpcService

public ClusterAdminRpcService(DistributedDataStoreInterface configDataStore,
                              DistributedDataStoreInterface operDataStore,
                              org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer serializer)

Method Detail

addShardReplica

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> addShardReplica(AddShardReplicaInput input)

Description copied from interface: ClusterAdminService

Adds a replica of a shard to this node and joins it to an existing cluster. The shard mustalready have a module configuration defined for it and there must already be a shard existing onanother node with a leader. This RPC first contacts peer member seed nodes searching for a shard.When found, an AddServer message is sent to the shard leader and applied as described in the Raftpaper.

Specified by:

addShardReplica in interface ClusterAdminService

removeShardReplica

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> removeShardReplica(RemoveShardReplicaInput input)

Description copied from interface: ClusterAdminService

Removes an existing replica of a shard from this node via the RemoveServer mechanism asdescribed in the Raft paper.

Specified by:

removeShardReplica in interface ClusterAdminService

makeLeaderLocal

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> makeLeaderLocal(MakeLeaderLocalInput input)

Description copied from interface: ClusterAdminService

Attempts to move the shard leader of the given module based shard to the local node.The rpc returns a response after handling of the underlying MakeLeaderLocal message completes.This operation fails if there is no current shard leader due to lack of network connectivity ora cluster majority. In addition, if the local node is not up to date with the current leader,an attempt is made to first sync the local node with the leader. If this cannot be achievedwithin two election timeout periods the operation fails.

Specified by:

makeLeaderLocal in interface ClusterAdminService

addPrefixShardReplica

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> addPrefixShardReplica(AddPrefixShardReplicaInput input)

Description copied from interface: ClusterAdminService

Adds a replica of a shard to this node and joins it to an existing cluster. There must already bea shard existing on another node with a leader. This RPC first contacts peer member seed nodessearching for a shard. When found, an AddServer message is sent to the shard leader and applied asdescribed in the Raft paper.

Specified by:

addPrefixShardReplica in interface ClusterAdminService

removePrefixShardReplica

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> removePrefixShardReplica(RemovePrefixShardReplicaInput input)

Description copied from interface: ClusterAdminService

Removes an existing replica of a prefix shard from this node via the RemoveServer mechanism asdescribed in the Raft paper.

Specified by:

removePrefixShardReplica in interface ClusterAdminService

addReplicasForAllShards

public Future<org.opendaylight.yangtools.yang.common.RpcResult<AddReplicasForAllShardsOutput>> addReplicasForAllShards()

Description copied from interface: ClusterAdminService

Adds replicas on this node for all currently defined shards. This is equivalent to issuingan add-shard-replica RPC for all shards.

Specified by:

addReplicasForAllShards in interface ClusterAdminService

removeAllShardReplicas

public Future<org.opendaylight.yangtools.yang.common.RpcResult<RemoveAllShardReplicasOutput>> removeAllShardReplicas(RemoveAllShardReplicasInput input)

Description copied from interface: ClusterAdminService

Removes replicas for all shards on this node. This is equivalent to issuinga remove-shard-replica for all shards and essentially removes this node from a cluster.

Specified by:

removeAllShardReplicas in interface ClusterAdminService

changeMemberVotingStatesForShard

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> changeMemberVotingStatesForShard(ChangeMemberVotingStatesForShardInput input)

Description copied from interface: ClusterAdminService

Changes the voting states, either voting or non-voting, of cluster members for a shard.Non-voting members will no longer participate in leader elections and consensus but will bereplicated. This is useful for having a set of members serve as a backup cluster in case theprimary voting cluster suffers catastrophic failure. This RPC can be issued to any cluster memberand will be forwarded to the leader.

Specified by:

changeMemberVotingStatesForShard in interface ClusterAdminService

changeMemberVotingStatesForAllShards

public Future<org.opendaylight.yangtools.yang.common.RpcResult<ChangeMemberVotingStatesForAllShardsOutput>> changeMemberVotingStatesForAllShards(ChangeMemberVotingStatesForAllShardsInput input)

Description copied from interface: ClusterAdminService

Changes the voting states, either voting or non-voting, of cluster members for all shards.Non-voting members will no longer participate in leader elections and consensus but will bereplicated. This is useful for having a set of members serve as a backup cluster in case theprimary voting cluster suffers catastrophic failure. This RPC can be issued to any cluster memberand will be forwarded to the leader.

Specified by:

changeMemberVotingStatesForAllShards in interface ClusterAdminService

flipMemberVotingStatesForAllShards

public Future<org.opendaylight.yangtools.yang.common.RpcResult<FlipMemberVotingStatesForAllShardsOutput>> flipMemberVotingStatesForAllShards()

Description copied from interface: ClusterAdminService

Flips the voting states of all cluster members for all shards, such that if a memberwas voting it becomes non-voting and vice versa.

Specified by:

flipMemberVotingStatesForAllShards in interface ClusterAdminService

getShardRole

public Future<org.opendaylight.yangtools.yang.common.RpcResult<GetShardRoleOutput>> getShardRole(GetShardRoleInput input)

Description copied from interface: ClusterAdminService

Returns the current role for the requested module shard.

Specified by:

getShardRole in interface ClusterAdminService

Returns:

java.util.concurrent.Future shardRole, or null if not present

getPrefixShardRole

public Future<org.opendaylight.yangtools.yang.common.RpcResult<GetPrefixShardRoleOutput>> getPrefixShardRole(GetPrefixShardRoleInput input)

Description copied from interface: ClusterAdminService

Returns the current role for the requested module shard.

Specified by:

getPrefixShardRole in interface ClusterAdminService

Returns:

java.util.concurrent.Future prefixShardRole, or null if not present

backupDatastore

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> backupDatastore(BackupDatastoreInput input)

Description copied from interface: ClusterAdminService

Creates a backup file of the datastore state

Specified by:

backupDatastore in interface ClusterAdminService