HttpEndpoint (OpenDJ Directory Services Project 5.2.0-SNAPSHOT API)

java.lang.Object
- org.opends.server.api.HttpEndpoint<C>

Type Parameters:

C - Type of the configuration used by this HttpEndpoint

Direct Known Subclasses:

AdminEndpoint, Rest2LdapEndpoint
```
public abstract class HttpEndpoint<C extends HTTPEndpointCfg>
extends Object
```
Endpoint attach an HttpApplication to an URI.

Field Summary

Fields
Modifier and Type Field Description

protected C configuration
Configuration of this endpoint.

protected ServerContext serverContext
Context of this LDAP server.

Constructor Summary

Constructors
Constructor Description

HttpEndpoint(C configuration, ServerContext serverContext)
Create a new HttpEndpoint with the given configuration.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`isConfigurationValid(List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)`	Check that the configuration of this `HttpEndpoint` is valid.
`abstract org.forgerock.http.HttpApplication`	`newHttpApplication()`	Create a new HttpApplication.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - configuration
```
protected final C extends HTTPEndpointCfg configuration
```
    Configuration of this endpoint.
  - serverContext
```
protected final ServerContext serverContext
```
    Context of this LDAP server.
- Constructor Detail
  - 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 Detail
  - isConfigurationValid
```
public boolean isConfigurationValid(List<org.forgerock.i18n.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.