Package org.apache.ignite.internal.processors.cluster

Class GridClusterStateProcessor

java.lang.Object

org.apache.ignite.internal.processors.GridProcessorAdapter

org.apache.ignite.internal.processors.cluster.GridClusterStateProcessor

All Implemented Interfaces:

GridComponent, MetastorageLifecycleListener, IGridClusterStateProcessor, GridProcessor

public class GridClusterStateProcessor
extends GridProcessorAdapter
implements IGridClusterStateProcessor, MetastorageLifecycleListener

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.ignite.internal.GridComponent

GridComponent.DiscoveryDataExchangeType

Field Summary

Fields

Modifier and Type	Field	Description
static String	BASELINE_NODE_ATTRIBUTES_SYS_VIEW
static String	BASELINE_NODE_ATTRIBUTES_SYS_VIEW_DESC
static String	BASELINE_NODES_SYS_VIEW
static String	BASELINE_NODES_SYS_VIEW_DESC
static String	DATA_LOST_ON_DEACTIVATION_WARNING	Warning of unsafe cluster deactivation.

Fields inherited from class org.apache.ignite.internal.processors.GridProcessorAdapter

ctx, diagnosticLog, log

Constructor Summary

Constructors

Constructor	Description
GridClusterStateProcessor(GridKernalContext ctx)

Method Summary

