Package org.opends.server.api

Class HttpEndpoint<C extends HttpEndpointCfg>

java.lang.Object
org.opends.server.api.HttpEndpoint<C>
Type Parameters:
C - Type of the configuration used by this HttpEndpoint
Direct Known Subclasses:
AdminEndpoint, AliveEndpoint, CrestMetricsEndpoint, HdapEndpoint, HealthyEndpoint, PrometheusEndpoint, Rest2LdapEndpoint
public abstract class HttpEndpoint<C extends HttpEndpointCfg> extends Object
Endpoint attach an HttpApplication to an URI.

  • Field Details

    • USE_DEFAULT_BUFFER_FACTORY

      protected static final Factory<org.forgerock.http.io.Buffer> USE_DEFAULT_BUFFER_FACTORY
      Use default buffer factory for creating temporary storage for handling requests.

    • configuration

      protected final C extends HttpEndpointCfg configuration
      Configuration of this endpoint.

    • serverContext

      protected final ServerContext serverContext
      Context of this LDAP server.

  • Constructor Details

    • HttpEndpoint

      public HttpEndpoint(C configuration, ServerContext serverContext)
      Create a new HttpEndpoint with the given configuration.
      Parameters:
      configuration - Configuration of this HttpEndpoint
      serverContext - Context of this LDAP server

  • Method Details

    • isConfigurationValid

      public boolean isConfigurationValid(List<LocalizableMessage> unacceptableReasons)
      Check that the configuration of this HttpEndpoint is valid. This default implementation try to instantiate and start the underlying HttpApplication.
      Parameters:
      unacceptableReasons - A list that can be used to hold messages about why the configuration is not acceptable.
      Returns:
      true if the configuration is valid.

    • newHttpApplication

      public abstract org.forgerock.http.HttpApplication newHttpApplication() throws InitializationException
      Create a new HttpApplication.
      Returns:
      an HttpApplication configured and ready to be started.
      Throws:
      InitializationException - If the application cannot be created.