Package org.forgerock.http
Interface HttpApplication
-
- All Known Subinterfaces:
DescribedHttpApplication
- All Known Implementing Classes:
AdminHttpApplication
,GatewayHttpApplication
public interface HttpApplication
Configuration class to configure theHttpApplication
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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Factory<Buffer>
getBufferFactory()
Handler
start()
Gets the rootHandler
that will handle all HTTP requests.void
stop()
Called when HTTP application is shutdown.
-
-
-
Method Detail
-
start
Handler start() throws HttpApplicationException
Gets the rootHandler
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 applicationHandler
.
-
getBufferFactory
Factory<Buffer> getBufferFactory()
Gets theFactory
that will create temporary storageBuffer
s to handle the processing of requests.May return
null
indicating that the container should provide a default buffer factory.- Returns:
- A
Buffer
Factory
ornull
.
-
stop
void stop()
Called when HTTP application is shutdown.Implementation should use this method to clear up all remaining resources.
-
-