Modifier and Type	Method	Description
protected void	afterStateChangeFinished(IgniteUuid msgId, boolean success)
ExchangeActions	autoAdjustExchangeActions(ExchangeActions exchActs)	Add fake state change request into exchange actions if cluster is not persistent and baseline autoadjustment is enabled with zero timeout.
boolean	autoAdjustInMemoryClusterState(UUID nodeId, Collection<ClusterNode> topSnapshot, DiscoCache discoCache, long topVer, int minorTopVer)	Update baseline locally if cluster is not persistent and baseline autoadjustment is enabled with zero timeout.
void	baselineAutoAdjustEnabled(boolean baselineAutoAdjustEnabled)
IgniteFuture<?>	baselineAutoAdjustEnabledAsync(boolean baselineAutoAdjustEnabled)
BaselineAutoAdjustStatus	baselineAutoAdjustStatus()
long	baselineAutoAdjustTimeout()
void	baselineAutoAdjustTimeout(long baselineAutoAdjustTimeout)
IgniteFuture<?>	baselineAutoAdjustTimeoutAsync(long baselineAutoAdjustTimeout)
DistributedBaselineConfiguration	baselineConfiguration()
void	cacheProcessorStarted()
IgniteInternalFuture<?>	changeGlobalState(ClusterState state, boolean forceDeactivation, Collection<? extends BaselineNode> baselineNodes, boolean forceChangeBaselineTopology)
IgniteInternalFuture<?>	changeGlobalState(ClusterState state, boolean forceDeactivation, Collection<? extends BaselineNode> baselineNodes, boolean forceChangeBaselineTopology, boolean isAutoAdjust)
DiscoveryDataClusterState	clusterState()
void	collectGridNodeData(DiscoveryDataBag dataBag)	Collects discovery data on nodes already in grid on receiving TcpDiscoveryNodeAddedMessage.
void	collectJoiningNodeData(DiscoveryDataBag dataBag)	Collects discovery data on joining node before sending TcpDiscoveryJoinRequestMessage request.
boolean	compatibilityMode()
protected IgniteCheckedException	concurrentStateChangeError(ClusterState state, ClusterState transitionState)
@Nullable GridComponent.DiscoveryDataExchangeType	discoveryDataType()	Gets unique component type to distinguish components providing discovery data.
boolean	evictionsAllowed()
protected boolean	isApplicable(ChangeGlobalStateMessage msg, DiscoveryDataClusterState state)
boolean	isBaselineAutoAdjustEnabled()
protected static boolean	isEquivalent(ChangeGlobalStateMessage msg, DiscoveryDataClusterState state)
long	lastStateChangeTime()
void	onBaselineTopologyChanged(BaselineTopology blt, BaselineTopologyHistoryItem prevBltHistItem)
void	onExchangeFinishedOnCoordinator(IgniteInternalFuture exchangeFuture, boolean hasMovingPartitions)
void	onGridDataReceived(DiscoveryDataBag.GridDiscoveryData data)	Receives discovery data object from remote nodes (called on new node during discovery process).
void	onKernalStart(boolean active)	Callback that notifies that kernal has successfully started, including all managers and processors.
void	onKernalStop(boolean cancel)	Callback to notify that kernal is about to stop.
@Nullable IgniteInternalFuture<Boolean>	onLocalJoin(DiscoCache discoCache)
@Nullable ChangeGlobalStateFinishMessage	onNodeLeft(ClusterNode node)
void	onReadyForRead(ReadOnlyMetastorage metastorage)	Is called when metastorage is made ready for read-only operations very early on node startup phase.
void	onReadyForReadWrite(ReadWriteMetastorage metastorage)	Fully functional metastore capable of performing reading and writing operations.
void	onStateChangeError(Map<UUID,Exception> errs, StateChangeRequest req)
void	onStateChangeExchangeDone(StateChangeRequest req)
boolean	onStateChangeMessage(AffinityTopologyVersion topVer, ChangeGlobalStateMessage msg, DiscoCache discoCache)
void	onStateFinishMessage(ChangeGlobalStateFinishMessage msg)
DiscoveryDataClusterState	pendingState(ChangeGlobalStateMessage stateMsg)
boolean	publicApiActiveState(boolean waitForTransition)
IgniteFuture<Boolean>	publicApiActiveStateAsync(boolean asyncWaitForTransition)
ClusterState	publicApiState(boolean waitForTransition)
IgniteFuture<ClusterState>	publicApiStateAsync(boolean asyncWaitForTransition)
void	resetBranchingHistory(long newBranchingHash)	Resets branching history on current BaselineTopology.
void	start()	Starts grid component.
static ClusterState	stateWithMinimalFeatures(ClusterState state1, ClusterState state2)	Gets state of given two with minimal number of features.
void	stop(boolean cancel)	Stops grid component.
String	toString()
@Nullable IgniteNodeValidationResult	validateNode(ClusterNode node)	Validates that new node can join grid topology, this method is called on coordinator node before new node joins topology.
@Nullable IgniteNodeValidationResult	validateNode(ClusterNode node, DiscoveryDataBag.JoiningNodeDiscoveryData discoData)	Validates that new node can join grid topology, this method is called on coordinator node before new node joins topology.
protected IgniteInternalFuture<?>	wrapStateChangeFuture(IgniteInternalFuture fut, ChangeGlobalStateMessage msg)

Methods inherited from class org.apache.ignite.internal.processors.GridProcessorAdapter

assertParameter, onDisconnected, onJoiningNodeDataReceived, onReconnected, printMemoryStats

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.ignite.internal.GridComponent

onDisconnected, onJoiningNodeDataReceived, onReconnected, printMemoryStats

Field Detail

DATA_LOST_ON_DEACTIVATION_WARNING

public static final String DATA_LOST_ON_DEACTIVATION_WARNING

Warning of unsafe cluster deactivation.

See Also:

Constant Field Values

BASELINE_NODES_SYS_VIEW

public static final String BASELINE_NODES_SYS_VIEW

BASELINE_NODES_SYS_VIEW_DESC

public static final String BASELINE_NODES_SYS_VIEW_DESC

See Also:

Constant Field Values

BASELINE_NODE_ATTRIBUTES_SYS_VIEW

public static final String BASELINE_NODE_ATTRIBUTES_SYS_VIEW

BASELINE_NODE_ATTRIBUTES_SYS_VIEW_DESC

public static final String BASELINE_NODE_ATTRIBUTES_SYS_VIEW_DESC

See Also:

Constant Field Values

Constructor Detail

GridClusterStateProcessor

public GridClusterStateProcessor(GridKernalContext ctx)

