接口的使用
org.springframework.http.server.ServerHttpRequest
使用ServerHttpRequest的程序包 程序包 说明 org.springframework.http.server Contains an abstraction over server-side HTTP.org.springframework.web.cors Support for CORS (Cross-Origin Resource Sharing), based on a commonCorsProcessorstrategy.org.springframework.web.multipart.support Support classes for the multipart resolution framework.org.springframework.web.servlet.mvc.method.annotation MVC infrastructure for annotation-based handler method processing, building on theorg.springframework.web.method.annotationpackage.org.springframework.web.socket.server Server-side abstractions for WebSocket interactions.org.springframework.web.socket.server.jetty Server-side support for the Jetty 9+ WebSocket API.org.springframework.web.socket.server.standard Server-side classes for use with standard JSR-356 WebSocket endpoints.org.springframework.web.socket.server.support Server-side support classes including container-specific strategies for upgrading a request.org.springframework.web.socket.sockjs Top-level SockJS types.org.springframework.web.socket.sockjs.support Support classes for SockJS including anAbstractSockJsServiceimplementation.org.springframework.web.socket.sockjs.transport Server-side support for SockJS transports includingTransportHandlerimplementations for processing incoming requests, theirsessioncounterparts for sending messages over the various transports, andDefaultSockJsService.org.springframework.web.socket.sockjs.transport.handler TransportHandlerimplementation classes as well as a concreteSockJsService.org.springframework.web.socket.sockjs.transport.session SockJS specific implementations ofWebSocketSession.org.springframework.http.server中ServerHttpRequest的使用
实现ServerHttpRequest的org.springframework.http.server中的类 修饰符和类型 类 说明 classServletServerHttpRequestServerHttpRequestimplementation that is based on aHttpServletRequest.org.springframework.web.cors中ServerHttpRequest的使用
参数类型为ServerHttpRequest的org.springframework.web.cors中的方法 修饰符和类型 方法 说明 protected booleanDefaultCorsProcessor. handleInternal(ServerHttpRequest request, ServerHttpResponse response, CorsConfiguration config, boolean preFlightRequest)Handle the given request.org.springframework.web.multipart.support中ServerHttpRequest的使用
实现ServerHttpRequest的org.springframework.web.multipart.support中的类 修饰符和类型 类 说明 classRequestPartServletServerHttpRequestServerHttpRequestimplementation that accesses one part of a multipart request.org.springframework.web.servlet.mvc.method.annotation中ServerHttpRequest的使用
参数类型为ServerHttpRequest的org.springframework.web.servlet.mvc.method.annotation中的方法 修饰符和类型 方法 说明 ObjectAbstractMappingJacksonResponseBodyAdvice. beforeBodyWrite(Object body, MethodParameter returnType, MediaType contentType, Class<? extends HttpMessageConverter<?>> converterType, ServerHttpRequest request, ServerHttpResponse response)TResponseBodyAdvice. beforeBodyWrite(T body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response)Invoked after anHttpMessageConverteris selected and just before its write method is invoked.protected abstract voidAbstractMappingJacksonResponseBodyAdvice. beforeBodyWriteInternal(MappingJacksonValue bodyContainer, MediaType contentType, MethodParameter returnType, ServerHttpRequest request, ServerHttpResponse response)Invoked only if the converter type isMappingJackson2HttpMessageConverter.protected voidJsonViewResponseBodyAdvice. beforeBodyWriteInternal(MappingJacksonValue bodyContainer, MediaType contentType, MethodParameter returnType, ServerHttpRequest request, ServerHttpResponse response)org.springframework.web.socket.server中ServerHttpRequest的使用
参数类型为ServerHttpRequest的org.springframework.web.socket.server中的方法 修饰符和类型 方法 说明 voidHandshakeInterceptor. afterHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Exception exception)Invoked after the handshake is done.booleanHandshakeInterceptor. beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Map<String,Object> attributes)Invoked before the handshake is processed.booleanHandshakeHandler. doHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Map<String,Object> attributes)Initiate the handshake.List<WebSocketExtension>RequestUpgradeStrategy. getSupportedExtensions(ServerHttpRequest request)Return the WebSocket protocol extensions supported by the underlying WebSocket server.voidRequestUpgradeStrategy. upgrade(ServerHttpRequest request, ServerHttpResponse response, String selectedProtocol, List<WebSocketExtension> selectedExtensions, Principal user, WebSocketHandler wsHandler, Map<String,Object> attributes)Perform runtime specific steps to complete the upgrade.org.springframework.web.socket.server.jetty中ServerHttpRequest的使用
参数类型为ServerHttpRequest的org.springframework.web.socket.server.jetty中的方法 修饰符和类型 方法 说明 List<WebSocketExtension>JettyRequestUpgradeStrategy. getSupportedExtensions(ServerHttpRequest request)voidJettyRequestUpgradeStrategy. upgrade(ServerHttpRequest request, ServerHttpResponse response, String selectedProtocol, List<WebSocketExtension> selectedExtensions, Principal user, WebSocketHandler wsHandler, Map<String,Object> attributes)org.springframework.web.socket.server.standard中ServerHttpRequest的使用
参数类型为ServerHttpRequest的org.springframework.web.socket.server.standard中的方法 修饰符和类型 方法 说明 protected HttpServletRequestAbstractStandardUpgradeStrategy. getHttpServletRequest(ServerHttpRequest request)List<WebSocketExtension>AbstractStandardUpgradeStrategy. getSupportedExtensions(ServerHttpRequest request)voidAbstractStandardUpgradeStrategy. upgrade(ServerHttpRequest request, ServerHttpResponse response, String selectedProtocol, List<WebSocketExtension> selectedExtensions, Principal user, WebSocketHandler wsHandler, Map<String,Object> attrs)protected abstract voidAbstractStandardUpgradeStrategy. upgradeInternal(ServerHttpRequest request, ServerHttpResponse response, String selectedProtocol, List<Extension> selectedExtensions, Endpoint endpoint)voidAbstractTyrusRequestUpgradeStrategy. upgradeInternal(ServerHttpRequest request, ServerHttpResponse response, String selectedProtocol, List<Extension> extensions, Endpoint endpoint)voidTomcatRequestUpgradeStrategy. upgradeInternal(ServerHttpRequest request, ServerHttpResponse response, String selectedProtocol, List<Extension> selectedExtensions, Endpoint endpoint)protected voidUndertowRequestUpgradeStrategy. upgradeInternal(ServerHttpRequest request, ServerHttpResponse response, String selectedProtocol, List<Extension> selectedExtensions, Endpoint endpoint)voidWebSphereRequestUpgradeStrategy. upgradeInternal(ServerHttpRequest httpRequest, ServerHttpResponse httpResponse, String selectedProtocol, List<Extension> selectedExtensions, Endpoint endpoint)org.springframework.web.socket.server.support中ServerHttpRequest的使用
参数类型为ServerHttpRequest的org.springframework.web.socket.server.support中的方法 修饰符和类型 方法 说明 voidHttpSessionHandshakeInterceptor. afterHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Exception ex)voidOriginHandshakeInterceptor. afterHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Exception exception)voidHandshakeInterceptorChain. applyAfterHandshake(ServerHttpRequest request, ServerHttpResponse response, Exception failure)booleanHandshakeInterceptorChain. applyBeforeHandshake(ServerHttpRequest request, ServerHttpResponse response, Map<String,Object> attributes)booleanHttpSessionHandshakeInterceptor. beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Map<String,Object> attributes)booleanOriginHandshakeInterceptor. beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Map<String,Object> attributes)protected PrincipalAbstractHandshakeHandler. determineUser(ServerHttpRequest request, WebSocketHandler wsHandler, Map<String,Object> attributes)A method that can be used to associate a user with the WebSocket session in the process of being established.booleanAbstractHandshakeHandler. doHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Map<String,Object> attributes)protected List<WebSocketExtension>AbstractHandshakeHandler. filterRequestedExtensions(ServerHttpRequest request, List<WebSocketExtension> requestedExtensions, List<WebSocketExtension> supportedExtensions)Filter the list of requested WebSocket extensions.protected voidAbstractHandshakeHandler. handleInvalidConnectHeader(ServerHttpRequest request, ServerHttpResponse response)protected voidAbstractHandshakeHandler. handleInvalidUpgradeHeader(ServerHttpRequest request, ServerHttpResponse response)protected voidAbstractHandshakeHandler. handleWebSocketVersionNotSupported(ServerHttpRequest request, ServerHttpResponse response)protected booleanAbstractHandshakeHandler. isValidOrigin(ServerHttpRequest request)Return whether the requestOriginheader value is valid or not.org.springframework.web.socket.sockjs中ServerHttpRequest的使用
参数类型为ServerHttpRequest的org.springframework.web.socket.sockjs中的方法 修饰符和类型 方法 说明 voidSockJsService. handleRequest(ServerHttpRequest request, ServerHttpResponse response, String sockJsPath, WebSocketHandler handler)Process a SockJS HTTP request.org.springframework.web.socket.sockjs.support中ServerHttpRequest的使用
参数类型为ServerHttpRequest的org.springframework.web.socket.sockjs.support中的方法 修饰符和类型 方法 说明 protected booleanAbstractSockJsService. checkOrigin(ServerHttpRequest request, ServerHttpResponse response, HttpMethod... httpMethods)protected abstract voidAbstractSockJsService. handleRawWebSocketRequest(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler webSocketHandler)Handle request for raw WebSocket communication, i.e. without any SockJS message framing.voidAbstractSockJsService. handleRequest(ServerHttpRequest request, ServerHttpResponse response, String sockJsPath, WebSocketHandler wsHandler)This method determines the SockJS path and handles SockJS static URLs.protected abstract voidAbstractSockJsService. handleTransportRequest(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler webSocketHandler, String sessionId, String transport)Handle a SockJS session URL (i.e. transport-specific request).org.springframework.web.socket.sockjs.transport中ServerHttpRequest的使用
参数类型为ServerHttpRequest的org.springframework.web.socket.sockjs.transport中的方法 修饰符和类型 方法 说明 protected voidTransportHandlingSockJsService. handleRawWebSocketRequest(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler handler)voidTransportHandler. handleRequest(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler handler, SockJsSession session)Handle the given request and delegate messages to the providedWebSocketHandler.protected voidTransportHandlingSockJsService. handleTransportRequest(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler handler, String sessionId, String transport)org.springframework.web.socket.sockjs.transport.handler中ServerHttpRequest的使用
参数类型为ServerHttpRequest的org.springframework.web.socket.sockjs.transport.handler中的方法 修饰符和类型 方法 说明 booleanWebSocketTransportHandler. doHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler handler, Map<String,Object> attributes)protected StringAbstractHttpSendingTransportHandler. getCallbackParam(ServerHttpRequest request)protected abstract SockJsFrameFormatAbstractHttpSendingTransportHandler. getFrameFormat(ServerHttpRequest request)protected SockJsFrameFormatEventSourceTransportHandler. getFrameFormat(ServerHttpRequest request)protected SockJsFrameFormatHtmlFileTransportHandler. getFrameFormat(ServerHttpRequest request)protected SockJsFrameFormatXhrPollingTransportHandler. getFrameFormat(ServerHttpRequest request)protected SockJsFrameFormatXhrStreamingTransportHandler. getFrameFormat(ServerHttpRequest request)voidAbstractHttpReceivingTransportHandler. handleRequest(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, SockJsSession wsSession)voidAbstractHttpSendingTransportHandler. handleRequest(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, SockJsSession wsSession)voidWebSocketTransportHandler. handleRequest(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, SockJsSession wsSession)protected voidAbstractHttpReceivingTransportHandler. handleRequestInternal(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, AbstractHttpSockJsSession sockJsSession)protected voidAbstractHttpSendingTransportHandler. handleRequestInternal(ServerHttpRequest request, ServerHttpResponse response, AbstractHttpSockJsSession sockJsSession)voidHtmlFileTransportHandler. handleRequestInternal(ServerHttpRequest request, ServerHttpResponse response, AbstractHttpSockJsSession sockJsSession)protected abstract String[]AbstractHttpReceivingTransportHandler. readMessages(ServerHttpRequest request)protected String[]XhrReceivingTransportHandler. readMessages(ServerHttpRequest request)org.springframework.web.socket.sockjs.transport.session中ServerHttpRequest的使用
参数类型为ServerHttpRequest的org.springframework.web.socket.sockjs.transport.session中的方法 修饰符和类型 方法 说明 protected abstract byte[]StreamingSockJsSession. getPrelude(ServerHttpRequest request)Get the prelude to write to the response before any other data.voidAbstractHttpSockJsSession. handleInitialRequest(ServerHttpRequest request, ServerHttpResponse response, SockJsFrameFormat frameFormat)Handle the first request for receiving messages on a SockJS HTTP transport based session.protected abstract voidAbstractHttpSockJsSession. handleRequestInternal(ServerHttpRequest request, ServerHttpResponse response, boolean initialRequest)Invoked when a SockJS transport request is received.protected voidPollingSockJsSession. handleRequestInternal(ServerHttpRequest request, ServerHttpResponse response, boolean initialRequest)protected voidStreamingSockJsSession. handleRequestInternal(ServerHttpRequest request, ServerHttpResponse response, boolean initialRequest)voidAbstractHttpSockJsSession. handleSuccessiveRequest(ServerHttpRequest request, ServerHttpResponse response, SockJsFrameFormat frameFormat)Handle all requests, except the first one, to receive messages on a SockJS HTTP transport based session.