GridGain™ 2.0.3
Java API Specification

org.gridgain.grid.spi.discovery
Interface GridDiscoverySpi

All Superinterfaces:
GridSpi
All Known Implementing Classes:
GridCoherenceDiscoverySpi, GridJbossDiscoverySpi, GridJgroupsDiscoverySpi, GridJmsDiscoverySpi, GridMailDiscoverySpi, GridMuleDiscoverySpi, GridMulticastDiscoverySpi

@Apache20LicenseCompatible
public interface GridDiscoverySpi
extends GridSpi

Grid discovery SPI allows to discover remote nodes in grid.

The default discovery SPI is GridMulticastDiscoverySpi with default configuration which allows all nodes in local network (with enabled multicast) to discover each other.

Gridgain provides the following GridDeploymentSpi implementations:





See Also:

  Documentation
  Email Support
  Online Forums
  Issue Tracking

Author:   2005-2008 Copyright © GridGain Systems. All Rights Reserved. ver. 2.0.3

 

Method Summary
 GridNode getLocalNode()
          Gets local node.
 GridNode getNode(UUID nodeId)
          Gets node by ID.
 Collection<GridNode> getRemoteNodes()
          Gets collection of remote nodes in grid or empty collection if no remote nodes found.
 boolean pingNode(UUID nodeId)
          Pings the remote node to see if it's alive.
 void setListener(GridDiscoveryListener listener)
          Sets a listener for discovery events.
 void setMetricsProvider(GridDiscoveryMetricsProvider metricsProvider)
          Sets discovery metrics provider.
 void setNodeAttributes(Map<String,Serializable> attrs)
          Sets node attributes which will be distributed in grid during join process.
 
Methods inherited from interface org.gridgain.grid.spi.GridSpi
getNodeAttributes, onContextDestroyed, onContextInitialized, spiStart, spiStop
 

Method Detail

getRemoteNodes

Collection<GridNode> getRemoteNodes()
Gets collection of remote nodes in grid or empty collection if no remote nodes found.

Returns:
Collection of remote nodes.

getLocalNode

GridNode getLocalNode()
Gets local node.

Returns:
Local node.

getNode

GridNode getNode(UUID nodeId)
Gets node by ID.

Parameters:
nodeId - Node ID.
Returns:
Node with given ID or null if node is not found.

pingNode

boolean pingNode(UUID nodeId)
Pings the remote node to see if it's alive.

Parameters:
nodeId - Node Id.
Returns:
true if node alive, false otherwise.

setNodeAttributes

void setNodeAttributes(Map<String,Serializable> attrs)
Sets node attributes which will be distributed in grid during join process. Note that these attributes cannot be changed and set only once.

Parameters:
attrs - Map of node attributes.

setListener

void setListener(GridDiscoveryListener listener)
Sets a listener for discovery events. Refer to GridDiscoveryEventType for a set of all possible discovery events.

Parameters:
listener - Listener to discovery events.

setMetricsProvider

void setMetricsProvider(GridDiscoveryMetricsProvider metricsProvider)
Sets discovery metrics provider. Use metrics provided by GridDiscoveryMetricsProvider.getMetrics() method to exchange dynamic metrics between nodes.

Parameters:
metricsProvider - Provider of metrics data.

GridGain™ 2.0.3
Java API Specification

GridGain™ - Grid Computing Made Simple, ver. 2.0.3.20052008
2005-2008 Copyright © GridGain Systems. All Rights Reserved.