Interface CrestMetricsEndpointCfg
-
- All Superinterfaces:
Configuration
,HttpEndpointCfg
public interface CrestMetricsEndpointCfg extends HttpEndpointCfg
A server-side interface for querying Common REST Metrics HTTP Endpoint settings.The Common REST Metrics HTTP Endpoint provides access to OpenDJ's monitoring information via the Common REST protocol.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addCrestMetricsEndpointChangeListener(ConfigurationChangeListener<CrestMetricsEndpointCfg> listener)
Register to be notified when this Common REST Metrics HTTP Endpoint is changed.Class<? extends CrestMetricsEndpointCfg>
configurationClass()
Gets the configuration class associated with this Common REST Metrics HTTP Endpoint.SortedSet<String>
getExcludedMetricPattern()
Gets the "excluded-metric-pattern" property.SortedSet<String>
getIncludedMetricPattern()
Gets the "included-metric-pattern" property.String
getJavaClass()
Gets the "java-class" property.void
removeCrestMetricsEndpointChangeListener(ConfigurationChangeListener<CrestMetricsEndpointCfg> listener)
Deregister an existing Common REST Metrics HTTP Endpoint configuration change listener.-
Methods inherited from interface org.forgerock.opendj.config.Configuration
dn, name
-
Methods inherited from interface org.forgerock.opendj.server.config.server.HttpEndpointCfg
addChangeListener, getAuthorizationMechanism, getAuthorizationMechanismDns, getBasePath, isEnabled, removeChangeListener
-
-
-
-
Method Detail
-
configurationClass
Class<? extends CrestMetricsEndpointCfg> configurationClass()
Gets the configuration class associated with this Common REST Metrics HTTP Endpoint.- Specified by:
configurationClass
in interfaceConfiguration
- Specified by:
configurationClass
in interfaceHttpEndpointCfg
- Returns:
- Returns the configuration class associated with this Common REST Metrics HTTP Endpoint.
-
addCrestMetricsEndpointChangeListener
void addCrestMetricsEndpointChangeListener(ConfigurationChangeListener<CrestMetricsEndpointCfg> listener)
Register to be notified when this Common REST Metrics HTTP Endpoint is changed.- Parameters:
listener
- The Common REST Metrics HTTP Endpoint configuration change listener.
-
removeCrestMetricsEndpointChangeListener
void removeCrestMetricsEndpointChangeListener(ConfigurationChangeListener<CrestMetricsEndpointCfg> listener)
Deregister an existing Common REST Metrics HTTP Endpoint configuration change listener.- Parameters:
listener
- The Common REST Metrics HTTP Endpoint configuration change listener.
-
getExcludedMetricPattern
SortedSet<String> getExcludedMetricPattern()
Gets the "excluded-metric-pattern" property.Zero or more regular expressions identifying metrics that should not be published. The metric name prefix must not be included in the filter. Exclusion patterns take precedence over inclusion patterns.
Default value is undefined
- Returns:
- Returns an unmodifiable set containing the values of the "excluded-metric-pattern" property.
-
getIncludedMetricPattern
SortedSet<String> getIncludedMetricPattern()
Gets the "included-metric-pattern" property.Zero or more regular expressions identifying metrics that should be published. The metric name prefix must not be included in the filter. Exclusion patterns take precedence over inclusion patterns.
Default value is undefined
- Returns:
- Returns an unmodifiable set containing the values of the "included-metric-pattern" property.
-
getJavaClass
String getJavaClass()
Gets the "java-class" property.Specifies the fully-qualified name of the Java class that provides the Common REST Metrics HTTP Endpoint implementation.
Default value:
org.opends.server.protocols.http.CrestMetricsEndpoint
- Specified by:
getJavaClass
in interfaceHttpEndpointCfg
- Returns:
- Returns the value of the "java-class" property.
-
-