org.apache.ignite.internal

Interface GridComponent

All Known Subinterfaces:

GridManager, GridProcessor, GridSecurityProcessor, GridSegmentationProcessor, IgniteCacheObjectProcessor

All Known Implementing Classes:

ClusterProcessor, DataStreamProcessor, DataStructuresProcessor, GridAffinityProcessor, GridCacheProcessor, GridCheckpointManager, GridClockSyncProcessor, GridClosureProcessor, GridCollisionManager, GridContinuousProcessor, GridDeploymentManager, GridDiscoveryManager, GridEventStorageManager, GridFailoverManager, GridIndexingManager, GridIoManager, GridJobMetricsProcessor, GridJobProcessor, GridLoadBalancerManager, GridManagerAdapter, GridOffHeapProcessor, GridOsSecurityProcessor, GridOsSegmentationProcessor, GridPluginComponent, GridPortProcessor, GridProcessorAdapter, GridQueryProcessor, GridResourceProcessor, GridRestProcessor, GridServiceProcessor, GridSwapSpaceManager, GridTaskProcessor, GridTaskSessionProcessor, GridTimeoutProcessor, HadoopNoopProcessor, HadoopProcessorAdapter, IgfsNoopProcessor, IgfsProcessor, IgfsProcessorAdapter, IgniteCacheObjectProcessorImpl, IgniteNoopScheduleProcessor, IgnitePluginProcessor, IgniteScheduleProcessorAdapter

public interface GridComponent

Interface for all main internal Ignite components (managers and processors).

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	GridComponent.DiscoveryDataExchangeType Unique component type for discovery data exchange.

Method Summary

Methods

Modifier and Type	Method and Description
Object	collectDiscoveryData(UUID nodeId) Gets discovery data object that will be sent to new node during discovery process.
GridComponent.DiscoveryDataExchangeType	discoveryDataType() Gets unique component type to distinguish components providing discovery data.
void	onDiscoveryDataReceived(UUID joiningNodeId, UUID rmtNodeId, Object data) Receives discovery data object from remote nodes (called on new node during discovery process).
void	onKernalStart() 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.
void	printMemoryStats() Prints memory statistics (sizes of internal structures, etc.).
void	start() Starts grid component.
void	stop(boolean cancel) Stops grid component.
IgniteSpiNodeValidationResult	validateNode(ClusterNode node) Validates that new node can join grid topology, this method is called on coordinator node before new node joins topology.

Method Detail

start

void start()
           throws IgniteCheckedException

Starts grid component.

Throws:

IgniteCheckedException - Throws in case of any errors.

stop

void stop(boolean cancel)
          throws IgniteCheckedException

Stops grid component.

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.

onKernalStart

void onKernalStart()
                   throws IgniteCheckedException

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

Throws:

IgniteCheckedException - Thrown in case of any errors.

onKernalStop

void onKernalStop(boolean cancel)

Callback to notify that kernal is about to stop.

Parameters:

cancel - Flag indicating whether jobs should be canceled.

collectDiscoveryData

@Nullable
Object collectDiscoveryData(UUID nodeId)

Gets discovery data object that will be sent to new node during discovery process.

Parameters:

nodeId - ID of new node that joins topology.

Returns:

Discovery data object or null if there is nothing to send for this component.

onDiscoveryDataReceived

void onDiscoveryDataReceived(UUID joiningNodeId,
                           UUID rmtNodeId,
                           Object data)

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

Parameters:

joiningNodeId - Joining node ID.

rmtNodeId - Remote node ID for which data is provided.

data - Discovery data object or null if nothing was

printMemoryStats

void printMemoryStats()

Prints memory statistics (sizes of internal structures, etc.). NOTE: this method is for testing and profiling purposes only.

validateNode

@Nullable
IgniteSpiNodeValidationResult validateNode(ClusterNode node)

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

Parameters:

node - Joining node.

Returns:

Validation result or null in case of success.

discoveryDataType

@Nullable
GridComponent.DiscoveryDataExchangeType discoveryDataType()

Gets unique component type to distinguish components providing discovery data. Must return non-null value if component implements method collectDiscoveryData(UUID).

Returns:

Unique component type for discovery data exchange.