org.mule.runtime.http.api.server.ws

Interface WebSocketRequest

All Superinterfaces:

MessageWithHeaders

@NoImplement
public interface WebSocketRequest
extends MessageWithHeaders

Represents an HTTP request with an upgrade header to initiate a WebSocket

Since:

4.2.0

Method Summary

Modifier and Type	Method and Description
ClientConnection	getClientConnection()
org.mule.runtime.api.metadata.MediaType	getContentType()
String	getHttpVersion()
String	getMethod()
String	getPath()
org.mule.runtime.api.util.MultiMap<String,String>	getQueryParams()
URI	getRequestUri()
WebSocketProtocol	getScheme()
ServerConnection	getServerConnection()

Methods inherited from interface org.mule.runtime.http.api.domain.message.MessageWithHeaders

containsHeader, getHeaderNames, getHeaders, getHeaderValue, getHeaderValueIgnoreCase, getHeaderValues, getHeaderValuesIgnoreCase

Method Detail

getPath

String getPath()

Returns:

The request path

getContentType

org.mule.runtime.api.metadata.MediaType getContentType()

Returns:

The request MediaType

getQueryParams

org.mule.runtime.api.util.MultiMap<String,String> getQueryParams()

Returns:

The query params

getScheme

WebSocketProtocol getScheme()

Returns:

The scheme

getHttpVersion

String getHttpVersion()

Returns:

The protocol version of the HTTP request

getMethod

String getMethod()

Returns:

The HTTP request method

getRequestUri

URI getRequestUri()

Returns:

The request URI

getServerConnection

ServerConnection getServerConnection()

Returns:

the server connection descriptor

getClientConnection

ClientConnection getClientConnection()

Returns:

the client connection descriptor