类 SockJsHttpRequestHandler
- java.lang.Object
- org.springframework.web.socket.sockjs.support.SockJsHttpRequestHandler
public class SockJsHttpRequestHandler extends Object implements HttpRequestHandler, CorsConfigurationSource, Lifecycle, ServletContextAware
AnHttpRequestHandlerthat allows mapping aSockJsServiceto requests in a Servlet container.- 从以下版本开始:
- 4.0
- 作者:
- Rossen Stoyanchev, Sebastien Deleuze
构造器概要
构造器 构造器 说明 SockJsHttpRequestHandler(SockJsService sockJsService, WebSocketHandler webSocketHandler)Create a new SockJsHttpRequestHandler.
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 CorsConfigurationgetCorsConfiguration(HttpServletRequest request)Return aCorsConfigurationbased on the incoming request.SockJsServicegetSockJsService()Return theSockJsService.WebSocketHandlergetWebSocketHandler()Return theWebSocketHandler.voidhandleRequest(HttpServletRequest servletRequest, HttpServletResponse servletResponse)Process the given request, generating a response.booleanisRunning()Check whether this component is currently running.voidsetServletContext(ServletContext servletContext)Set theServletContextthat this object runs in.voidstart()Start this component.voidstop()Stop this component, typically in a synchronous fashion, such that the component is fully stopped upon return of this method.
构造器详细资料
SockJsHttpRequestHandler
public SockJsHttpRequestHandler(SockJsService sockJsService, WebSocketHandler webSocketHandler)
Create a new SockJsHttpRequestHandler.- 参数:
sockJsService- the SockJS servicewebSocketHandler- the websocket handler
方法详细资料
getSockJsService
public SockJsService getSockJsService()
Return theSockJsService.
getWebSocketHandler
public WebSocketHandler getWebSocketHandler()
Return theWebSocketHandler.
setServletContext
public void setServletContext(ServletContext servletContext)
从接口复制的说明:ServletContextAwareSet theServletContextthat this object runs in.Invoked after population of normal bean properties but before an init callback like InitializingBean's
afterPropertiesSetor a custom init-method. Invoked after ApplicationContextAware'ssetApplicationContext.- 指定者:
setServletContext在接口中ServletContextAware- 参数:
servletContext- the ServletContext object to be used by this object- 另请参阅:
InitializingBean.afterPropertiesSet(),ApplicationContextAware.setApplicationContext(org.springframework.context.ApplicationContext)
start
public void start()
从接口复制的说明:LifecycleStart this component.Should not throw an exception if the component is already running.
In the case of a container, this will propagate the start signal to all components that apply.
- 指定者:
start在接口中Lifecycle- 另请参阅:
SmartLifecycle.isAutoStartup()
stop
public void stop()
从接口复制的说明:LifecycleStop this component, typically in a synchronous fashion, such that the component is fully stopped upon return of this method. Consider implementingSmartLifecycleand itsstop(Runnable)variant when asynchronous stop behavior is necessary.Note that this stop notification is not guaranteed to come before destruction: On regular shutdown,
Lifecyclebeans will first receive a stop notification before the general destruction callbacks are being propagated; however, on hot refresh during a context's lifetime or on aborted refresh attempts, a given bean's destroy method will be called without any consideration of stop signals upfront.Should not throw an exception if the component is not running (not started yet).
In the case of a container, this will propagate the stop signal to all components that apply.
- 指定者:
stop在接口中Lifecycle- 另请参阅:
SmartLifecycle.stop(Runnable),DisposableBean.destroy()
isRunning
public boolean isRunning()
从接口复制的说明:LifecycleCheck whether this component is currently running.In the case of a container, this will return
trueonly if all components that apply are currently running.
handleRequest
public void handleRequest(HttpServletRequest servletRequest, HttpServletResponse servletResponse) throws ServletException, IOException
从接口复制的说明:HttpRequestHandlerProcess the given request, generating a response.- 指定者:
handleRequest在接口中HttpRequestHandler- 参数:
servletRequest- current HTTP requestservletResponse- current HTTP response- 抛出:
ServletException- in case of general errorsIOException- in case of I/O errors
getCorsConfiguration
@Nullable public CorsConfiguration getCorsConfiguration(HttpServletRequest request)
从接口复制的说明:CorsConfigurationSourceReturn aCorsConfigurationbased on the incoming request.- 指定者:
getCorsConfiguration在接口中CorsConfigurationSource- 返回:
- the associated
CorsConfiguration, ornullif none