Parameters:

ctx - Kernal context.

Method Detail

validateNode

@Nullable
public @Nullable IgniteNodeValidationResult validateNode(ClusterNode node)

Validates that new node can join grid topology, this method is called on coordinator node before new node joins topology.

Specified by:

validateNode in interface GridComponent

Overrides:

validateNode in class GridProcessorAdapter

Parameters:

node - Joining node.

Returns:

Validation result or null in case of success.

compatibilityMode

public boolean compatibilityMode()

Returns:

True if IGridClusterStateProcessor has detected that cluster is working in compatibility mode (nodes of different versions are joined to the cluster).

publicApiState

public ClusterState publicApiState(boolean waitForTransition)

Specified by:

publicApiState in interface IGridClusterStateProcessor

Parameters:

waitForTransition - Wait end of transition or not.

Returns:

Current cluster state to be used on public API.

publicApiStateAsync

public IgniteFuture<ClusterState> publicApiStateAsync(boolean asyncWaitForTransition)

Specified by:

publicApiStateAsync in interface IGridClusterStateProcessor

Parameters:

asyncWaitForTransition - Wait end of transition or not.

Returns:

Current cluster state to be used on public API.

publicApiActiveState

public boolean publicApiActiveState(boolean waitForTransition)

Specified by:

publicApiActiveState in interface IGridClusterStateProcessor

Returns:

Cluster state to be used on public API.

publicApiActiveStateAsync

public IgniteFuture<Boolean> publicApiActiveStateAsync(boolean asyncWaitForTransition)

Specified by:

publicApiActiveStateAsync in interface IGridClusterStateProcessor

Returns:

Cluster state to be used on public API.

lastStateChangeTime

public long lastStateChangeTime()

Specified by:

lastStateChangeTime in interface IGridClusterStateProcessor

Returns:

Time of last cluster state change to be used on public API.

onReadyForRead

public void onReadyForRead(ReadOnlyMetastorage metastorage)
                    throws IgniteCheckedException

Is called when metastorage is made ready for read-only operations very early on node startup phase. Reference for read-only metastorage should be used only within this method and shouldn't be stored to any field.

Specified by:

onReadyForRead in interface MetastorageLifecycleListener

Parameters:

metastorage - Read-only meta storage.

Throws:

IgniteCheckedException

onReadyForReadWrite

public void onReadyForReadWrite(ReadWriteMetastorage metastorage)
                         throws IgniteCheckedException

Fully functional metastore capable of performing reading and writing operations. Components interested in using metastore are allowed to keep reference passed into the method in their fields.

Specified by:

onReadyForReadWrite in interface MetastorageLifecycleListener

Parameters:

metastorage - Fully functional meta storage.

Throws:

IgniteCheckedException

resetBranchingHistory

public void resetBranchingHistory(long newBranchingHash)
                           throws IgniteCheckedException

Resets branching history on current BaselineTopology.

Throws:

IgniteCheckedException - If write to metastore has failed.

start

public void start()
           throws IgniteCheckedException

Starts grid component.

Specified by:

start in interface GridComponent

Overrides:

start in class GridProcessorAdapter

Throws:

IgniteCheckedException - Throws in case of any errors.

onKernalStart

public void onKernalStart(boolean active)
                   throws IgniteCheckedException

Callback that notifies that kernal has successfully started, including all managers and processors.

Specified by:

onKernalStart in interface GridComponent

Overrides:

onKernalStart in class GridProcessorAdapter

Parameters:

active - Cluster active flag (note: should be used carefully since state can change concurrently).

Throws:

IgniteCheckedException - Thrown in case of any errors.

onKernalStop

public void onKernalStop(boolean cancel)

Callback to notify that kernal is about to stop.

Specified by:

onKernalStop in interface GridComponent

Overrides:

onKernalStop in class GridProcessorAdapter

Parameters:

cancel - Flag indicating whether jobs should be canceled.

onLocalJoin

