org.glassfish.jersey.server.internal.monitoring

Class MonitoringFeature

java.lang.Object

org.glassfish.jersey.server.internal.monitoring.MonitoringFeature

All Implemented Interfaces:

Feature

public final class MonitoringFeature
extends Object
implements Feature

Feature that enables calculating of monitoring statistics and optionally also enables exposure of monitoring MBeans.

Calculation of MonitoringStatistics is necessary in order to expose monitoring MBeans, so by default this feature always enables calculation of MonitoringStatistics. Additionally, the feature can be configured by setting true to setmBeansEnabled(boolean) in order to enable exposure of monitoring MBeans. The same can be achieved by configuration of a property ServerProperties.MONITORING_STATISTICS_MBEANS_ENABLED which overrides the setting defined by the setmBeansEnabled(boolean) method.

The MonitoringStatistics can be controlled also by definition of a property ServerProperties.MONITORING_STATISTICS_ENABLED which overrides the registration of this feature.

When auto-discovery is enabled then monitoring statistics and exposure of MBeans can be controlled only by properties above without a need to explicitly register this feature.

Author:

Miroslav Fuksa

See Also:

for more details.

Constructor Summary

Constructors

Constructor and Description
MonitoringFeature()

Method Summary

Modifier and Type	Method and Description
boolean	configure(FeatureContext context) A call-back method called when the feature is to be enabled in a given runtime configuration scope.
void	setmBeansEnabled(boolean mBeansEnabled) Set whether the feature should also enable exposure of monitoring statistics MBeans.

Methods inherited from class java.lang.Object

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

Constructor Detail

MonitoringFeature

public MonitoringFeature()

Method Detail

configure

public boolean configure(FeatureContext context)

Description copied from interface: Feature

A call-back method called when the feature is to be enabled in a given runtime configuration scope. The responsibility of the feature is to properly update the supplied runtime configuration context and return true if the feature was successfully enabled or false otherwise.

Note that under some circumstances the feature may decide not to enable itself, which is indicated by returning false. In such case the configuration context does not add the feature to the collection of enabled features and a subsequent call to Configuration.isEnabled(Feature) or Configuration.isEnabled(Class) method would return false.

Specified by:

configure in interface Feature

Parameters:

context - configurable context in which the feature should be enabled.

Returns:

true if the feature was successfully enabled, false otherwise.

setmBeansEnabled

public void setmBeansEnabled(boolean mBeansEnabled)

Set whether the feature should also enable exposure of monitoring statistics MBeans. The set value can be overwritten by the definition of the property ServerProperties.MONITORING_STATISTICS_MBEANS_ENABLED.

Parameters:

mBeansEnabled - true is monitoring MBeans should be exposed.