io.micronaut.servlet.http

Class ServletHttpHandler<Req,Res>

java.lang.Object

io.micronaut.servlet.http.ServletHttpHandler<Req,Res>

Type Parameters:

Req - The request object

Res - The response object

All Implemented Interfaces:

io.micronaut.context.LifeCycle<ServletHttpHandler<Req,Res>>, java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

DefaultServletHttpHandler

public abstract class ServletHttpHandler<Req,Res>
extends java.lang.Object
implements java.lang.AutoCloseable, io.micronaut.context.LifeCycle<ServletHttpHandler<Req,Res>>

An HTTP handler that can deal with Serverless requests.

Since:

1.2.0

Author:

graemerocher

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	LOG Logger to be used by subclasses for logging.

Constructor Summary

Constructors

Constructor and Description
ServletHttpHandler(io.micronaut.context.ApplicationContext applicationContext) Default constructor.

Method Summary

Modifier and Type	Method and Description
void	close()
protected abstract ServletExchange<Req,Res>	createExchange(Req request, Res response) Creates the DefaultServletExchange object.
ServletExchange<Req,Res>	exchange(Req request, Res response) Handle the give native request and response and return the ServletExchange object.
ServletExchange<Req,Res>	exchange(ServletExchange<Req,Res> exchange) Handle the give native request and response and return the ServletExchange object.
io.micronaut.context.ApplicationContext	getApplicationContext()
io.micronaut.http.codec.MediaTypeCodecRegistry	getMediaTypeCodecRegistry()
boolean	isRunning()
void	service(Req request, Res response) Handle the give native request and response.
void	service(ServletExchange<Req,Res> exchange) Handles a DefaultServletExchange.
ServletHttpHandler<Req,Res>	start()
ServletHttpHandler<Req,Res>	stop()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.context.LifeCycle

refresh

Field Detail

LOG

protected static final org.slf4j.Logger LOG

Logger to be used by subclasses for logging.

Constructor Detail

ServletHttpHandler

public ServletHttpHandler(io.micronaut.context.ApplicationContext applicationContext)

Default constructor.

Parameters:

applicationContext - The application context

Method Detail

getApplicationContext

public io.micronaut.context.ApplicationContext getApplicationContext()

Returns:

The application context for the function.

getMediaTypeCodecRegistry

public io.micronaut.http.codec.MediaTypeCodecRegistry getMediaTypeCodecRegistry()

Returns:

The media type codec registry.

service

public void service(Req request,
                    Res response)

Handle the give native request and response.

Parameters:

request - The request

response - The response

exchange

public ServletExchange<Req,Res> exchange(Req request,
                                         Res response)

Handle the give native request and response and return the ServletExchange object.

Parameters:

request - The request

response - The response

Returns:

The ServletExchange object

exchange

public ServletExchange<Req,Res> exchange(ServletExchange<Req,Res> exchange)

Handle the give native request and response and return the ServletExchange object.

Parameters:

exchange - The exchange

Returns:

The ServletExchange object

isRunning

public boolean isRunning()

Specified by:

isRunning in interface io.micronaut.context.LifeCycle<ServletHttpHandler<Req,Res>>

service

public void service(ServletExchange<Req,Res> exchange)

Handles a DefaultServletExchange.

Parameters:

exchange - The exchange

close

public void close()

Specified by:

close in interface io.micronaut.context.LifeCycle<ServletHttpHandler<Req,Res>>

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

start

@NonNull
public ServletHttpHandler<Req,Res> start()

Specified by:

start in interface io.micronaut.context.LifeCycle<ServletHttpHandler<Req,Res>>

stop

@NonNull
public ServletHttpHandler<Req,Res> stop()

Specified by:

stop in interface io.micronaut.context.LifeCycle<ServletHttpHandler<Req,Res>>

createExchange

protected abstract ServletExchange<Req,Res> createExchange(Req request,
                                                           Res response)

Creates the DefaultServletExchange object.

Parameters:

request - The request

response - The response

Returns:

The exchange object