@Nullable
public @Nullable IgniteInternalFuture<Boolean> onLocalJoin(DiscoCache discoCache)

Specified by:

onLocalJoin in interface IGridClusterStateProcessor

Parameters:

discoCache - Discovery data cache.

Returns:

If transition is in progress returns future which is completed when transition finishes.

onNodeLeft

@Nullable
public @Nullable ChangeGlobalStateFinishMessage onNodeLeft(ClusterNode node)

Specified by:

onNodeLeft in interface IGridClusterStateProcessor

Parameters:

node - Failed node.

Returns:

Message if cluster state changed.

onStateFinishMessage

public void onStateFinishMessage(ChangeGlobalStateFinishMessage msg)

Specified by:

onStateFinishMessage in interface IGridClusterStateProcessor

Parameters:

msg - Message.

afterStateChangeFinished

protected void afterStateChangeFinished(IgniteUuid msgId,
                                        boolean success)

onStateChangeMessage

public boolean onStateChangeMessage(AffinityTopologyVersion topVer,
                                    ChangeGlobalStateMessage msg,
                                    DiscoCache discoCache)

Specified by:

onStateChangeMessage in interface IGridClusterStateProcessor

Parameters:

topVer - Current topology version.

msg - Message.

discoCache - Current nodes.

Returns:

True if need start state change process.

isApplicable

protected boolean isApplicable(ChangeGlobalStateMessage msg,
                               DiscoveryDataClusterState state)

Parameters:

msg - State change message.

state - Current cluster state.

Returns:

True if state change from message can be applied to the current state.

isEquivalent

protected static boolean isEquivalent(ChangeGlobalStateMessage msg,
                                      DiscoveryDataClusterState state)

Parameters:

msg - State change message.

state - Current cluster state.

Returns:

True if states are equivalent.

clusterState

public DiscoveryDataClusterState clusterState()

Specified by:

clusterState in interface IGridClusterStateProcessor

Returns:

Current cluster state, should be called only from discovery thread.

pendingState

public DiscoveryDataClusterState pendingState(ChangeGlobalStateMessage stateMsg)

Specified by:

pendingState in interface IGridClusterStateProcessor

Returns:

Pending cluster state which will be used when state transition is finished.

concurrentStateChangeError

protected IgniteCheckedException concurrentStateChangeError(ClusterState state,
                                                            ClusterState transitionState)

Parameters:

state - New state.

transitionState - State in transition.

Returns:

State change error.

cacheProcessorStarted

public void cacheProcessorStarted()

Specified by:

cacheProcessorStarted in interface IGridClusterStateProcessor

stop

public void stop(boolean cancel)
          throws IgniteCheckedException

Stops grid component.

Specified by:

stop in interface GridComponent

Overrides:

stop in class GridProcessorAdapter

Parameters:

cancel - If true, then all ongoing tasks or jobs for relevant components need to be cancelled.

Throws:

IgniteCheckedException - Thrown in case of any errors.

discoveryDataType

@Nullable
public @Nullable GridComponent.DiscoveryDataExchangeType discoveryDataType()

Gets unique component type to distinguish components providing discovery data. Must return non-null value if component implements any of methods GridComponent.collectJoiningNodeData(DiscoveryDataBag) or GridComponent.collectGridNodeData(DiscoveryDataBag).

Specified by:

discoveryDataType in interface GridComponent

Overrides:

discoveryDataType in class GridProcessorAdapter

Returns:

Unique component type for discovery data exchange.

collectJoiningNodeData

public void collectJoiningNodeData(DiscoveryDataBag dataBag)

Collects discovery data on joining node before sending TcpDiscoveryJoinRequestMessage request.

Specified by:

collectJoiningNodeData in interface GridComponent

Overrides:

collectJoiningNodeData in class GridProcessorAdapter

Parameters:

dataBag - container object to store discovery data in.

collectGridNodeData

public void collectGridNodeData(DiscoveryDataBag dataBag)

Collects discovery data on nodes already in grid on receiving TcpDiscoveryNodeAddedMessage.

