org.gridgain.grid.spi.discovery.tcp.metricsstore

Class GridTcpDiscoveryMetricsStoreAdapter

java.lang.Object

org.gridgain.grid.spi.discovery.tcp.metricsstore.GridTcpDiscoveryMetricsStoreAdapter

All Implemented Interfaces:

GridTcpDiscoveryMetricsStore

Direct Known Subclasses:

GridTcpDiscoveryJdbcMetricsStore, GridTcpDiscoverySharedFsMetricsStore, GridTcpDiscoveryVmMetricsStore

public abstract class GridTcpDiscoveryMetricsStoreAdapter
extends Object
implements GridTcpDiscoveryMetricsStore

Convenient metrics store adapter.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DFLT_METRICS_EXPIRE_TIME Default metrics expire time in milliseconds (value is 10000).

Constructor Summary

Constructors

Constructor and Description
GridTcpDiscoveryMetricsStoreAdapter()

Method Summary

Methods

Modifier and Type	Method and Description
int	getMetricsExpireTime() Gets metrics expire time in milliseconds.
Map<UUID,GridNodeMetrics>	metrics(Collection<UUID> nodeIds) Gets metrics map for provided nodes.
protected abstract Map<UUID,GridNodeMetrics>	metrics0(Collection<UUID> nodeIds) Requests metrics from store in case local cached metrics are outdated.
void	onSpiContextDestroyed() Callback invoked prior to stopping grid before SPI context is destroyed.
void	onSpiContextInitialized(GridSpiContext spiCtx) Callback invoked when SPI context is initialized after GridTcpDiscoverySpi.spiStart(String) method is completed, SPI context can be stored for future access.
void	removeMetrics(Collection<UUID> nodeIds) Removes metrics of provided nodes from the store.
protected abstract void	removeMetrics0(Collection<UUID> nodeIds) Removes metrics from store.
void	setMetricsExpireTime(int metricsExpireTime) Sets metrics expire time in milliseconds.
protected GridSpiContext	spiContext()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gridgain.grid.spi.discovery.tcp.metricsstore.GridTcpDiscoveryMetricsStore

allNodeIds, updateLocalMetrics

Field Detail

DFLT_METRICS_EXPIRE_TIME

public static final int DFLT_METRICS_EXPIRE_TIME

Default metrics expire time in milliseconds (value is 10000).

See Also:

Constant Field Values

Constructor Detail

GridTcpDiscoveryMetricsStoreAdapter

public GridTcpDiscoveryMetricsStoreAdapter()

Method Detail

onSpiContextInitialized

public void onSpiContextInitialized(GridSpiContext spiCtx)
                             throws GridSpiException

Callback invoked when SPI context is initialized after GridTcpDiscoverySpi.spiStart(String) method is completed, SPI context can be stored for future access.

Specified by:

onSpiContextInitialized in interface GridTcpDiscoveryMetricsStore

Parameters:

spiCtx - Spi context.

Throws:

GridSpiException - In case of error.

onSpiContextDestroyed

public void onSpiContextDestroyed()

Callback invoked prior to stopping grid before SPI context is destroyed. Note that invoking SPI context after this callback is complete is considered illegal and may produce unknown results.

Specified by:

onSpiContextDestroyed in interface GridTcpDiscoveryMetricsStore

metrics

public final Map<UUID,GridNodeMetrics> metrics(Collection<UUID> nodeIds)
                                        throws GridSpiException

Gets metrics map for provided nodes.

Specified by:

metrics in interface GridTcpDiscoveryMetricsStore

Parameters:

nodeIds - Nodes to get metrics for.

Returns:

Map, containing metrics for provided nodes. Potentially empty, but never null.

Throws:

GridSpiException - If an error occurs.

removeMetrics

public final void removeMetrics(Collection<UUID> nodeIds)
                         throws GridSpiException

Removes metrics of provided nodes from the store.

Specified by:

removeMetrics in interface GridTcpDiscoveryMetricsStore

Parameters:

nodeIds - Nodes to remove metrics of.

Throws:

GridSpiException - If an error occurs.

getMetricsExpireTime

public int getMetricsExpireTime()

Gets metrics expire time in milliseconds.

Specified by:

getMetricsExpireTime in interface GridTcpDiscoveryMetricsStore

Returns:

Metrics expire time.

setMetricsExpireTime

@GridSpiConfiguration(optional=true)
public void setMetricsExpireTime(int metricsExpireTime)

Sets metrics expire time in milliseconds.

Cached metrics are purged and requested from the store again if older than expire time.

If not provided, default value is DFLT_METRICS_EXPIRE_TIME

Parameters:

metricsExpireTime - Metrics expire time.

metrics0

protected abstract Map<UUID,GridNodeMetrics> metrics0(Collection<UUID> nodeIds)
                                               throws GridSpiException

Requests metrics from store in case local cached metrics are outdated.

Parameters:

nodeIds - Nodes to request metrics for.

Returns:

Metrics map.

Throws:

GridSpiException - If any error occurs.

removeMetrics0

protected abstract void removeMetrics0(Collection<UUID> nodeIds)
                                throws GridSpiException

Removes metrics from store.

Parameters:

nodeIds - Nodes to remove metrics of.

Throws:

GridSpiException - If any error occurs.

spiContext

protected GridSpiContext spiContext()

Returns:

SPI context.