org.gridgain.grid.spi.discovery.tcp.internal

Class GridTcpDiscoveryNode

java.lang.Object

org.gridgain.grid.util.lang.GridMetadataAwareAdapter

org.gridgain.grid.spi.discovery.tcp.internal.GridTcpDiscoveryNode

All Implemented Interfaces:

Externalizable, Serializable, Comparable<GridTcpDiscoveryNode>, GridMetadataAware, GridNode

public class GridTcpDiscoveryNode
extends GridMetadataAwareAdapter
implements GridNode, Comparable<GridTcpDiscoveryNode>, Externalizable

Node for GridTcpDiscoverySpi.

This class is not intended for public use and has been made public due to certain limitations of Java technology.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GridTcpDiscoveryNode() Public default no-arg constructor for Externalizable interface.
GridTcpDiscoveryNode(UUID id, Collection<String> addrs, Collection<String> hostNames, int discPort, GridDiscoveryMetricsProvider metricsProvider, GridProductVersion ver) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Collection<String>	addresses() Gets collection of addresses this node is known by.
<T> T	attribute(String name) Gets a node attribute.
Map<String,Object>	attributes() Gets all node attributes.
int	compareTo(GridTcpDiscoveryNode node)
Object	consistentId() Gets consistent globally unique node ID.
int	discoveryPort()
boolean	equals(Object o)
Map<String,Object>	getAttributes() Gets node attributes without filtering.
int	hashCode()
Collection<String>	hostNames() Gets collection of host names this node is known by.
UUID	id() Gets globally unique node ID.
long	internalOrder()
void	internalOrder(long intOrder)
boolean	isDaemon() Tests whether or not this node is a daemon.
boolean	isLocal() Tests whether or not this node is a local node.
long	lastUpdateTime() Gets node last update time.
void	lastUpdateTime(long lastUpdateTime) Sets node last update.
void	local(boolean loc)
void	logger(GridLogger log) Sets log.
GridNodeMetrics	metrics() Gets metrics snapshot for this node.
void	metricsStore(GridTcpDiscoveryMetricsStore metricsStore) Sets metrics store.
long	order() Node order within grid topology.
void	order(long order)
void	readExternal(ObjectInput in)
void	setAttributes(Map<String,Object> attrs) Sets node attributes.
void	setMetrics(GridNodeMetrics metrics) Sets node metrics.
Collection<InetSocketAddress>	socketAddresses()
String	toString()
GridProductVersion	version() Gets node version.
void	version(GridProductVersion ver)
boolean	visible() Gets visible flag.
void	visible(boolean visible) Sets visible flag.
void	writeExternal(ObjectOutput out)

Methods inherited from class org.gridgain.grid.util.lang.GridMetadataAwareAdapter

addMeta, addMetaIfAbsent, addMetaIfAbsent, allMeta, clone, copyMeta, copyMeta, hasMeta, hasMeta, meta, putMetaIfAbsent, putMetaIfAbsent, readExternalMeta, removeMeta, removeMeta, replaceMeta, writeExternalMeta

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.gridgain.grid.GridMetadataAware

addMeta, addMetaIfAbsent, addMetaIfAbsent, allMeta, copyMeta, copyMeta, hasMeta, hasMeta, meta, putMetaIfAbsent, putMetaIfAbsent, removeMeta, removeMeta, replaceMeta

Constructor Detail

GridTcpDiscoveryNode

public GridTcpDiscoveryNode()

Public default no-arg constructor for Externalizable interface.

GridTcpDiscoveryNode

public GridTcpDiscoveryNode(UUID id,
                    Collection<String> addrs,
                    Collection<String> hostNames,
                    int discPort,
                    GridDiscoveryMetricsProvider metricsProvider,
                    GridProductVersion ver)

Constructor.

Parameters:

id - Node Id.

addrs - Addresses.

hostNames - Host names.

discPort - Port.

metricsProvider - Metrics provider.

ver - Version.

Method Detail

metricsStore

public void metricsStore(GridTcpDiscoveryMetricsStore metricsStore)

Sets metrics store.

Parameters:

metricsStore - Metrics store.

logger

public void logger(GridLogger log)

Sets log.

Parameters:

log - Grid logger.

id

public UUID id()

Gets globally unique node ID. A new ID is generated every time a node restarts.

Specified by:

id in interface GridNode

Returns:

Globally unique node ID.

consistentId

public Object consistentId()

Gets consistent globally unique node ID. Unlike GridNode.id() method, this method returns consistent node ID which survives node restarts.

Specified by:

consistentId in interface GridNode

Returns:

Consistent globally unique node ID.

attribute

public <T> T attribute(String name)

Gets a node attribute. Attributes are assigned to nodes at startup via GridConfiguration.getUserAttributes() method.

The system adds the following attributes automatically:

