Package org.forgerock.http

Interface HttpApplication

All Known Subinterfaces:

AdminHttpApplication, DescribedHttpApplication

All Known Implementing Classes:

BaseAdminHttpApplication, GatewayHttpApplication

public interface HttpApplication

Configuration class to configure the HttpApplication instance.

If the application should expose OpenAPI API Descriptors, the DescribedHttpApplication interface should be used instead of this one.

The implementation of this class will be loaded using the ServiceLoader framework.

Method Summary

Modifier and Type	Method	Description
Factory<Buffer>	getBufferFactory()	Gets the Factory that will create temporary storage Buffers to handle the processing of requests.
Handler	start()	Gets the root Handler that will handle all HTTP requests.
void	stop()	Called when HTTP application is shutdown.

Method Details

start

Handler start()
       throws HttpApplicationException

Gets the root Handler that will handle all HTTP requests.

The Handler returned from this method MUST be a singleton.

Returns:

The Handler to handle HTTP requests.

Throws:

HttpApplicationException - If there is a problem constructing the root application Handler.

getBufferFactory

Factory<Buffer> getBufferFactory()

Gets the Factory that will create temporary storage Buffers to handle the processing of requests.

May return null indicating that the container should provide a default buffer factory.

Returns:

A Buffer Factory or null.

stop

void stop()

Called when HTTP application is shutdown.

Implementation should use this method to clear up all remaining resources.