Package org.opendaylight.controller.cluster.datastore.admin

Class ClusterAdminRpcService

java.lang.Object

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

All Implemented Interfaces:

ClusterAdminService, 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	Description
ClusterAdminRpcService(DistributedDataStoreInterface configDataStore, DistributedDataStoreInterface operDataStore, BindingNormalizedNodeSerializer serializer)

Method Summary

Modifier and Type	Method	Description
ListenableFuture<RpcResult<AddPrefixShardReplicaOutput>>	addPrefixShardReplica(AddPrefixShardReplicaInput input)	Invoke add-prefix-shard-replica RPC.
ListenableFuture<RpcResult<AddReplicasForAllShardsOutput>>	addReplicasForAllShards(AddReplicasForAllShardsInput input)	Invoke add-replicas-for-all-shards RPC.
ListenableFuture<RpcResult<AddShardReplicaOutput>>	addShardReplica(AddShardReplicaInput input)	Invoke add-shard-replica RPC.
ListenableFuture<RpcResult<BackupDatastoreOutput>>	backupDatastore(BackupDatastoreInput input)	Invoke backup-datastore RPC.
ListenableFuture<RpcResult<ChangeMemberVotingStatesForAllShardsOutput>>	changeMemberVotingStatesForAllShards(ChangeMemberVotingStatesForAllShardsInput input)	Invoke change-member-voting-states-for-all-shards RPC.
ListenableFuture<RpcResult<ChangeMemberVotingStatesForShardOutput>>	changeMemberVotingStatesForShard(ChangeMemberVotingStatesForShardInput input)	Invoke change-member-voting-states-for-shard RPC.
ListenableFuture<RpcResult<FlipMemberVotingStatesForAllShardsOutput>>	flipMemberVotingStatesForAllShards(FlipMemberVotingStatesForAllShardsInput input)	Invoke flip-member-voting-states-for-all-shards RPC.
ListenableFuture<RpcResult<GetKnownClientsForAllShardsOutput>>	getKnownClientsForAllShards(GetKnownClientsForAllShardsInput input)	Invoke get-known-clients-for-all-shards RPC.
ListenableFuture<RpcResult<GetPrefixShardRoleOutput>>	getPrefixShardRole(GetPrefixShardRoleInput input)	Invoke get-prefix-shard-role RPC.
ListenableFuture<RpcResult<GetShardRoleOutput>>	getShardRole(GetShardRoleInput input)	Invoke get-shard-role RPC.
ListenableFuture<RpcResult<LocateShardOutput>>	locateShard(LocateShardInput input)	Invoke locate-shard RPC.
ListenableFuture<RpcResult<MakeLeaderLocalOutput>>	makeLeaderLocal(MakeLeaderLocalInput input)	Invoke make-leader-local RPC.
ListenableFuture<RpcResult<RemoveAllShardReplicasOutput>>	removeAllShardReplicas(RemoveAllShardReplicasInput input)	Invoke remove-all-shard-replicas RPC.
ListenableFuture<RpcResult<RemovePrefixShardReplicaOutput>>	removePrefixShardReplica(RemovePrefixShardReplicaInput input)	Invoke remove-prefix-shard-replica RPC.
ListenableFuture<RpcResult<RemoveShardReplicaOutput>>	removeShardReplica(RemoveShardReplicaInput input)	Invoke remove-shard-replica RPC.

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,
                              BindingNormalizedNodeSerializer serializer)

Method Detail

addShardReplica

public ListenableFuture<RpcResult<AddShardReplicaOutput>> addShardReplica(AddShardReplicaInput input)

Description copied from interface: ClusterAdminService

Invoke add-shard-replica RPC.

     
         Adds a replica of a shard to this node and joins it to an existing cluster. The
         shard must already have a module configuration defined for it and there must
         already be a shard existing on another 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 Raft paper.
     
 

Specified by:

addShardReplica in interface ClusterAdminService

Parameters:

input - of add-shard-replica

Returns:

output of add-shard-replica

removeShardReplica

public ListenableFuture<RpcResult<RemoveShardReplicaOutput>> removeShardReplica(RemoveShardReplicaInput input)

Description copied from interface: ClusterAdminService

Invoke remove-shard-replica RPC.

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

Specified by:

removeShardReplica in interface ClusterAdminService

Parameters:

input - of remove-shard-replica

Returns:

output of remove-shard-replica

locateShard

public ListenableFuture<RpcResult<LocateShardOutput>> locateShard(LocateShardInput input)

Description copied from interface: ClusterAdminService

Invoke locate-shard RPC.

     
         Return the transport-level information about where a shard has a home.
     
 

Specified by:

locateShard in interface ClusterAdminService

Parameters:

input - of locate-shard

Returns:

output of locate-shard

makeLeaderLocal

public ListenableFuture<RpcResult<MakeLeaderLocalOutput>> makeLeaderLocal(MakeLeaderLocalInput input)

Description copied from interface: ClusterAdminService

Invoke make-leader-local RPC.

     
         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 or a 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
         achieved within two election timeout periods the operation fails.
     
 

Specified by:

makeLeaderLocal in interface ClusterAdminService

Parameters:

input - of make-leader-local

Returns:

output of make-leader-local

addPrefixShardReplica

public ListenableFuture<RpcResult<AddPrefixShardReplicaOutput>> addPrefixShardReplica(AddPrefixShardReplicaInput input)

Description copied from interface: ClusterAdminService

Invoke add-prefix-shard-replica RPC.

     
         Adds a replica of a shard to this node and joins it to an existing cluster.
         There must already be a shard existing on another 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
         Raft paper.
     
 

