Package io.undertow.servlet.websockets

Class ServletWebSocketHttpExchange

java.lang.Object

io.undertow.servlet.websockets.ServletWebSocketHttpExchange

All Implemented Interfaces:

WebSocketHttpExchange, Closeable, AutoCloseable

public class ServletWebSocketHttpExchange
extends Object
implements WebSocketHttpExchange

Author:

Stuart Douglas

Constructor Summary

Constructors

Constructor	Description
ServletWebSocketHttpExchange(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, Set<WebSocketChannel> peerConnections)

Method Summary

Modifier and Type	Method	Description
void	close()
void	endExchange()
<T> T	getAttachment(AttachmentKey<T> key)
ByteBufferPool	getBufferPool()
org.xnio.OptionMap	getOptions()
Set<WebSocketChannel>	getPeerConnections()
String	getQueryString()
String	getRequestHeader(String headerName)
Map<String,List<String>>	getRequestHeaders()
Map<String,List<String>>	getRequestParameters()
String	getRequestScheme()
String	getRequestURI()
String	getResponseHeader(String headerName)
Map<String,List<String>>	getResponseHeaders()
Object	getSession()
Principal	getUserPrincipal()
boolean	isUserInRole(String role)
<T> void	putAttachment(AttachmentKey<T> key, T value)
org.xnio.IoFuture<byte[]>	readRequestData()
org.xnio.IoFuture<Void>	sendData(ByteBuffer data)
void	setResponseHeader(String headerName, String headerValue)
void	setResponseHeaders(Map<String,List<String>> headers)
void	upgradeChannel(HttpUpgradeListener upgradeCallback)

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletWebSocketHttpExchange

public ServletWebSocketHttpExchange(jakarta.servlet.http.HttpServletRequest request,
                                    jakarta.servlet.http.HttpServletResponse response,
                                    Set<WebSocketChannel> peerConnections)

Method Detail

putAttachment

public <T> void putAttachment(AttachmentKey<T> key,
                              T value)

Specified by:

putAttachment in interface WebSocketHttpExchange

getAttachment

public <T> T getAttachment(AttachmentKey<T> key)

Specified by:

getAttachment in interface WebSocketHttpExchange

getRequestHeader

public String getRequestHeader(String headerName)

Specified by:

getRequestHeader in interface WebSocketHttpExchange

getRequestHeaders

public Map<String,List<String>> getRequestHeaders()

Specified by:

getRequestHeaders in interface WebSocketHttpExchange

getResponseHeader

public String getResponseHeader(String headerName)

Specified by:

getResponseHeader in interface WebSocketHttpExchange

getResponseHeaders

public Map<String,List<String>> getResponseHeaders()

Specified by:

getResponseHeaders in interface WebSocketHttpExchange

setResponseHeaders

public void setResponseHeaders(Map<String,List<String>> headers)

Specified by:

setResponseHeaders in interface WebSocketHttpExchange

setResponseHeader

public void setResponseHeader(String headerName,
                              String headerValue)

Specified by:

setResponseHeader in interface WebSocketHttpExchange

upgradeChannel

public void upgradeChannel(HttpUpgradeListener upgradeCallback)

Specified by:

upgradeChannel in interface WebSocketHttpExchange

sendData

public org.xnio.IoFuture<Void> sendData(ByteBuffer data)

Specified by:

sendData in interface WebSocketHttpExchange

readRequestData

public org.xnio.IoFuture<byte[]> readRequestData()

Specified by:

readRequestData in interface WebSocketHttpExchange

endExchange

public void endExchange()

Specified by:

endExchange in interface WebSocketHttpExchange

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface WebSocketHttpExchange

getRequestScheme

public String getRequestScheme()

Specified by:

getRequestScheme in interface WebSocketHttpExchange

getRequestURI

public String getRequestURI()

Specified by:

getRequestURI in interface WebSocketHttpExchange

getBufferPool

public ByteBufferPool getBufferPool()

Specified by:

getBufferPool in interface WebSocketHttpExchange

getQueryString

public String getQueryString()

Specified by:

getQueryString in interface WebSocketHttpExchange

getSession

public Object getSession()

Specified by:

getSession in interface WebSocketHttpExchange

getRequestParameters

public Map<String,List<String>> getRequestParameters()

Specified by:

getRequestParameters in interface WebSocketHttpExchange

getUserPrincipal

public Principal getUserPrincipal()

Specified by:

getUserPrincipal in interface WebSocketHttpExchange

isUserInRole

public boolean isUserInRole(String role)

Specified by:

isUserInRole in interface WebSocketHttpExchange

getPeerConnections

public Set<WebSocketChannel> getPeerConnections()

Specified by:

getPeerConnections in interface WebSocketHttpExchange

getOptions

public org.xnio.OptionMap getOptions()

Specified by:

getOptions in interface WebSocketHttpExchange