org.springframework.http.server.reactive

Class ServletHttpHandlerAdapter

java.lang.Object

org.springframework.http.server.reactive.ServletHttpHandlerAdapter

All Implemented Interfaces:

Servlet

Direct Known Subclasses:

JettyHttpHandlerAdapter, TomcatHttpHandlerAdapter

public class ServletHttpHandlerAdapter
extends java.lang.Object
implements Servlet

Adapt HttpHandler to an HttpServlet using Servlet Async support and Servlet 3.1 non-blocking I/O.

Since:

5.0

Author:

Arjen Poutsma, Rossen Stoyanchev

See Also:

AbstractReactiveWebInitializer

Constructor Summary

Constructors

Constructor and Description
ServletHttpHandlerAdapter(HttpHandler httpHandler)

Method Summary

Modifier and Type	Method and Description
protected org.springframework.http.server.reactive.ServletServerHttpRequest	createRequest(HttpServletRequest request, AsyncContext context)
protected org.springframework.http.server.reactive.ServletServerHttpResponse	createResponse(HttpServletResponse response, AsyncContext context, org.springframework.http.server.reactive.ServletServerHttpRequest request)
void	destroy() Called by the servlet container to indicate to a servlet that the servlet is being taken out of service.
int	getBufferSize() Return the configured input buffer size.
DataBufferFactory	getDataBufferFactory()
ServletConfig	getServletConfig() Returns a ServletConfig object, which contains initialization and startup parameters for this servlet.
java.lang.String	getServletInfo() Returns information about the servlet, such as author, version, and copyright.
java.lang.String	getServletPath() Return the Servlet path under which the Servlet is deployed by checking the Servlet registration from init(ServletConfig).
void	init(ServletConfig config) Called by the servlet container to indicate to a servlet that the servlet is being placed into service.
void	service(ServletRequest request, ServletResponse response) Called by the servlet container to allow the servlet to respond to a request.
void	setBufferSize(int bufferSize) Set the size of the input buffer used for reading in bytes.
void	setDataBufferFactory(DataBufferFactory dataBufferFactory)

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletHttpHandlerAdapter

public ServletHttpHandlerAdapter(HttpHandler httpHandler)

Method Detail

setBufferSize

public void setBufferSize(int bufferSize)

Set the size of the input buffer used for reading in bytes.

By default this is set to 8192.

getBufferSize

public int getBufferSize()

Return the configured input buffer size.

getServletPath

@Nullable
public java.lang.String getServletPath()

Return the Servlet path under which the Servlet is deployed by checking the Servlet registration from init(ServletConfig).

Returns:

the path, or an empty string if the Servlet is deployed without a prefix (i.e. "/" or "/*"), or null if this method is invoked before the init(ServletConfig) Servlet container callback.

setDataBufferFactory

public void setDataBufferFactory(DataBufferFactory dataBufferFactory)

getDataBufferFactory

public DataBufferFactory getDataBufferFactory()

init

public void init(ServletConfig config)

Description copied from interface: javax.servlet.Servlet

Called by the servlet container to indicate to a servlet that the servlet is being placed into service.

The servlet container calls the init method exactly once after instantiating the servlet. The init method must complete successfully before the servlet can receive any requests.

The servlet container cannot place the servlet into service if the init method

1. Throws a ServletException
2. Does not return within a time period defined by the Web server

Specified by:

init in interface Servlet

Parameters:

config - a ServletConfig object containing the servlet's configuration and initialization parameters

See Also:

UnavailableException, Servlet.getServletConfig()

service

public void service(ServletRequest request,
                    ServletResponse response)
             throws ServletException,
                    java.io.IOException

Description copied from interface: javax.servlet.Servlet

Called by the servlet container to allow the servlet to respond to a request.

This method is only called after the servlet's init() method has completed successfully.

The status code of the response always should be set for a servlet that throws or sends an error.

Servlets typically run inside multithreaded servlet containers that can handle multiple requests concurrently. Developers must be aware to synchronize access to any shared resources such as files, network connections, and as well as the servlet's class and instance variables. More information on multithreaded programming in Java is available in the Java tutorial on multi-threaded programming.

Specified by:

service in interface Servlet

Parameters:

request - the ServletRequest object that contains the client's request

response - the ServletResponse object that contains the servlet's response

Throws:

ServletException - if an exception occurs that interferes with the servlet's normal operation

java.io.IOException - if an input or output exception occurs

createRequest

protected org.springframework.http.server.reactive.ServletServerHttpRequest createRequest(HttpServletRequest request,
                                                                                          AsyncContext context)
                                                                                   throws java.io.IOException,
                                                                                          java.net.URISyntaxException

Throws:

java.io.IOException

java.net.URISyntaxException

createResponse

protected org.springframework.http.server.reactive.ServletServerHttpResponse createResponse(HttpServletResponse response,
                                                                                            AsyncContext context,
                                                                                            org.springframework.http.server.reactive.ServletServerHttpRequest request)
                                                                                     throws java.io.IOException

Throws:

java.io.IOException

getServletInfo

public java.lang.String getServletInfo()

Description copied from interface: javax.servlet.Servlet

Returns information about the servlet, such as author, version, and copyright.

The string that this method returns should be plain text and not markup of any kind (such as HTML, XML, etc.).

Specified by:

getServletInfo in interface Servlet

Returns:

a String containing servlet information

getServletConfig

@Nullable
public ServletConfig getServletConfig()

Description copied from interface: javax.servlet.Servlet

Returns a ServletConfig object, which contains initialization and startup parameters for this servlet. The ServletConfig object returned is the one passed to the init method.

Implementations of this interface are responsible for storing the ServletConfig object so that this method can return it. The GenericServlet class, which implements this interface, already does this.

Specified by:

getServletConfig in interface Servlet

Returns:

the ServletConfig object that initializes this servlet

See Also:

Servlet.init(javax.servlet.ServletConfig)

destroy

public void destroy()

Description copied from interface: javax.servlet.Servlet

Called by the servlet container to indicate to a servlet that the servlet is being taken out of service. This method is only called once all threads within the servlet's service method have exited or after a timeout period has passed. After the servlet container calls this method, it will not call the service method again on this servlet.

This method gives the servlet an opportunity to clean up any resources that are being held (for example, memory, file handles, threads) and make sure that any persistent state is synchronized with the servlet's current state in memory.

Specified by:

destroy in interface Servlet