Package org.forgerock.opendj.server.config.meta

Class CrestMetricsEndpointCfgDefn

java.lang.Object
org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>
org.forgerock.opendj.config.ManagedObjectDefinition<CrestMetricsEndpointCfgClient,CrestMetricsEndpointCfg>
org.forgerock.opendj.server.config.meta.CrestMetricsEndpointCfgDefn
public final class CrestMetricsEndpointCfgDefn extends ManagedObjectDefinition<CrestMetricsEndpointCfgClient,CrestMetricsEndpointCfg>
An interface for querying the Common REST Metrics HTTP Endpoint managed object definition meta information.

The Common REST Metrics HTTP Endpoint provides access to OpenDJ's monitoring information via the Common REST protocol.

  • Method Details

    • getInstance

      public static CrestMetricsEndpointCfgDefn getInstance()
      Get the Common REST Metrics HTTP Endpoint configuration definition singleton.
      Returns:
      Returns the Common REST Metrics HTTP Endpoint configuration definition singleton.

    • createClientConfiguration

      public CrestMetricsEndpointCfgClient createClientConfiguration(ManagedObject<? extends CrestMetricsEndpointCfgClient> impl)
      Description copied from class: ManagedObjectDefinition
      Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.
      Specified by:
      createClientConfiguration in class ManagedObjectDefinition<CrestMetricsEndpointCfgClient,CrestMetricsEndpointCfg>
      Parameters:
      impl - The managed object.
      Returns:
      Returns a client configuration view of the provided managed object.

    • createServerConfiguration

      public CrestMetricsEndpointCfg createServerConfiguration(ServerManagedObject<? extends CrestMetricsEndpointCfg> impl)
      Description copied from class: ManagedObjectDefinition
      Creates a server configuration view of the provided server managed object.
      Specified by:
      createServerConfiguration in class ManagedObjectDefinition<CrestMetricsEndpointCfgClient,CrestMetricsEndpointCfg>
      Parameters:
      impl - The server managed object.
      Returns:
      Returns a server configuration view of the provided server managed object.

    • getServerConfigurationClass

      public Class<CrestMetricsEndpointCfg> getServerConfigurationClass()
      Description copied from class: ManagedObjectDefinition
      Gets the server configuration class instance associated with this managed object definition.
      Specified by:
      getServerConfigurationClass in class ManagedObjectDefinition<CrestMetricsEndpointCfgClient,CrestMetricsEndpointCfg>
      Returns:
      Returns the server configuration class instance associated with this managed object definition.

    • getAuthorizationMechanismPropertyDefinition

      public AggregationPropertyDefinition<HttpAuthorizationMechanismCfgClient,HttpAuthorizationMechanismCfg> getAuthorizationMechanismPropertyDefinition()
      Get the "authorization-mechanism" property definition.

      The HTTP authorization mechanisms supported by this Common REST Metrics HTTP Endpoint.

      Returns:
      Returns the "authorization-mechanism" property definition.

    • getBasePathPropertyDefinition

      public StringPropertyDefinition getBasePathPropertyDefinition()
      Get the "base-path" property definition.

      All HTTP requests matching the base path or subordinate to it will be routed to the HTTP endpoint unless a more specific HTTP endpoint is found.

      Returns:
      Returns the "base-path" property definition.

    • getEnabledPropertyDefinition

      public BooleanPropertyDefinition getEnabledPropertyDefinition()
      Get the "enabled" property definition.

      Indicates whether the Common REST Metrics HTTP Endpoint is enabled.

      Returns:
      Returns the "enabled" property definition.

    • getExcludedMetricPatternPropertyDefinition

      public StringPropertyDefinition getExcludedMetricPatternPropertyDefinition()
      Get the "excluded-metric-pattern" property definition.

      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.

      Returns:
      Returns the "excluded-metric-pattern" property definition.

    • getIncludedMetricPatternPropertyDefinition

      public StringPropertyDefinition getIncludedMetricPatternPropertyDefinition()
      Get the "included-metric-pattern" property definition.

      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.

      Returns:
      Returns the "included-metric-pattern" property definition.

    • getJavaClassPropertyDefinition

      public ClassPropertyDefinition getJavaClassPropertyDefinition()
      Get the "java-class" property definition.

      Specifies the fully-qualified name of the Java class that provides the Common REST Metrics HTTP Endpoint implementation.

      Returns:
      Returns the "java-class" property definition.