org.forgerock.http.servlet.example

Class ExampleHttpApplication

java.lang.Object

org.forgerock.http.servlet.example.ExampleHttpApplication

All Implemented Interfaces:

DescribedHttpApplication, HttpApplication

public class ExampleHttpApplication
extends Object
implements DescribedHttpApplication

Example single HttpApplication deployment which registers a Handler that returns the application name and matched portion of the request uri.

The application name is default for single HttpApplication deployments and can be set for multiple HttpApplication deployments.

Constructor Summary

Constructors

Constructor and Description
ExampleHttpApplication() Default constructor for single HttpApplication deployments.

Method Summary

Modifier and Type	Method and Description
ApiProducer<io.swagger.models.Swagger>	getApiProducer() Provides the OpenAPI descriptor producer with which to produce the API.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExampleHttpApplication

public ExampleHttpApplication()

Default constructor for single HttpApplication deployments.

Method Detail

start

public Handler start()

Description copied from interface: HttpApplication

Gets the root Handler that will handle all HTTP requests.

The Handler returned from this method MUST be a singleton.

Specified by:

start in interface HttpApplication

Returns:

The Handler to handle HTTP requests.

getBufferFactory

public Factory<Buffer> getBufferFactory()

Description copied from interface: HttpApplication

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.

Specified by:

getBufferFactory in interface HttpApplication

Returns:

A Buffer Factory or null.

stop

public void stop()

Description copied from interface: HttpApplication

Called when HTTP application is shutdown.

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

Specified by:

stop in interface HttpApplication

getApiProducer

public ApiProducer<io.swagger.models.Swagger> getApiProducer()

Description copied from interface: DescribedHttpApplication

Provides the OpenAPI descriptor producer with which to produce the API.

Specified by:

getApiProducer in interface DescribedHttpApplication

Returns:

Non-null producer.