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 Detail

      • 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 interface HttpEndpointCfg
        Returns:
        Returns the value of the "java-class" property.