Specified by:

collectGridNodeData in interface GridComponent

Overrides:

collectGridNodeData in class GridProcessorAdapter

Parameters:

dataBag - container object to store discovery data in.

onGridDataReceived

public void onGridDataReceived(DiscoveryDataBag.GridDiscoveryData data)

Receives discovery data object from remote nodes (called on new node during discovery process).

Specified by:

onGridDataReceived in interface GridComponent

Overrides:

onGridDataReceived in class GridProcessorAdapter

Parameters:

data - DiscoveryDataBag.GridDiscoveryData interface to retrieve discovery data collected on remote nodes (data common for all nodes in grid and specific for each node).

changeGlobalState

public IgniteInternalFuture<?> changeGlobalState(ClusterState state,
                                                 boolean forceDeactivation,
                                                 Collection<? extends BaselineNode> baselineNodes,
                                                 boolean forceChangeBaselineTopology)

Specified by:

changeGlobalState in interface IGridClusterStateProcessor

Parameters:

state - New cluster state.

forceDeactivation - If true, cluster deactivation will be forced.

baselineNodes - New baseline nodes.

forceChangeBaselineTopology - Force change baseline topology.

Returns:

State change future.

See Also:

ClusterState.INACTIVE

changeGlobalState

public IgniteInternalFuture<?> changeGlobalState(ClusterState state,
                                                 boolean forceDeactivation,
                                                 Collection<? extends BaselineNode> baselineNodes,
                                                 boolean forceChangeBaselineTopology,
                                                 boolean isAutoAdjust)

Parameters:

state - New cluster state.

forceDeactivation - If true, cluster deactivation will be forced.

baselineNodes - New baseline nodes.

forceChangeBaselineTopology - Force change baseline topology.

isAutoAdjust - Auto adjusting baseline flag.

Returns:

State change future.

See Also:

ClusterState.INACTIVE

validateNode

@Nullable
public @Nullable IgniteNodeValidationResult validateNode(ClusterNode node,
                                                         DiscoveryDataBag.JoiningNodeDiscoveryData discoData)

Validates that new node can join grid topology, this method is called on coordinator node before new node joins topology.

Specified by:

validateNode in interface GridComponent

Overrides:

validateNode in class GridProcessorAdapter

Parameters:

node - Joining node.

discoData - Joining node discovery data.

Returns:

Validation result or null in case of success.

wrapStateChangeFuture

protected IgniteInternalFuture<?> wrapStateChangeFuture(IgniteInternalFuture fut,
                                                        ChangeGlobalStateMessage msg)

Parameters:

fut - Original state change future.

msg - State change message.

Returns:

Wrapped state change future.

onStateChangeError

public void onStateChangeError(Map<UUID,Exception> errs,
                               StateChangeRequest req)

Specified by:

onStateChangeError in interface IGridClusterStateProcessor

Parameters:

errs - Errors.

req - State change request.

onStateChangeExchangeDone

public void onStateChangeExchangeDone(StateChangeRequest req)

Specified by:

onStateChangeExchangeDone in interface IGridClusterStateProcessor

Parameters:

req - State change request.

onBaselineTopologyChanged

public void onBaselineTopologyChanged(BaselineTopology blt,
                                      BaselineTopologyHistoryItem prevBltHistItem)
                               throws IgniteCheckedException

Specified by:

onBaselineTopologyChanged in interface IGridClusterStateProcessor

Parameters:

blt - New baseline topology.

prevBltHistItem - Previous baseline history item.

Throws:

IgniteCheckedException

autoAdjustInMemoryClusterState

public boolean autoAdjustInMemoryClusterState(UUID nodeId,
                                              Collection<ClusterNode> topSnapshot,
                                              DiscoCache discoCache,
                                              long topVer,
                                              int minorTopVer)

Update baseline locally if cluster is not persistent and baseline autoadjustment is enabled with zero timeout.

Parameters:

nodeId - Id of the node that initiated the operation (joined/left/failed).

