org.corfudb.runtime.clients

Class ManagementClient

java.lang.Object

org.corfudb.runtime.clients.ManagementClient

All Implemented Interfaces:

IClient

public class ManagementClient
extends Object

A client to the Management Server.

Failure Detection: This client allows a client to trigger failures handlers with relevant failures.

Created by zlokhandwala on 11/4/16.

Constructor Summary

Constructors

Constructor and Description
ManagementClient(IClientRouter router, long epoch)

Method Summary

Modifier and Type	Method and Description
CreateWorkflowResponse	addNodeRequest(String endpoint) Send a add node request to an orchestrator
CompletableFuture<Boolean>	bootstrapManagement(Layout l) Bootstraps a management server.
CreateWorkflowResponse	forceRemoveNode(String endpoint) Send a force remove node request to an orchestrator service node.
CompletableFuture<Layout>	getLayout() Requests for the layout persisted by the management server.
CompletableFuture<Boolean>	handleFailure(long detectorEpoch, Set<String> failedNodes) Sends the failure detected to the relevant management server.
CompletableFuture<Boolean>	handleHealing(long detectorEpoch, Set<String> healedNodes) Sends the healed nodes detected to the relevant management server.
CreateWorkflowResponse	healNodeRequest(String endpoint, boolean isLayoutServer, boolean isSequencerServer, boolean isLogUnitServer, int stripeIndex) Creates a workflow request to heal a node.
CreateWorkflowResponse	mergeSegments(String endpoint) Creates a workflow request to restore all redundancies and merge all segments.
QueryResponse	queryRequest(UUID workflowId) Query the state of a workflow on a particular orchestrator.
CreateWorkflowResponse	removeNode(String endpoint) Return a workflow id for this remove operation request.
CompletableFuture<FailureDetectorMetrics>	sendFailureDetectorMetricsRequest()
void	sendMessage(CorfuMsg msg)
CompletableFuture<NodeState>	sendNodeStateRequest()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.corfudb.runtime.clients.IClient

getHandledTypes, getMsgHandler, getRouter, handleMessage, setRouter

Constructor Detail

ManagementClient

public ManagementClient(IClientRouter router,
                        long epoch)

Method Detail

bootstrapManagement

public CompletableFuture<Boolean> bootstrapManagement(Layout l)

Bootstraps a management server.

Parameters:

l - The layout to bootstrap with.

Returns:

A completable future which will return TRUE if the bootstrap was successful, false otherwise.

handleFailure

public CompletableFuture<Boolean> handleFailure(long detectorEpoch,
                                                Set<String> failedNodes)

Sends the failure detected to the relevant management server.

Parameters:

failedNodes - The failed nodes set to be handled.

Returns:

A future which will be return TRUE if completed successfully else returns FALSE.

handleHealing

public CompletableFuture<Boolean> handleHealing(long detectorEpoch,
                                                Set<String> healedNodes)

Sends the healed nodes detected to the relevant management server.

Parameters:

healedNodes - The healed nodes set to be handled.

Returns:

A future which will be return TRUE if completed successfully else returns FALSE.

sendNodeStateRequest

public CompletableFuture<NodeState> sendNodeStateRequest()

sendFailureDetectorMetricsRequest

public CompletableFuture<FailureDetectorMetrics> sendFailureDetectorMetricsRequest()

getLayout

public CompletableFuture<Layout> getLayout()

Requests for the layout persisted by the management server.

Returns:

A future which returns the layout persisted by the management server on completion.

addNodeRequest

public CreateWorkflowResponse addNodeRequest(@Nonnull
                                             String endpoint)
                                      throws TimeoutException

Send a add node request to an orchestrator

Parameters:

endpoint - the endpoint to add to the cluster

Returns:

create workflow response that contains the uuid of the workflow

Throws:

TimeoutException - when the rpc times out

healNodeRequest

public CreateWorkflowResponse healNodeRequest(@Nonnull
                                              String endpoint,
                                              boolean isLayoutServer,
                                              boolean isSequencerServer,
                                              boolean isLogUnitServer,
                                              int stripeIndex)
                                       throws TimeoutException

Creates a workflow request to heal a node.

Parameters:

endpoint - Endpoint of the node to be healed.

isLayoutServer - True if the node to be healed is a layout server.

isSequencerServer - True if the node to be healed is a sequencer server.

isLogUnitServer - True if the node to be healed is a logunit server.

stripeIndex - Stripe index of the node if it is a logunit server.

Returns:

CreateWorkflowResponse which gives the workflowId.

Throws:

TimeoutException - when the rpc times out

mergeSegments

public CreateWorkflowResponse mergeSegments(@Nonnull
                                            String endpoint)
                                     throws TimeoutException

Creates a workflow request to restore all redundancies and merge all segments.

Parameters:

endpoint - Endpoint to restore redundancy.

Returns:

CreateWorkflowResponse which gives the workflowId.

Throws:

TimeoutException - when the rpc times out

queryRequest

public QueryResponse queryRequest(@Nonnull
                                  UUID workflowId)
                           throws TimeoutException

Query the state of a workflow on a particular orchestrator.

Parameters:

workflowId - the workflow to query

Returns:

Query response that contains whether the workflow is running or not

Throws:

TimeoutException - when the rpc times out

removeNode

public CreateWorkflowResponse removeNode(@Nonnull
                                         String endpoint)
                                  throws TimeoutException

Return a workflow id for this remove operation request.

Parameters:

endpoint - the endpoint to remove

Returns:

uuid of the remove workflow

Throws:

TimeoutException - when the rpc times out

forceRemoveNode

public CreateWorkflowResponse forceRemoveNode(@Nonnull
                                              String endpoint)
                                       throws TimeoutException

Send a force remove node request to an orchestrator service node.

Parameters:

endpoint - the endpoint to force remove

Returns:

CreateWorkflowResponse

Throws:

TimeoutException - when the rpc times out

sendMessage

public void sendMessage(CorfuMsg msg)