nl.gx.webmanager.services.systemhealth
Interface SystemHealthIndicator

All Known Subinterfaces:

SystemHealthIndicatorWrapperMBean

All Known Implementing Classes:

SystemHealthIndicatorWrapper

public interface SystemHealthIndicator

System health indicator.

Nested Class Summary

static class

SystemHealthIndicator.ValueStatus Enumeration of the possible states of a value attached to the indicator, which represent the health of the component that is monitored.

Field Summary

static java.lang.String	CATEGORY_CACHING A default category for caching related indicators.
static java.lang.String	CATEGORY_RESPONSE_TIME A default category for response time related indicators.
static java.lang.String	CATEGORY_SETTINGS A default category for configuration related indicators.
static java.lang.String	JMX_CATEGORY_KEY The key for the JMX category property.
static java.lang.String	JMX_PI_DOMAIN The JMX domain under which indicator MBeans are stored.
static java.lang.String	JMX_TITLE_KEY The key for the JMX title property.
static java.lang.String	JMX_TYPE_KEY The key for the JMX type property.
static java.lang.String	TYPE_CUSTOM The type which is to be used by WCBs that provide custom indicators.
static java.lang.String	TYPE_SYSTEM The type which is to be used by WM out-of-the-box indicators.

Method Summary

java.lang.String	getCategory() Get the category of this indicator.
java.lang.String	getId()
java.lang.String	getMessage(java.util.Locale locale) Get an explanatory message in the given language.
java.lang.String	getName(java.util.Locale locale) Get name of this performance indicator in the given language.
java.lang.String	getType() Get the type of this indicator.
java.lang.Object	getValue()
SystemHealthIndicator.ValueStatus	getValueState()
void	reset() Resets the indicator.

Field Detail

JMX_PI_DOMAIN

static final java.lang.String JMX_PI_DOMAIN

The JMX domain under which indicator MBeans are stored.

See Also:

Constant Field Values

JMX_TITLE_KEY

static final java.lang.String JMX_TITLE_KEY

The key for the JMX title property.

See Also:

Constant Field Values

JMX_CATEGORY_KEY

static final java.lang.String JMX_CATEGORY_KEY

The key for the JMX category property.

See Also:

Constant Field Values

JMX_TYPE_KEY

static final java.lang.String JMX_TYPE_KEY

The key for the JMX type property.

See Also:

Constant Field Values

TYPE_SYSTEM

static final java.lang.String TYPE_SYSTEM

The type which is to be used by WM out-of-the-box indicators.

See Also:

Constant Field Values

TYPE_CUSTOM

static final java.lang.String TYPE_CUSTOM

The type which is to be used by WCBs that provide custom indicators.

See Also:

Constant Field Values

CATEGORY_RESPONSE_TIME

static final java.lang.String CATEGORY_RESPONSE_TIME

A default category for response time related indicators.

See Also:

Constant Field Values

CATEGORY_CACHING

static final java.lang.String CATEGORY_CACHING

A default category for caching related indicators.

See Also:

Constant Field Values

CATEGORY_SETTINGS

static final java.lang.String CATEGORY_SETTINGS

A default category for configuration related indicators.

See Also:

Constant Field Values

Method Detail

getId

java.lang.String getId()

Returns:

a unique id

getCategory

java.lang.String getCategory()

Get the category of this indicator. There are 3 default categories: (see above), but a new category may be returned.

Returns:

the category of this indicator

getType

java.lang.String getType()

Get the type of this indicator. There are two valid types: TYPE_SYSTEM and TYPE_CUSTOM. WCB developers should use the latter.

Returns:

the type of this indicator

getName

java.lang.String getName(java.util.Locale locale)

Get name of this performance indicator in the given language.

Parameters:

locale - the locale

Returns:

the indicators name

getValue

java.lang.Object getValue()

Returns:

the value of this indicator

getValueState

SystemHealthIndicator.ValueStatus getValueState()

Returns:

the health state of the system that this indicator monitors

getMessage

java.lang.String getMessage(java.util.Locale locale)

Get an explanatory message in the given language.

Parameters:

locale - the current locale

Returns:

explanation of what this indicator monitors

reset

void reset()

Resets the indicator.