org.yamcs.web.websocket

Class ManagementResource

java.lang.Object

org.yamcs.web.websocket.AbstractWebSocketResource

org.yamcs.web.websocket.ManagementResource

All Implemented Interfaces:

ManagementListener

public class ManagementResource
extends AbstractWebSocketResource
implements ManagementListener

Provides access to any Processor/Client info over web socket

Field Summary

Fields

Modifier and Type	Field and Description
static String	OP_getClientInfo
static String	OP_getProcessorInfo
static String	OP_subscribe
static String	RESOURCE_NAME

Fields inherited from class org.yamcs.web.websocket.AbstractWebSocketResource

client, processor, wsHandler

Constructor Summary

Constructors

Constructor and Description
ManagementResource(WebSocketProcessorClient client)

Method Summary

Modifier and Type	Method and Description
void	clientInfoChanged(YamcsManagement.ClientInfo ci)
void	clientRegistered(YamcsManagement.ClientInfo ci)
void	clientUnregistered(YamcsManagement.ClientInfo ci)
void	processorAdded(YamcsManagement.ProcessorInfo processorInfo)
void	processorClosed(YamcsManagement.ProcessorInfo processorInfo)
void	processorStateChanged(YamcsManagement.ProcessorInfo processorInfo)
WebSocketReply	processRequest(WebSocketDecodeContext ctx, WebSocketDecoder decoder) Process a request and return a reply.
void	quit() Called when the web socket is closed
void	statisticsUpdated(Processor processor, YamcsManagement.Statistics stats) Called by the ManagementService when the statistics for the given processor were updated.

Methods inherited from class org.yamcs.web.websocket.AbstractWebSocketResource

getChannel, switchProcessor

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.yamcs.management.ManagementListener

clientInfoChanged, instanceStateChanged, serviceRegistered, serviceUnregistered

Field Detail

RESOURCE_NAME

public static final String RESOURCE_NAME

See Also:

Constant Field Values

OP_getProcessorInfo

public static final String OP_getProcessorInfo

See Also:

Constant Field Values

OP_getClientInfo

public static final String OP_getClientInfo

See Also:

Constant Field Values

OP_subscribe

public static final String OP_subscribe

See Also:

Constant Field Values

Constructor Detail

ManagementResource

public ManagementResource(WebSocketProcessorClient client)

Method Detail

processRequest

public WebSocketReply processRequest(WebSocketDecodeContext ctx,
                                     WebSocketDecoder decoder)
                              throws WebSocketException

Description copied from class: AbstractWebSocketResource

Process a request and return a reply. The reply can be null if the implementor of the resource takes care itself of sending the reply - this has been added because the parameterClient wants to send some date data immediately after reply

Specified by:

processRequest in class AbstractWebSocketResource

Throws:

WebSocketException

quit

public void quit()

Description copied from class: AbstractWebSocketResource

Called when the web socket is closed

Specified by:

quit in class AbstractWebSocketResource

processorAdded

public void processorAdded(YamcsManagement.ProcessorInfo processorInfo)

Specified by:

processorAdded in interface ManagementListener

processorStateChanged

public void processorStateChanged(YamcsManagement.ProcessorInfo processorInfo)

Specified by:

processorStateChanged in interface ManagementListener

processorClosed

public void processorClosed(YamcsManagement.ProcessorInfo processorInfo)

Specified by:

processorClosed in interface ManagementListener

clientRegistered

public void clientRegistered(YamcsManagement.ClientInfo ci)

Specified by:

clientRegistered in interface ManagementListener

clientInfoChanged

public void clientInfoChanged(YamcsManagement.ClientInfo ci)

Specified by:

clientInfoChanged in interface ManagementListener

clientUnregistered

public void clientUnregistered(YamcsManagement.ClientInfo ci)

Specified by:

clientUnregistered in interface ManagementListener

statisticsUpdated

public void statisticsUpdated(Processor processor,
                              YamcsManagement.Statistics stats)

Description copied from interface: ManagementListener

Called by the ManagementService when the statistics for the given processor were updated. This usually happens at about 1Hz.

Specified by:

statisticsUpdated in interface ManagementListener