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 integrating with core yamcs classes, encoding to protobuf, and forwarding aggregated info downstream.

Notable examples of downstream listeners are the MBeanServer, the ActiveMQ-business, and subscribed websocket clients.

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.
void	connectToProcessor(YamcsManagement.ProcessorManagementRequest cr, AuthenticationToken usertoken)
void	createProcessor(YamcsManagement.ProcessorManagementRequest cr, AuthenticationToken authToken)
void	disableLink(String instance, String name)
void	enableLink(String instance, String name)
Set<YamcsManagement.ClientInfo>	getClientInfo()
YamcsManagement.ClientInfo	getClientInfo(int clientId)
Set<YamcsManagement.ClientInfo>	getClientInfo(String username)
CommandQueueManager	getCommandQueueManager(YProcessor processor)
List<CommandQueueManager>	getCommandQueueManagers()
static ManagementService	getInstance()
List<YamcsManagement.LinkInfo>	getLinkInfo()
YamcsManagement.LinkInfo	getLinkInfo(String instance, String name)
CommandQueueManager	getQueueManager(String instance, String processorName)
List<CommandQueueManager>	getQueueManagers()
void	processorAdded(YProcessor processor)
void	processorClosed(YProcessor processor)
void	processorStateChanged(YProcessor processor)
int	registerClient(String instance, String yprocName, ProcessorClient client)
void	registerCommandQueueManager(String instance, String yprocName, CommandQueueManager cqm)
void	registerLink(String instance, String name, String streamName, String spec, Link link)
void	registerService(String instance, String serviceName, com.google.common.util.concurrent.Service service)
void	registerYProcessor(YProcessor yproc)
boolean	removeCommandQueueListener(CommandQueueListener l)
boolean	removeLinkListener(LinkListener l)
boolean	removeManagementListener(ManagementListener l)
static void	setup(boolean jmxEnabled)
void	shutdown()
void	unregisterClient(int id)
void	unregisterLink(String instance, String name)
void	unregisterService(String instance, String serviceName)
void	unregisterYProcessor(YProcessor yproc)

Methods inherited from class java.lang.Object

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

Method Detail

setup

public static void setup(boolean jmxEnabled)
                  throws NotCompliantMBeanException,
                         InstanceAlreadyExistsException,
                         MBeanRegistrationException,
                         MalformedObjectNameException,
                         NullPointerException

Throws:

NotCompliantMBeanException

InstanceAlreadyExistsException

MBeanRegistrationException

MalformedObjectNameException

NullPointerException

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 name,
                         String streamName,
                         String spec,
                         Link link)

unregisterLink

public void unregisterLink(String instance,
                           String name)

getQueueManager

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

Throws:

YamcsException

getQueueManagers

public List<CommandQueueManager> getQueueManagers()

registerYProcessor

public void registerYProcessor(YProcessor yproc)

unregisterYProcessor

public void unregisterYProcessor(YProcessor yproc)

registerClient

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

unregisterClient

public void unregisterClient(int id)

createProcessor

public void createProcessor(YamcsManagement.ProcessorManagementRequest cr,
                            AuthenticationToken authToken)
                     throws YamcsException

Throws:

YamcsException

connectToProcessor

public void connectToProcessor(YamcsManagement.ProcessorManagementRequest cr,
                               AuthenticationToken usertoken)
                        throws YamcsException

Throws:

YamcsException

registerCommandQueueManager

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

getCommandQueueManagers

public List<CommandQueueManager> getCommandQueueManagers()

getCommandQueueManager

public CommandQueueManager getCommandQueueManager(YProcessor processor)

enableLink

public void enableLink(String instance,
                       String name)
                throws YamcsException

Throws:

YamcsException

disableLink

public void disableLink(String instance,
                        String name)
                 throws YamcsException

Throws:

YamcsException

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)

removeCommandQueueListener

public boolean removeCommandQueueListener(CommandQueueListener l)

removeLinkListener

public boolean removeLinkListener(LinkListener l)

getLinkInfo

public List<YamcsManagement.LinkInfo> getLinkInfo()

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(YProcessor processor)

Specified by:

processorAdded in interface ProcessorListener

processorClosed

public void processorClosed(YProcessor processor)

Specified by:

processorClosed in interface ProcessorListener

processorStateChanged

public void processorStateChanged(YProcessor processor)

Specified by:

processorStateChanged in interface ProcessorListener