类 ServletHttpHandlerAdapter
- java.lang.Object
- org.springframework.http.server.reactive.ServletHttpHandlerAdapter
- 所有已实现的接口:
Servlet
public class ServletHttpHandlerAdapter extends Object implements Servlet
AdaptHttpHandlerto anHttpServletusing Servlet Async support and Servlet 3.1 non-blocking I/O.- 从以下版本开始:
- 5.0
- 作者:
- Arjen Poutsma, Rossen Stoyanchev
- 另请参阅:
AbstractReactiveWebInitializer
构造器概要
构造器 构造器 说明 ServletHttpHandlerAdapter(HttpHandler httpHandler)
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 protected org.springframework.http.server.reactive.ServletServerHttpRequestcreateRequest(HttpServletRequest request, AsyncContext context)protected org.springframework.http.server.reactive.ServletServerHttpResponsecreateResponse(HttpServletResponse response, AsyncContext context, org.springframework.http.server.reactive.ServletServerHttpRequest request)voiddestroy()Called by the servlet container to indicate to a servlet that the servlet is being taken out of service.intgetBufferSize()Return the configured input buffer size.DataBufferFactorygetDataBufferFactory()ServletConfiggetServletConfig()Returns aServletConfigobject, which contains initialization and startup parameters for this servlet.StringgetServletInfo()Returns information about the servlet, such as author, version, and copyright.StringgetServletPath()Return the Servlet path under which the Servlet is deployed by checking the Servlet registration frominit(ServletConfig).voidinit(ServletConfig config)Called by the servlet container to indicate to a servlet that the servlet is being placed into service.voidservice(ServletRequest request, ServletResponse response)Called by the servlet container to allow the servlet to respond to a request.voidsetBufferSize(int bufferSize)Set the size of the input buffer used for reading in bytes.voidsetDataBufferFactory(DataBufferFactory dataBufferFactory)
构造器详细资料
ServletHttpHandlerAdapter
public ServletHttpHandlerAdapter(HttpHandler httpHandler)
方法详细资料
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 String getServletPath()
Return the Servlet path under which the Servlet is deployed by checking the Servlet registration frominit(ServletConfig).- 返回:
- the path, or an empty string if the Servlet is deployed without a prefix (i.e. "/" or "/*"), or
nullif this method is invoked before theinit(ServletConfig)Servlet container callback.
setDataBufferFactory
public void setDataBufferFactory(DataBufferFactory dataBufferFactory)
getDataBufferFactory
public DataBufferFactory getDataBufferFactory()
init
public void init(ServletConfig config)
从接口复制的说明:javax.servlet.ServletCalled by the servlet container to indicate to a servlet that the servlet is being placed into service.The servlet container calls the
initmethod exactly once after instantiating the servlet. Theinitmethod must complete successfully before the servlet can receive any requests.The servlet container cannot place the servlet into service if the
initmethod- Throws a
ServletException - Does not return within a time period defined by the Web server
- 指定者:
init在接口中Servlet- 参数:
config- aServletConfigobject containing the servlet's configuration and initialization parameters- 另请参阅:
UnavailableException,Servlet.getServletConfig()
- Throws a
service
public void service(ServletRequest request, ServletResponse response) throws ServletException, IOException
从接口复制的说明:javax.servlet.ServletCalled 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.
- 指定者:
service在接口中Servlet- 参数:
request- theServletRequestobject that contains the client's requestresponse- theServletResponseobject that contains the servlet's response- 抛出:
ServletException- if an exception occurs that interferes with the servlet's normal operationIOException- if an input or output exception occurs
createRequest
protected org.springframework.http.server.reactive.ServletServerHttpRequest createRequest(HttpServletRequest request, AsyncContext context) throws IOException, URISyntaxException
createResponse
protected org.springframework.http.server.reactive.ServletServerHttpResponse createResponse(HttpServletResponse response, AsyncContext context, org.springframework.http.server.reactive.ServletServerHttpRequest request) throws IOException
- 抛出:
IOException
getServletInfo
public String getServletInfo()
从接口复制的说明:javax.servlet.ServletReturns 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.).
- 指定者:
getServletInfo在接口中Servlet- 返回:
- a
Stringcontaining servlet information
getServletConfig
@Nullable public ServletConfig getServletConfig()
从接口复制的说明:javax.servlet.ServletReturns aServletConfigobject, which contains initialization and startup parameters for this servlet. TheServletConfigobject returned is the one passed to theinitmethod.Implementations of this interface are responsible for storing the
ServletConfigobject so that this method can return it. TheGenericServletclass, which implements this interface, already does this.- 指定者:
getServletConfig在接口中Servlet- 返回:
- the
ServletConfigobject that initializes this servlet - 另请参阅:
Servlet.init(javax.servlet.ServletConfig)
destroy
public void destroy()
从接口复制的说明:javax.servlet.ServletCalled 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'sservicemethod have exited or after a timeout period has passed. After the servlet container calls this method, it will not call theservicemethod 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.