org.opends.server.api

Class MonitorData

java.lang.Object

org.opends.server.api.MonitorData

@PublicAPI(stability=PRIVATE)
public final class MonitorData
extends Object

This class is used to hold monitoring data, i.e. a list of attributes. It provides convenient methods to easily build such data.

Note:
Creating monitor entries may become a lot easier once we've migrated to the SDK Entry class:

 Entry entry = ...;
 entry.addAttribute("stringStat", "aString")
      .addAttribute("integerStat", 12345)
      .addAttribute("dnStat", DN.valueOf("dc=aDN");
 

We could also envisage an annotation based approach where we determine the monitor content from annotated fields/methods in an object.

Constructor Summary

Constructors

Constructor and Description
MonitorData() Builds a MonitorData object by using the server's schema.
MonitorData(Schema schema) Builds a MonitorData object by using the provided schema.

Method Summary

Modifier and Type	Method and Description
MonitorData	add(String attrName, Object attrValue) Adds an attribute with the provided name and value.
MonitorData	addAll(String attrName, Iterable<?> attrValues) Adds an attribute with the provided name and values.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MonitorData

public MonitorData()

Builds a MonitorData object by using the server's schema.

MonitorData

public MonitorData(Schema schema)

Builds a MonitorData object by using the provided schema.

Parameters:

schema - the schema to use when building the monitor data

Method Detail

add

public MonitorData add(String attrName,
                       Object attrValue)

Adds an attribute with the provided name and value.

Parameters:

attrName - the attribute name

attrValue - the attribute value

Returns:

This MonitorData object.

addAll

public MonitorData addAll(String attrName,
                          Iterable<?> attrValues)

Adds an attribute with the provided name and values.

Parameters:

attrName - the attribute name

attrValues - the attribute values

Returns:

This MonitorData object.

toString

public String toString()

Overrides:

toString in class Object