• {@link System#getProperties()} - All system properties.
• {@link System#getenv(String)} - All environment properties.
• All attributes defined in GridNodeAttributes

Note that attributes cannot be changed at runtime.

Specified by:

attribute in interface GridNode

Type Parameters:

T - Attribute Type.

Parameters:

name - Attribute name. Note that attribute names starting with org.gridgain are reserved for internal use.

Returns:

Attribute value or null.

attributes

public Map<String,Object> attributes()

Gets all node attributes. Attributes are assigned to nodes at startup via GridConfiguration.getUserAttributes() method.

The system adds the following attributes automatically:

• {@link System#getProperties()} - All system properties.
• {@link System#getenv(String)} - All environment properties.
• All attributes defined in GridNodeAttributes

Note that attributes cannot be changed at runtime.

Specified by:

attributes in interface GridNode

Returns:

All node attributes.

setAttributes

public void setAttributes(Map<String,Object> attrs)

Sets node attributes.

Parameters:

attrs - Node attributes.

getAttributes

public Map<String,Object> getAttributes()

Gets node attributes without filtering.

Returns:

Node attributes without filtering.

metrics

public GridNodeMetrics metrics()

Gets metrics snapshot for this node. Note that node metrics are constantly updated and provide up to date information about nodes. For example, you can get an idea about CPU load on remote node via GridNodeMetrics.getCurrentCpuLoad() method and use it during GridComputeTask.map(List, Object) or during collision resolution.

Node metrics are updated with some delay which is directly related to heartbeat frequency. For example, when used with default GridTcpDiscoverySpi the update will happen every 2 seconds.

Specified by:

metrics in interface GridNode

Returns:

Runtime metrics snapshot for this node.

setMetrics

public void setMetrics(GridNodeMetrics metrics)

Sets node metrics.

Parameters:

metrics - Node metrics.

internalOrder

public long internalOrder()

Returns:

Internal order.

internalOrder

public void internalOrder(long intOrder)

Parameters:

intOrder - Internal order of the node.

order

public long order()

Description copied from interface: GridNode

Node order within grid topology. Discovery SPIs that support node ordering will assign a proper order to each node and will guarantee that discovery event notifications for new nodes will come in proper order. All other SPIs not supporting ordering may choose to return node startup time here.

NOTE: in cases when discovery SPI doesn't support ordering GridGain cannot guarantee that orders on all nodes will be unique or chronologically correct. If such guarantee is required - make sure use discovery SPI that provides ordering.

Specified by:

order in interface GridNode

Returns:

Order.

order

public void order(long order)

Parameters:

order - Order of the node.

version

public GridProductVersion version()

Gets node version.

Specified by:

version in interface GridNode

Returns:

Node version.

version

public void version(GridProductVersion ver)

Parameters:

ver - Version.

addresses

public Collection<String> addresses()

Gets collection of addresses this node is known by.

If GridConfiguration.getLocalHost() value isn't null node will try to use that address for all communications and returned collection will contain only that address. If it is null then local wildcard address will be used, and GridGain will make the best effort to supply all addresses of that node in returned collection.

Specified by:

addresses in interface GridNode

Returns:

Collection of addresses.

isLocal

public boolean isLocal()

Tests whether or not this node is a local node.

Specified by:

isLocal in interface GridNode

Returns:

True if this node is a local node, false otherwise.

local

public void local(boolean loc)

Parameters:

loc - Grid local node flag.

isDaemon

public boolean isDaemon()

Tests whether or not this node is a daemon.

Daemon nodes are the usual grid nodes that participate in topology but not visible on the main APIs, i.e. they are not part of any projections. The only way to see daemon nodes is to use GridProjection.forDaemons() method.

Daemon nodes are used primarily for management and monitoring functionality that is build on GridGain and needs to participate in the topology but should be excluded from "normal" topology so that it won't participate in task execution or in-memory database.

Application code should never use daemon nodes.

Specified by:

isDaemon in interface GridNode

Returns:

True if this node is a daemon, false otherwise.

hostNames

public Collection<String> hostNames()

Gets collection of host names this node is known by.

If GridConfiguration.getLocalHost() value isn't null node will try to use the host name of that resolved address for all communications and returned collection will contain only that host name. If that host name can not be resolved then ip address returned by method GridNode.addresses() is used.

If GridConfiguration.getLocalHost() value is null then local wildcard address will be used, and this method returns host names of all addresses of that node.

Specified by:

hostNames in interface GridNode

Returns:

Collection of host names.

discoveryPort

public int discoveryPort()

Returns:

Discovery port.

socketAddresses

public Collection<InetSocketAddress> socketAddresses()

Returns:

Addresses that could be used by discovery.

lastUpdateTime

public long lastUpdateTime()

Gets node last update time.

Returns:

Time of the last heartbeat.

lastUpdateTime

public void lastUpdateTime(long lastUpdateTime)

Sets node last update.

Parameters:

lastUpdateTime - Time of last metrics update.

visible

public boolean visible()

Gets visible flag.

Returns:

true if node is in visible state.

visible

public void visible(boolean visible)

Sets visible flag.

Parameters:

visible - true if node is in visible state.

compareTo

public int compareTo(@Nullable
            GridTcpDiscoveryNode node)

Specified by:

compareTo in interface Comparable<GridTcpDiscoveryNode>

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object