Class WebSocketHandshakeException
- All Implemented Interfaces:
Serializable
public final class WebSocketHandshakeException extends IOException
- Since:
- 11
- See Also:
Constructor Summary
Constructor | Description |
---|---|
WebSocketHandshakeException |
Constructs a WebSocketHandshakeException with the given HttpResponse . |
Method Summary
Modifier and Type | Method | Description |
---|---|---|
HttpResponse<?> |
getResponse() |
Returns the server's counterpart of the opening handshake. |
WebSocketHandshakeException |
initCause |
Initializes the cause of this throwable to the specified value. |
Methods declared in class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
Constructor Details
WebSocketHandshakeException
public WebSocketHandshakeException(HttpResponse<?> response)
WebSocketHandshakeException
with the given HttpResponse
.- Parameters:
-
response
- theHttpResponse
that resulted in the handshake failure
Method Details
getResponse
public HttpResponse<?> getResponse()
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:
- server response
initCause
public WebSocketHandshakeException initCause(Throwable cause)
Throwable
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 }
- Overrides:
-
initCause
in classThrowable
- Parameters:
-
cause
- the cause (which is saved for later retrieval by theThrowable.getCause()
method). (Anull
value is permitted, and indicates that the cause is nonexistent or unknown.) - Returns:
- a reference to this
Throwable
instance.
© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.net.http/java/net/http/WebSocketHandshakeException.html