topSnapshot - Topology snapshot from the discovery message.

discoCache - Discovery cache from the discovery manager.

topVer - Topology version.

minorTopVer - Minor topology version.

Returns:

true if baseline was changed and discovery cache recalculation is required.

autoAdjustExchangeActions

public ExchangeActions autoAdjustExchangeActions(ExchangeActions exchActs)

Add fake state change request into exchange actions if cluster is not persistent and baseline autoadjustment is enabled with zero timeout.

Parameters:

exchActs - Current exchange actions.

Returns:

New exchange actions.

onExchangeFinishedOnCoordinator

public void onExchangeFinishedOnCoordinator(IgniteInternalFuture exchangeFuture,
                                            boolean hasMovingPartitions)

Specified by:

onExchangeFinishedOnCoordinator in interface IGridClusterStateProcessor

Parameters:

exchangeFuture - Exchange future.

hasMovingPartitions - True if there are moving partitions.

evictionsAllowed

public boolean evictionsAllowed()

Specified by:

evictionsAllowed in interface IGridClusterStateProcessor

Returns:

True if partition evictions are allowed in current state.

isBaselineAutoAdjustEnabled

public boolean isBaselineAutoAdjustEnabled()

Returns:

Value of manual baseline control or auto adjusting baseline. True If cluster in auto-adjust. False If cluster in manuale.

baselineAutoAdjustEnabled

public void baselineAutoAdjustEnabled(boolean baselineAutoAdjustEnabled)

Parameters:

baselineAutoAdjustEnabled - Value of manual baseline control or auto adjusting baseline. True If cluster in auto-adjust. False If cluster in manuale.

Throws:

IgniteException - If operation failed.

baselineAutoAdjustEnabledAsync

public IgniteFuture<?> baselineAutoAdjustEnabledAsync(boolean baselineAutoAdjustEnabled)

Parameters:

baselineAutoAdjustEnabled - Value of manual baseline control or auto adjusting baseline. True If cluster in auto-adjust. False If cluster in manuale.

Returns:

Future for await operation completion.

baselineAutoAdjustTimeout

public long baselineAutoAdjustTimeout()

Returns:

Value of time which we would wait before the actual topology change since last server topology change (node join/left/fail).

Throws:

IgniteException - If operation failed.

baselineAutoAdjustTimeout

public void baselineAutoAdjustTimeout(long baselineAutoAdjustTimeout)

Parameters:

baselineAutoAdjustTimeout - Value of time which we would wait before the actual topology change since last server topology change (node join/left/fail).

Throws:

IgniteException - If failed.

baselineAutoAdjustTimeoutAsync

public IgniteFuture<?> baselineAutoAdjustTimeoutAsync(long baselineAutoAdjustTimeout)

Parameters:

baselineAutoAdjustTimeout - Value of time which we would wait before the actual topology change since last server topology change (node join/left/fail).

Returns:

Future for await operation completion.

baselineConfiguration

public DistributedBaselineConfiguration baselineConfiguration()

Returns:

Baseline configuration.

baselineAutoAdjustStatus

public BaselineAutoAdjustStatus baselineAutoAdjustStatus()

Returns:

Status of baseline auto-adjust.

stateWithMinimalFeatures

public static ClusterState stateWithMinimalFeatures(ClusterState state1,
                                                    ClusterState state2)

Gets state of given two with minimal number of features.

The order: ClusterState.ACTIVE > ClusterState.ACTIVE_READ_ONLY > ClusterState.INACTIVE.

Explain:
ClusterState.INACTIVE has the smallast number of available features. You can't use caches in this state.
In ClusterState.ACTIVE_READ_ONLY you have more available features than ClusterState.INACTIVE state, such as reading from caches, but can't write into them.
In ClusterState.ACTIVE you can update caches. It's a state with the biggest number of features.

Parameters:

state1 - First given state.

state2 - Second given state.

Returns:

State with minimal number of available features.

toString

public String toString()

Overrides:

toString in class GridProcessorAdapter