Class OpeningHandshakeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.neovisionaries.ws.client.WebSocketException

com.neovisionaries.ws.client.OpeningHandshakeException

All Implemented Interfaces:

Serializable

public class OpeningHandshakeException
extends WebSocketException

An exception raised due to a violation against the WebSocket protocol.

Since:

1.19

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private final byte[]	mBody
private final Map<String, List<String>>	mHeaders
private final StatusLine	mStatusLine
private static final long	serialVersionUID

Constructor Summary

Constructors

Constructor	Description
OpeningHandshakeException(WebSocketError error, String message, StatusLine statusLine, Map<String, List<String>> headers)
OpeningHandshakeException(WebSocketError error, String message, StatusLine statusLine, Map<String, List<String>> headers, byte[] body)

Method Summary

Modifier and Type	Method	Description
byte[]	getBody()	Get the response body contained in the WebSocket opening handshake response from the server.
Map<String, List<String>>	getHeaders()	Get the HTTP headers contained in the WebSocket opening handshake response from the server.
StatusLine	getStatusLine()	Get the status line contained in the WebSocket opening handshake response from the server.

Methods inherited from class WebSocketException

getError

Methods inherited from class Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class Object

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

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

mStatusLine

private final StatusLine mStatusLine

mHeaders

private final Map<String, List<String>> mHeaders

mBody

private final byte[] mBody

Constructor Details

OpeningHandshakeException

OpeningHandshakeException(WebSocketError error,
 String message,
 StatusLine statusLine,
 Map<String, List<String>> headers)

OpeningHandshakeException

OpeningHandshakeException(WebSocketError error,
 String message,
 StatusLine statusLine,
 Map<String, List<String>> headers,
 byte[] body)

Method Details

getStatusLine

public StatusLine getStatusLine()

Get the status line contained in the WebSocket opening handshake response from the server.

Returns:

The status line.

getHeaders

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

Get the HTTP headers contained in the WebSocket opening handshake response from the server.

Returns:

The HTTP headers. The returned map is an instance of TreeMap with String.CASE_INSENSITIVE_ORDER comparator.

getBody

public byte[] getBody()

Get the response body contained in the WebSocket opening handshake response from the server.

This method returns a non-null value only when (1) the status code is not 101 (Switching Protocols), (2) the response from the server has a response body, (3) the response has "Content-Length" header, and (4) no error occurred during reading the response body. In other cases, this method returns null.

Returns:

The response body.