Package org.forgerock.http
Interface HttpApplication
-
- All Known Subinterfaces:
DescribedHttpApplication
- All Known Implementing Classes:
AdminHttpApplication,GatewayHttpApplication
public interface HttpApplicationConfiguration class to configure theHttpApplicationinstance.If the application should expose OpenAPI API Descriptors, the
DescribedHttpApplicationinterface should be used instead of this one.The implementation of this class will be loaded using the
ServiceLoaderframework.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Factory<Buffer>getBufferFactory()Handlerstart()Gets the rootHandlerthat will handle all HTTP requests.voidstop()Called when HTTP application is shutdown.
-
-
-
Method Detail
-
start
Handler start() throws HttpApplicationException
Gets the rootHandlerthat will handle all HTTP requests.The
Handlerreturned from this method MUST be a singleton.- Returns:
- The
Handlerto handle HTTP requests. - Throws:
HttpApplicationException- If there is a problem constructing the root applicationHandler.
-
getBufferFactory
Factory<Buffer> getBufferFactory()
Gets theFactorythat will create temporary storageBuffers to handle the processing of requests.May return
nullindicating that the container should provide a default buffer factory.- Returns:
- A
BufferFactoryornull.
-
stop
void stop()
Called when HTTP application is shutdown.Implementation should use this method to clear up all remaining resources.
-
-