org.yamcs.management

Class ManagementService

java.lang.Object

org.yamcs.management.ManagementService

All Implemented Interfaces:

ProcessorListener

public class ManagementService
extends Object
implements ProcessorListener

Responsible for providing to interested listeners info related to creation/removal/update of:

• instances, processors and clients - see ManagementListener
• links - see LinkListener
• streams and tables - see TableStreamListener
• command queues - see CommandQueueListener

Method Summary

Modifier and Type	Method and Description
boolean	addCommandQueueListener(CommandQueueListener l)
boolean	addLinkListener(LinkListener l) Adds a listener that is to be notified when any processor, or any client is updated.
boolean	addManagementListener(ManagementListener l) Adds a listener that is to be notified when any processor, or any client is updated.
boolean	addTableStreamListener(TableStreamListener l)
void	connectToProcessor(Processor processor, int clientId)
void	connectToProcessor(YamcsManagement.ProcessorManagementRequest cr)
void	createProcessor(YamcsManagement.ProcessorManagementRequest pmr, String username)
void	disableLink(String instance, String linkName)
void	enableLink(String instance, String linkName)
Set<YamcsManagement.ClientInfo>	getClientInfo()
YamcsManagement.ClientInfo	getClientInfo(int clientId)
Set<YamcsManagement.ClientInfo>	getClientInfo(String username)
CommandQueueManager	getCommandQueueManager(Processor processor)
List<CommandQueueManager>	getCommandQueueManagers()
static ManagementService	getInstance()
List<YamcsManagement.LinkInfo>	getLinkInfo()
List<YamcsManagement.LinkInfo>	getLinkInfo(String instance)
YamcsManagement.LinkInfo	getLinkInfo(String instance, String name)
CommandQueueManager	getQueueManager(String instance, String processorName)
List<CommandQueueManager>	getQueueManagers()
void	processorAdded(Processor processor)
void	processorClosed(Processor processor)
void	processorStateChanged(Processor processor)
int	registerClient(String instance, String procName, ProcessorClient client)
void	registerCommandQueueManager(String instance, String processorName, CommandQueueManager cqm)
void	registerLink(String instance, String linkName, String streamName, String spec, Link link)
void	registerService(String instance, String serviceName, com.google.common.util.concurrent.Service service)
void	registerStream(String instance, Stream stream)
void	registerTable(String instance, TableDefinition tblDef)
void	registerYamcsInstance(YamcsServerInstance ys)
boolean	removeCommandQueueListener(CommandQueueListener l)
boolean	removeLinkListener(LinkListener l)
boolean	removeManagementListener(ManagementListener l)
boolean	removeTableStreamListener(TableStreamListener l)
CompletableFuture<Void>	restartInstance(String instanceName) Restarts a yamcs instance.
void	shutdown()
CompletableFuture<Void>	stopInstance(String instanceName)
void	unregisterClient(int id)
void	unregisterCommandQueueManager(String instance, String processorName, CommandQueueManager cqm)
void	unregisterLink(String instance, String linkName)
void	unregisterService(String instance, String serviceName)
void	unregisterStream(String instance, String name)
void	unregisterTable(String instance, String tblName)

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static ManagementService getInstance()

shutdown

public void shutdown()

registerService

public void registerService(String instance,
                            String serviceName,
                            com.google.common.util.concurrent.Service service)

unregisterService

public void unregisterService(String instance,
                              String serviceName)

registerLink

public void registerLink(String instance,
                         String linkName,
                         String streamName,
                         String spec,
                         Link link)

unregisterLink

public void unregisterLink(String instance,
                           String linkName)

getQueueManager

public CommandQueueManager getQueueManager(String instance,
                                           String processorName)
                                    throws YamcsException

Throws:

YamcsException

getQueueManagers

public List<CommandQueueManager> getQueueManagers()

registerClient

public int registerClient(String instance,
                          String procName,
                          ProcessorClient client)

unregisterClient

public void unregisterClient(int id)

createProcessor

public void createProcessor(YamcsManagement.ProcessorManagementRequest pmr,
                            String username)
                     throws YamcsException

Throws:

YamcsException

connectToProcessor

public void connectToProcessor(Processor processor,
                               int clientId)
                        throws YamcsException,
                               ProcessorException

Throws:

YamcsException

ProcessorException

connectToProcessor

public void connectToProcessor(YamcsManagement.ProcessorManagementRequest cr)
                        throws YamcsException

Throws:

YamcsException

registerCommandQueueManager

public void registerCommandQueueManager(String instance,
                                        String processorName,
                                        CommandQueueManager cqm)

unregisterCommandQueueManager

public void unregisterCommandQueueManager(String instance,
                                          String processorName,
                                          CommandQueueManager cqm)

getCommandQueueManagers

public List<CommandQueueManager> getCommandQueueManagers()

getCommandQueueManager

public CommandQueueManager getCommandQueueManager(Processor processor)

enableLink

public void enableLink(String instance,
                       String linkName)

disableLink

public void disableLink(String instance,
                        String linkName)

addManagementListener

public boolean addManagementListener(ManagementListener l)

Adds a listener that is to be notified when any processor, or any client is updated. Calling this multiple times has no extra effects. Either you listen, or you don't.

addLinkListener

public boolean addLinkListener(LinkListener l)

Adds a listener that is to be notified when any processor, or any client is updated. Calling this multiple times has no extra effects. Either you listen, or you don't.

removeManagementListener

public boolean removeManagementListener(ManagementListener l)

addCommandQueueListener

public boolean addCommandQueueListener(CommandQueueListener l)

addTableStreamListener

public boolean addTableStreamListener(TableStreamListener l)

removeTableStreamListener

public boolean removeTableStreamListener(TableStreamListener l)

removeCommandQueueListener

public boolean removeCommandQueueListener(CommandQueueListener l)

removeLinkListener

public boolean removeLinkListener(LinkListener l)

getLinkInfo

public List<YamcsManagement.LinkInfo> getLinkInfo()

getLinkInfo

public List<YamcsManagement.LinkInfo> getLinkInfo(String instance)

getLinkInfo

public YamcsManagement.LinkInfo getLinkInfo(String instance,
                                            String name)

getClientInfo

public Set<YamcsManagement.ClientInfo> getClientInfo()

getClientInfo

public Set<YamcsManagement.ClientInfo> getClientInfo(String username)

getClientInfo

public YamcsManagement.ClientInfo getClientInfo(int clientId)

processorAdded

public void processorAdded(Processor processor)

Specified by:

processorAdded in interface ProcessorListener

processorClosed

public void processorClosed(Processor processor)

Specified by:

processorClosed in interface ProcessorListener

processorStateChanged

public void processorStateChanged(Processor processor)

Specified by:

processorStateChanged in interface ProcessorListener

registerYamcsInstance

public void registerYamcsInstance(YamcsServerInstance ys)

restartInstance

public CompletableFuture<Void> restartInstance(String instanceName)

Restarts a yamcs instance. It is not possible to restart an instance - so the old one is stopped and a new one is created and started.

Parameters:

instanceName - the name of the instance to be restarted

Returns:

completable that will complete after the instance has been restarted

stopInstance

public CompletableFuture<Void> stopInstance(String instanceName)

registerTable

public void registerTable(String instance,
                          TableDefinition tblDef)

registerStream

public void registerStream(String instance,
                           Stream stream)

unregisterTable

public void unregisterTable(String instance,
                            String tblName)

unregisterStream

public void unregisterStream(String instance,
                             String name)