Package org.eclipse.jetty.websocket.api

Interface UpgradeResponse

All Known Subinterfaces:

JettyServerUpgradeResponse

All Known Implementing Classes:

DelegatedJettyClientUpgradeResponse, DelegatedServerUpgradeResponse

public interface UpgradeResponse

The HTTP Upgrade to WebSocket Response

Method Summary

Modifier and Type	Method	Description
String	getAcceptedSubProtocol()	Get the accepted WebSocket protocol.
List<ExtensionConfig>	getExtensions()	Get the list of extensions that should be used for the websocket.
String	getHeader(String name)	Get a header value
Set<String>	getHeaderNames()	Get the header names
Map<String,List<String>>	getHeaders()	Get the headers map
List<String>	getHeaders(String name)	Get the multi-value header value
int	getStatusCode()	Get the HTTP Response Status Code

Method Details

getAcceptedSubProtocol

String getAcceptedSubProtocol()

Get the accepted WebSocket protocol.

Returns:

the accepted WebSocket protocol.

getExtensions

List<ExtensionConfig> getExtensions()

Get the list of extensions that should be used for the websocket.

Returns:

the list of negotiated extensions to use.

getHeader

String getHeader(String name)

Get a header value

Parameters:

name - the header name

Returns:

the value (null if header doesn't exist)

getHeaderNames

Set<String> getHeaderNames()

Get the header names

Returns:

the set of header names

getHeaders

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

Get the headers map

Returns:

the map of headers

getHeaders

List<String> getHeaders(String name)

Get the multi-value header value

Parameters:

name - the header name

Returns:

the list of values (null if header doesn't exist)

getStatusCode

int getStatusCode()

Get the HTTP Response Status Code

Returns:

the status code