org.corfudb.universe.group

Interface Group

All Known Subinterfaces:

Cluster, CorfuCluster

All Known Implementing Classes:

AbstractCorfuCluster, DockerCorfuCluster, VmCorfuCluster

public interface Group

This provides an abstraction for a group of Nodes that come together to provide a logical service.

The following are the main functionalities provided by this class:

DEPLOY: deploys a Group representing a collection of Node-s using the provided configuration in Group.GroupParams STOP: stops a Group gracefully within the provided timeout KILL: kills a Group immediately

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Group.GroupParams

Method Summary

Modifier and Type	Method and Description
Node	add(Node.NodeParams nodeParams)
Group	deploy() Deploy the Group into the Universe.
void	destroy() Destroy the Group immediately by destroying all the Node-s of the group.
<T extends Node> T	getNode(String nodeName)
<T extends Group.GroupParams> T	getParams() Provides Group.GroupParams used for configuring a Group
void	kill() Kill the Group immediately by killing all the Node-s of the group.
<T extends Node> com.google.common.collect.ImmutableSortedMap<String,T>	nodes() Provide the nodes that the Group is composed of.
void	stop(Duration timeout) Stop the Group by stopping all individual Node-s of the group.

Method Detail

deploy

Group deploy()

Deploy the Group into the Universe.

Returns:

current instance of deployed Group

stop

void stop(Duration timeout)

Stop the Group by stopping all individual Node-s of the group. Must happened within the limit of provided timeout.

Parameters:

timeout - allowed time to gracefully stop the Group

kill

void kill()

Kill the Group immediately by killing all the Node-s of the group. Kill - means stop or interrupt immediately

destroy

void destroy()

Destroy the Group immediately by destroying all the Node-s of the group. Destroy - means kill and clean up the node directory which contains the application itself and could contain config files, db files and so on.

add

Node add(Node.NodeParams nodeParams)

getParams

<T extends Group.GroupParams> T getParams()

Provides Group.GroupParams used for configuring a Group

Returns:

a Group parameters

nodes

<T extends Node> com.google.common.collect.ImmutableSortedMap<String,T> nodes()

Provide the nodes that the Group is composed of.

Returns:

an ImmutableList of Nodes.

getNode

<T extends Node> T getNode(String nodeName)