org.glassfish.tyrus.websockets

Interface WebSocketRequest

public interface WebSocketRequest

Request representation.

Author:

Pavel Bucek (pavel.bucek at oracle.com)

Method Summary

Methods

Modifier and Type	Method and Description
Connection	getConnection() Get Connection.
String	getFirstHeaderValue(String name) Get the first header value from the List of header values corresponding to the name.
String	getHeader(String name) Return the header values corresponding to the name.
Map<String,List<String>>	getHeaders() Get request headers.
Map<String,List<String>>	getParameterMap() Return the request parameters associated with the request.
String	getQueryString() Get query string.
String	getRequestPath() Get request path.
URI	getRequestURI() Get request URI.
boolean	isSecure() Get information about connection secure state.
void	putSingleHeader(String headerName, String headerValue) Put single header value into headers map.
void	setRequestPath(String requestPath) Set request path.

Method Detail

getHeaders

Map<String,List<String>> getHeaders()

Get request headers.

Returns:

request headers. List items represent headers from HTTP request.

getHeader

String getHeader(String name)

Return the header values corresponding to the name.

Parameters:

name - header name.

Returns:

List of header values iff found, null otherwise.

getFirstHeaderValue

String getFirstHeaderValue(String name)

Get the first header value from the List of header values corresponding to the name.

Parameters:

name - header name.

Returns:

String value iff it exists, null otherwise.

putSingleHeader

void putSingleHeader(String headerName,
                   String headerValue)

Put single header value into headers map.

Parameters:

headerName - header name.

headerValue - header value.

getRequestPath

String getRequestPath()

Get request path.

Returns:

request path.

setRequestPath

void setRequestPath(String requestPath)

Set request path.

Parameters:

requestPath - request path to be set.

getRequestURI

URI getRequestURI()

Get request URI.

Returns:

request URI.

getQueryString

String getQueryString()

Get query string.

Returns:

unparsed query string.

getConnection

Connection getConnection()

Get Connection.

Returns:

underlying connection.

isSecure

boolean isSecure()

Get information about connection secure state.

Returns:

true if connection is secure, false otherwise.

getParameterMap

Map<String,List<String>> getParameterMap()

Return the request parameters associated with the request.

Returns:

the unmodifiable map of the request parameters.