Package io.undertow.websockets.spi
Class AsyncWebSocketHttpServerExchange
java.lang.Object
io.undertow.websockets.spi.AsyncWebSocketHttpServerExchange
- All Implemented Interfaces:
WebSocketHttpExchange
,Closeable
,AutoCloseable
- Direct Known Subclasses:
BlockingWebSocketHttpServerExchange
- Author:
- Stuart Douglas
-
Constructor Summary
ConstructorsConstructorDescriptionAsyncWebSocketHttpServerExchange
(HttpServerExchange exchange, Set<WebSocketChannel> peerConnections) -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Forcibly close the exchange.void
End the exchange normally.<T> T
getAttachment
(AttachmentKey<T> key) org.xnio.OptionMap
getRequestHeader
(String headerName) gets the first request header with the specified nameGet the request scheme, usually http or httpsgetResponseHeader
(String headerName) get a response headerGets the session, if anyboolean
isUserInRole
(String role) <T> void
putAttachment
(AttachmentKey<T> key, T value) org.xnio.IoFuture<byte[]>
Gets the body of the request.org.xnio.IoFuture<Void>
sendData
(ByteBuffer data) Send some datavoid
setResponseHeader
(String headerName, String headerValue) Set a response headervoid
setResponseHeaders
(Map<String, List<String>> headers) Sets the response headersvoid
upgradeChannel
(HttpUpgradeListener upgradeCallback) Upgrade the underlying channel
-
Constructor Details
-
AsyncWebSocketHttpServerExchange
public AsyncWebSocketHttpServerExchange(HttpServerExchange exchange, Set<WebSocketChannel> peerConnections)
-
-
Method Details
-
putAttachment
- Specified by:
putAttachment
in interfaceWebSocketHttpExchange
-
getAttachment
- Specified by:
getAttachment
in interfaceWebSocketHttpExchange
-
getRequestHeader
Description copied from interface:WebSocketHttpExchange
gets the first request header with the specified name- Specified by:
getRequestHeader
in interfaceWebSocketHttpExchange
- Parameters:
headerName
- The header name- Returns:
- The header value, or null
-
getRequestHeaders
- Specified by:
getRequestHeaders
in interfaceWebSocketHttpExchange
- Returns:
- An unmodifiable map of request headers
-
getResponseHeader
Description copied from interface:WebSocketHttpExchange
get a response header- Specified by:
getResponseHeader
in interfaceWebSocketHttpExchange
- Parameters:
headerName
- The header name- Returns:
- The header value, or null
-
getResponseHeaders
- Specified by:
getResponseHeaders
in interfaceWebSocketHttpExchange
- Returns:
- An unmodifiable map of response headers
-
setResponseHeaders
Description copied from interface:WebSocketHttpExchange
Sets the response headers- Specified by:
setResponseHeaders
in interfaceWebSocketHttpExchange
-
setResponseHeader
Description copied from interface:WebSocketHttpExchange
Set a response header- Specified by:
setResponseHeader
in interfaceWebSocketHttpExchange
- Parameters:
headerName
- The header nameheaderValue
- The header value
-
upgradeChannel
Description copied from interface:WebSocketHttpExchange
Upgrade the underlying channel- Specified by:
upgradeChannel
in interfaceWebSocketHttpExchange
-
sendData
Description copied from interface:WebSocketHttpExchange
Send some data- Specified by:
sendData
in interfaceWebSocketHttpExchange
- Parameters:
data
- The data
-
readRequestData
public org.xnio.IoFuture<byte[]> readRequestData()Description copied from interface:WebSocketHttpExchange
Gets the body of the request.- Specified by:
readRequestData
in interfaceWebSocketHttpExchange
-
endExchange
public void endExchange()Description copied from interface:WebSocketHttpExchange
End the exchange normally. If this is a blocking exchange this may be a noop, and the exchange will actually end when the call stack returns- Specified by:
endExchange
in interfaceWebSocketHttpExchange
-
close
public void close()Description copied from interface:WebSocketHttpExchange
Forcibly close the exchange.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Specified by:
close
in interfaceWebSocketHttpExchange
-
getRequestScheme
Description copied from interface:WebSocketHttpExchange
Get the request scheme, usually http or https- Specified by:
getRequestScheme
in interfaceWebSocketHttpExchange
- Returns:
- The request scheme
-
getRequestURI
- Specified by:
getRequestURI
in interfaceWebSocketHttpExchange
- Returns:
- The request URI, including the query string
-
getBufferPool
- Specified by:
getBufferPool
in interfaceWebSocketHttpExchange
- Returns:
- The buffer pool
-
getQueryString
- Specified by:
getQueryString
in interfaceWebSocketHttpExchange
- Returns:
- The query string
-
getSession
Description copied from interface:WebSocketHttpExchange
Gets the session, if any- Specified by:
getSession
in interfaceWebSocketHttpExchange
- Returns:
- The session object, or null
-
getRequestParameters
- Specified by:
getRequestParameters
in interfaceWebSocketHttpExchange
-
getUserPrincipal
- Specified by:
getUserPrincipal
in interfaceWebSocketHttpExchange
-
isUserInRole
- Specified by:
isUserInRole
in interfaceWebSocketHttpExchange
-
getPeerConnections
- Specified by:
getPeerConnections
in interfaceWebSocketHttpExchange
-
getOptions
public org.xnio.OptionMap getOptions()- Specified by:
getOptions
in interfaceWebSocketHttpExchange
-