APIdia Launch Partner
Top Description Fields Constructors Methods
java.net.http

public final Class WebSocketHandshakeException

extends IOException
Class Inheritance
Imports
java.io.IOException
Thrown when the opening handshake has failed.
Since
11

Field Summary

Modifier and TypeField and Description
private final transient HttpResponse<?>
response

private static final long
serialVersionUID

Hides java.io.IOException.serialVersionUID.

Constructor Summary

AccessConstructor and Description
public
WebSocketHandshakeException(HttpResponse<?>
the HttpResponse that resulted in the handshake failure
response)

Constructs a WebSocketHandshakeException with the given HttpResponse.

Method Summary

Modifier and TypeMethod and Description
public HttpResponse<?>

Returns:

server response
getResponse()

Returns the server's counterpart of the opening handshake.

public WebSocketHandshakeException
initCause(Throwable cause)

Overrides java.lang.Throwable.initCause.

Initializes the cause of this throwable to the specified value.

Field Detail

responseback to summary
private final transient HttpResponse<?> response
serialVersionUIDback to summary
private static final long serialVersionUID

Hides java.io.IOException.serialVersionUID.

Constructor Detail

WebSocketHandshakeExceptionback to summary
public WebSocketHandshakeException(HttpResponse<?> response)

Constructs a WebSocketHandshakeException with the given HttpResponse.

Parameters
response:HttpResponse<?>

the HttpResponse that resulted in the handshake failure

Method Detail

getResponseback to summary
public HttpResponse<?> getResponse()

Returns the server's counterpart of the opening handshake.

The value may be unavailable (null) if this exception has been serialized and then deserialized.

API Note

The primary purpose of this method is to allow programmatic examination of the reasons behind the failure of the opening handshake. Some of these reasons might allow recovery.

Returns:HttpResponse<?>

server response

initCauseback to summary
public WebSocketHandshakeException initCause(Throwable cause)

Overrides java.lang.Throwable.initCause.

Doc from java.lang.Throwable.initCause.

Initializes the cause of this throwable to the specified value. (The cause is the throwable that caused this throwable to get thrown.)

This method can be called at most once. It is generally called from within the constructor, or immediately after creating the throwable. If this throwable was created with Throwable(Throwable) or Throwable(String, Throwable), this method cannot be called even once.

An example of using this method on a legacy throwable type without other support for setting the cause is: 

try {
    lowLevelOp();
} catch (LowLevelException le) {
    throw (HighLevelException)
          new HighLevelException().initCause(le); // Legacy constructor
}
Annotations
@Override