org.osgi.service.clusterinfo

Interface NodeStatus

All Known Subinterfaces:

FrameworkNodeStatus

public interface NodeStatus

The NodeStatus service represents a node in the cluster.

A node could represent an entity available in the network that is not necessarily running an OSGi framework, such as a database or a load balancer.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getMetrics(java.lang.String... names) Get the current metrics or other dynamic data from the node.

Method Detail

getMetrics

java.util.Map<java.lang.String,java.lang.Object> getMetrics(java.lang.String... names)

Get the current metrics or other dynamic data from the node. Nodes may support custom metrics and as such the caller can request those metrics by name. The caller can specify the metric names to avoid having to compute and send all metrics over, if the caller is only interested in a subset of the available metrics.

Parameters:

names - a set of metric names that have to be obtained from the node. Of no names are specified all available metrics will be obtained. If a metric is requested that is not available by the node this metric is ignored and not present in the returned map.

Returns:

Map with the current node metrics