org.gridgain.grid.kernal

Interface GridComponent

All Known Subinterfaces:

GridDrProcessor<K,V>, GridLicenseProcessor, GridManager, GridProcessor, GridSecureSessionManager, GridSecurityManager, GridSegmentationProcessor, GridVersionProcessor

All Known Implementing Classes:

GridAffinityProcessor, GridCacheProcessor, GridCheckpointManager, GridClockSyncProcessor, GridClosureProcessor, GridCollisionManager, GridContinuousProcessor, GridDataLoaderProcessor, GridDeploymentManager, GridDiscoveryManager, GridEmailProcessorAdapter, GridEventStorageManager, GridFailoverManager, GridGgfsProcessorAdapter, GridIndexingManager, GridIoManager, GridJobMetricsProcessor, GridJobProcessor, GridLoadBalancerManager, GridManagerAdapter, GridNoopEmailProcessor, GridNoopGgfsProcessor, GridNoopManagerAdapter, GridNoopScheduleProcessor, GridOffHeapProcessor, GridOsDrProcessor, GridOsLicenseProcessor, GridOsSecureSessionManager, GridOsSecurityManager, GridOsSegmentationProcessor, GridOsVersionProcessor, GridPortProcessor, GridProcessorAdapter, GridResourceProcessor, GridRestProcessor, GridScheduleProcessorAdapter, GridStreamProcessor, GridSwapSpaceManager, GridTaskProcessor, GridTaskSessionProcessor, GridTimeoutProcessor

public interface GridComponent

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

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.
void	onDiscoveryDataReceived(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.
GridNodeValidationResult	validateNode(GridNode 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 GridException

Starts grid component.

Throws:

GridException - Throws in case of any errors.

stop

void stop(boolean cancel)
          throws GridException

Stops grid component.

Parameters:

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

Throws:

GridException - Thrown in case of any errors.

onKernalStart

void onKernalStart()
                   throws GridException

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

Throws:

GridException - 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(Object data)

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

Parameters:

data - Discovery data object or null if nothing was sent for this component.

printMemoryStats

void printMemoryStats()

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

validateNode

@Nullable
GridNodeValidationResult validateNode(GridNode 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.