org.yamcs.web.websocket

Class WebSocketProcessorClient

java.lang.Object

org.yamcs.web.websocket.WebSocketProcessorClient

All Implemented Interfaces:

ProcessorClient

public class WebSocketProcessorClient
extends Object
implements ProcessorClient

Runs on the server side and oversees the life cycle of a client web socket connection to a Processor. Combines multiple types of subscriptions to keep them bundled as one client session.

Constructor Summary

Constructors

Constructor and Description
WebSocketProcessorClient(String yamcsInstance, WebSocketFrameHandler wsHandler, String applicationName, AuthenticationToken authToken)

Method Summary

Modifier and Type	Method and Description
String	getApplicationName()
AuthenticationToken	getAuthToken()
int	getClientId()
YProcessor	getProcessor()
String	getUsername()
WebSocketFrameHandler	getWebSocketFrameHandler()
void	quit() Called when the socket is closed.
void	registerResource(String route, AbstractWebSocketResource resource)
void	switchProcessor(YProcessor newProcessor, AuthenticationToken authToken) change the connection to another processor
void	yProcessorQuit() called when the processor is closing down

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketProcessorClient

public WebSocketProcessorClient(String yamcsInstance,
                                WebSocketFrameHandler wsHandler,
                                String applicationName,
                                AuthenticationToken authToken)

Method Detail

switchProcessor

public void switchProcessor(YProcessor newProcessor,
                            AuthenticationToken authToken)
                     throws ProcessorException

Description copied from interface: ProcessorClient

change the connection to another processor

Specified by:

switchProcessor in interface ProcessorClient

Parameters:

newProcessor - - processor

Throws:

ProcessorException

getProcessor

public YProcessor getProcessor()

registerResource

public void registerResource(String route,
                             AbstractWebSocketResource resource)

getClientId

public int getClientId()

getAuthToken

public AuthenticationToken getAuthToken()

getWebSocketFrameHandler

public WebSocketFrameHandler getWebSocketFrameHandler()

yProcessorQuit

public void yProcessorQuit()

Description copied from interface: ProcessorClient

called when the processor is closing down

Specified by:

yProcessorQuit in interface ProcessorClient

getUsername

public String getUsername()

Specified by:

getUsername in interface ProcessorClient

getApplicationName

public String getApplicationName()

Specified by:

getApplicationName in interface ProcessorClient

quit

public void quit()

Called when the socket is closed.