org.rvpf.service

Class StatsHolder

Object

NotificationBroadcasterSupport

StatsHolder

All Implemented Interfaces:

NotificationBroadcaster, NotificationEmitter, StatsOwner, StatsHolderMBean

Direct Known Subclasses:

ServiceActivatorBase, SOMStatsHolder

@ThreadSafe
public abstract class StatsHolder
extends NotificationBroadcasterSupport
implements StatsHolderMBean, StatsOwner

Stats holder.

Base class for MBeans holding Stats.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StatsHolder.UpdateNotification Update notification.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTIVATOR_CLASS_NAME_SUFFIX Activator class name suffix.
static String	DEFAULT_DOMAIN Default domain.
static String	DOMAIN_PROPERTY Domain property.
protected static String	NAME_KEY JMX name key.
static String	STATS_UPDATE_TYPE Stats update type.
protected static String	TYPE_KEY JMX type key.

Constructor Summary

Constructors

Constructor and Description
StatsHolder()

Method Summary

Modifier and Type	Method and Description
static String	getDefaultDomain() Gets the default JMX domain.
ObjectName	getObjectName() Gets the object name.
Optional<String>	getObjectVersion() Gets the object's version.
protected abstract Optional<? extends Stats>	getStats() Gets the stats.
String[]	getStatsStrings() Gets the stats strings.
protected Logger	getThisLogger() Gets the logger.
ObjectName	makeObjectName(Optional<String> nameValue) Makes an object name.
static ObjectName	makeObjectName(String domain, String typeValue, Optional<String> nameValue) Makes an object name.
protected Optional<ObjectName>	objectName() Returns the object name.
void	onStatsUpdated() Called when the stats are updated.
void	setObjectName(ObjectName objectName) Sets the object name.
abstract void	updateStats() Updates the stats.

Methods inherited from class NotificationBroadcasterSupport

addNotificationListener, getNotificationInfo, handleNotification, removeNotificationListener, removeNotificationListener, sendNotification

Methods inherited from class Object

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

Field Detail

ACTIVATOR_CLASS_NAME_SUFFIX

public static final String ACTIVATOR_CLASS_NAME_SUFFIX

Activator class name suffix.

See Also:

Constant Field Values

DEFAULT_DOMAIN

public static final String DEFAULT_DOMAIN

Default domain.

See Also:

Constant Field Values

DOMAIN_PROPERTY

public static final String DOMAIN_PROPERTY

Domain property.

See Also:

Constant Field Values

STATS_UPDATE_TYPE

public static final String STATS_UPDATE_TYPE

Stats update type.

See Also:

Constant Field Values

NAME_KEY

protected static final String NAME_KEY

JMX name key.

See Also:

Constant Field Values

TYPE_KEY

protected static final String TYPE_KEY

JMX type key.

See Also:

Constant Field Values

Constructor Detail

StatsHolder

public StatsHolder()

Method Detail

getDefaultDomain

@Nonnull
 @CheckReturnValue
public static String getDefaultDomain()

Gets the default JMX domain.

Returns:

The default JMX domain.

makeObjectName

@Nonnull
 @CheckReturnValue
public static ObjectName makeObjectName(@Nonnull
                                                                      String domain,
                                                                      @Nonnull
                                                                      String typeValue,
                                                                      @Nonnull
                                                                      Optional<String> nameValue)

Makes an object name.

Parameters:

domain - The object's domain.

typeValue - The value for the 'type' key.

nameValue - The value for the 'name' key (optional).

Returns:

The object name.

getObjectName

public ObjectName getObjectName()

Gets the object name.

Specified by:

getObjectName in interface StatsOwner

Returns:

The object name.

getObjectVersion

public Optional<String> getObjectVersion()

Gets the object's version.

Specified by:

getObjectVersion in interface StatsOwner

Returns:

The optional object's version.

getStatsStrings

public final String[] getStatsStrings()

Gets the stats strings.

Specified by:

getStatsStrings in interface StatsHolderMBean

Returns:

The stats strings.

makeObjectName

@Nonnull
 @CheckReturnValue
public ObjectName makeObjectName(@Nonnull
                                                               Optional<String> nameValue)

Makes an object name.

Parameters:

nameValue - The value for the 'name' key (optional).

Returns:

The object name.

onStatsUpdated

public final void onStatsUpdated()

Called when the stats are updated.

Specified by:

onStatsUpdated in interface StatsOwner

setObjectName

public final void setObjectName(@Nonnull
                                ObjectName objectName)

Sets the object name.

Parameters:

objectName - The object name.

updateStats

public abstract void updateStats()

Updates the stats.

Specified by:

updateStats in interface StatsOwner

getStats

@Nonnull
 @CheckReturnValue
protected abstract Optional<? extends Stats> getStats()

Gets the stats.

Returns:

The optional stats.

getThisLogger

@Nonnull
 @CheckReturnValue
protected final Logger getThisLogger()

Gets the logger.

Returns:

The logger.

objectName

@Nonnull
 @CheckReturnValue
protected final Optional<ObjectName> objectName()

Returns the object name.

Returns:

The object name (empty if undefined).