org.yamcs.web.websocket

Class WebSocketException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.yamcs.web.websocket.WebSocketException

All Implemented Interfaces:

Serializable

public class WebSocketException
extends Exception

When an exception occurred while handling an incoming web socket request. Used as a one-time response to a client request.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
WebSocketException(int requestId, String message)
WebSocketException(int requestId, String message, Throwable t)
WebSocketException(int requestId, Throwable t)

Method Summary

Modifier and Type	Method and Description
void	attachData(String dataType, com.google.protobuf.Message data)
com.google.protobuf.Message	getData()
String	getDataType()
int	getRequestId()
Web.WebSocketServerMessage.WebSocketExceptionData	toWebSocketExceptionData() Converts this exception to a protobuf message

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

Constructor Detail

WebSocketException

public WebSocketException(int requestId,
                          String message)

Parameters:

requestId - the client request id, if at least this could be successfully interpreted.

WebSocketException

public WebSocketException(int requestId,
                          Throwable t)

WebSocketException

public WebSocketException(int requestId,
                          String message,
                          Throwable t)

Method Detail

getRequestId

public int getRequestId()

attachData

public void attachData(String dataType,
                       com.google.protobuf.Message data)

getDataType

public String getDataType()

getData

public com.google.protobuf.Message getData()

toWebSocketExceptionData

public Web.WebSocketServerMessage.WebSocketExceptionData toWebSocketExceptionData()
                                                                           throws IOException

Converts this exception to a protobuf message

Throws:

IOException