Specified by:

addPrefixShardReplica in interface ClusterAdminService

Parameters:

input - of add-prefix-shard-replica

Returns:

output of add-prefix-shard-replica

removePrefixShardReplica

public ListenableFuture<RpcResult<RemovePrefixShardReplicaOutput>> removePrefixShardReplica(RemovePrefixShardReplicaInput input)

Description copied from interface: ClusterAdminService

Invoke remove-prefix-shard-replica RPC.

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

Specified by:

removePrefixShardReplica in interface ClusterAdminService

Parameters:

input - of remove-prefix-shard-replica

Returns:

output of remove-prefix-shard-replica

addReplicasForAllShards

public ListenableFuture<RpcResult<AddReplicasForAllShardsOutput>> addReplicasForAllShards(AddReplicasForAllShardsInput input)

Description copied from interface: ClusterAdminService

Invoke add-replicas-for-all-shards RPC.

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

Specified by:

addReplicasForAllShards in interface ClusterAdminService

Parameters:

input - of add-replicas-for-all-shards

Returns:

output of add-replicas-for-all-shards

removeAllShardReplicas

public ListenableFuture<RpcResult<RemoveAllShardReplicasOutput>> removeAllShardReplicas(RemoveAllShardReplicasInput input)

Description copied from interface: ClusterAdminService

Invoke remove-all-shard-replicas RPC.

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

Specified by:

removeAllShardReplicas in interface ClusterAdminService

Parameters:

input - of remove-all-shard-replicas

Returns:

output of remove-all-shard-replicas

changeMemberVotingStatesForShard

public ListenableFuture<RpcResult<ChangeMemberVotingStatesForShardOutput>> changeMemberVotingStatesForShard(ChangeMemberVotingStatesForShardInput input)

Description copied from interface: ClusterAdminService

Invoke change-member-voting-states-for-shard RPC.

     
         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 be replicated. This is useful for having a set of members
         serve as a backup cluster in case the primary voting cluster suffers
         catastrophic failure. This RPC can be issued to any cluster member and will be
         forwarded to the leader.
     
 

Specified by:

changeMemberVotingStatesForShard in interface ClusterAdminService

Parameters:

input - of change-member-voting-states-for-shard

Returns:

output of change-member-voting-states-for-shard

changeMemberVotingStatesForAllShards

public ListenableFuture<RpcResult<ChangeMemberVotingStatesForAllShardsOutput>> changeMemberVotingStatesForAllShards(ChangeMemberVotingStatesForAllShardsInput input)

Description copied from interface: ClusterAdminService

Invoke change-member-voting-states-for-all-shards RPC.

     
         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 be replicated. This is useful for having a set of members
         serve as a backup cluster in case the primary voting cluster suffers
         catastrophic failure. This RPC can be issued to any cluster member and will be
         forwarded to the leader.
     
 

Specified by:

changeMemberVotingStatesForAllShards in interface ClusterAdminService

Parameters:

input - of change-member-voting-states-for-all-shards

Returns:

output of change-member-voting-states-for-all-shards

flipMemberVotingStatesForAllShards

public ListenableFuture<RpcResult<FlipMemberVotingStatesForAllShardsOutput>> flipMemberVotingStatesForAllShards(FlipMemberVotingStatesForAllShardsInput input)

Description copied from interface: ClusterAdminService

Invoke flip-member-voting-states-for-all-shards RPC.

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

Specified by:

flipMemberVotingStatesForAllShards in interface ClusterAdminService

Parameters:

input - of flip-member-voting-states-for-all-shards

Returns:

output of flip-member-voting-states-for-all-shards

getShardRole

public ListenableFuture<RpcResult<GetShardRoleOutput>> getShardRole(GetShardRoleInput input)

Description copied from interface: ClusterAdminService

Invoke get-shard-role RPC.

     
         Returns the current role for the requested module shard.
     
 

Specified by:

getShardRole in interface ClusterAdminService

Parameters:

input - of get-shard-role

Returns:

output of get-shard-role

getPrefixShardRole

public ListenableFuture<RpcResult<GetPrefixShardRoleOutput>> getPrefixShardRole(GetPrefixShardRoleInput input)

Description copied from interface: ClusterAdminService

Invoke get-prefix-shard-role RPC.

     
         Returns the current role for the requested module shard.
     
 

Specified by:

getPrefixShardRole in interface ClusterAdminService

Parameters:

input - of get-prefix-shard-role

Returns:

output of get-prefix-shard-role

backupDatastore

public ListenableFuture<RpcResult<BackupDatastoreOutput>> backupDatastore(BackupDatastoreInput input)

Description copied from interface: ClusterAdminService

Invoke backup-datastore RPC.

     
         Creates a backup file of the datastore state
     
 

Specified by:

backupDatastore in interface ClusterAdminService

Parameters:

input - of backup-datastore

Returns:

output of backup-datastore

getKnownClientsForAllShards

public ListenableFuture<RpcResult<GetKnownClientsForAllShardsOutput>> getKnownClientsForAllShards(GetKnownClientsForAllShardsInput input)

Description copied from interface: ClusterAdminService

Invoke get-known-clients-for-all-shards RPC.

     
         Request all shards to report their known frontend clients. This is useful for
         determining what generation should a resurrected member node should use.
     
 

Specified by:

getKnownClientsForAllShards in interface ClusterAdminService

Parameters:

input - of get-known-clients-for-all-shards

Returns:

output of get-known-clients-for-all-shards