org.mule.runtime.http.api.ws.exception

Class WebSocketRuntimeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.mule.runtime.api.exception.MuleRuntimeException

org.mule.runtime.http.api.ws.exception.WebSocketRuntimeException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

WebSocketClosedException, WebSocketConnectionException

public abstract class WebSocketRuntimeException
extends org.mule.runtime.api.exception.MuleRuntimeException

Base class for RuntimeException implementations that refer to a specific WebSocket.

Because WebSocket is not Serializable, it is not guaranteed that the referred socket will always be available, reason why the getWebSocket() method returns an Optional. It will always be possible however to recover the socket's ID.

Since:

4.2.2

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected WebSocket	webSocket
protected String	webSocketId

Constructor Summary

Constructors

Constructor and Description
WebSocketRuntimeException(String message, WebSocket webSocket) Creates a new instance
WebSocketRuntimeException(String message, WebSocket webSocket, Throwable cause)

Method Summary

Modifier and Type	Method and Description
Optional<WebSocket>	getWebSocket() Optionally returns the referred WebSocket.
String	getWebSocketId()

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Field Detail

webSocketId

protected final String webSocketId

webSocket

protected transient WebSocket webSocket

Constructor Detail

WebSocketRuntimeException

public WebSocketRuntimeException(String message,
                                 WebSocket webSocket)

Creates a new instance

Parameters:

message - the exception message

webSocket - the referred WebSocket

WebSocketRuntimeException

public WebSocketRuntimeException(String message,
                                 WebSocket webSocket,
                                 Throwable cause)

Parameters:

message - the exception message

webSocket - the referred WebSocket

cause - this exception's cause

Method Detail

getWebSocket

public final Optional<WebSocket> getWebSocket()

Optionally returns the referred WebSocket. The return value will be empty if this exception has been deserialized.

Returns:

an Optional WebSocket

getWebSocketId

public final String getWebSocketId()

Returns:

The referred socket ID.