org.lsst.ccs.services

Class DataProviderDictionaryService

java.lang.Object

org.lsst.ccs.services.DataProviderDictionaryService

All Implemented Interfaces:

HasLifecycle, ServiceLifecycle, AgentService

public final class DataProviderDictionaryService
extends Object
implements ServiceLifecycle, HasLifecycle, AgentService

A service to manage a worker subsystem's dictionary of DataProviders.

Author:

The LSST CCS Team

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DataProviderDictionaryService.DataProviderDictionaryCommands

Constructor Summary

Constructors

Constructor and Description
DataProviderDictionaryService()

Method Summary

Modifier and Type	Method and Description
void	addDataProviderInfoToDictionary(DataProviderInfo info, String nodePath)
void	addMetadataForDataGroup(KeyValueDataList data, String metadataName, String metadataValue, String dataGroupName)
void	addMetadataForObject(KeyValueDataList data, String metadataName, String metadataValue, Object origin)
void	afterInit()
String	getAgentServiceName() Get the name of this service.
DataProviderDictionary	getDataProviderDictionary()
void	init() Called from the enclosing Subsystem at initialization phase.
void	publishMetadataForDataGroup(String metadataName, String metadataValue, String dataGroupName)
void	publishMetadataForObject(String metadataName, String metadataValue, Object origin)
void	shutdown() Called from the enclosing Subsystem when org.lsst.ccs.Subsystem#shutdown() has been called.
void	start() Called from the enclosing Subsystem when Agent.startAgent() has been called and after HardwareController components have been handled.
boolean	startForAgent(AgentInfo agentInfo) This method is invoked after an agent service is created to see if this service is to be started for the tiven Agent.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.lsst.ccs.ServiceLifecycle

preBuild, preInit, preShutdown, preStart

Methods inherited from interface org.lsst.ccs.framework.HasLifecycle

build, postBuild, postInit, postShutdown, postStart

Constructor Detail

DataProviderDictionaryService

public DataProviderDictionaryService()

Method Detail

getAgentServiceName

public String getAgentServiceName()

Description copied from interface: AgentService

Get the name of this service. This name will be used to add the given service to the lookup tree.

Specified by:

getAgentServiceName in interface AgentService

Returns:

the AgentService name.

startForAgent

public boolean startForAgent(AgentInfo agentInfo)

Description copied from interface: AgentService

This method is invoked after an agent service is created to see if this service is to be started for the tiven Agent.

Specified by:

startForAgent in interface AgentService

Returns:

true if the service is to be added to the given agent.

init

public void init()

Description copied from interface: HasLifecycle

Called from the enclosing Subsystem at initialization phase.

This method is called before the children components of this object have their init method called.

At the time it is called, connection to the messaging layer is not yet done, so there should be no attempt to send messages in the body of this method. Configuration for message listening can nevertheless be done here, such as adding MessageListener objects.

It is unnecessary to call super.init()

Specified by:

init in interface HasLifecycle

afterInit

public void afterInit()

Specified by:

afterInit in interface ServiceLifecycle

start

public void start()

Description copied from interface: HasLifecycle

Called from the enclosing Subsystem when Agent.startAgent() has been called and after HardwareController components have been handled. At the time it is called :

• the PhaseState is INITIALIZING
• connection with the messaging layer is effective, the enclosing subsystem has started StatusHeartBeat publication
• the startup configuration has been loaded (if provided). IMPORTANT NOTE : This statement will not be true in future releases. Code that expect the startup configuration to be loaded should be moved from start to postStart.

It is unnecessary to call super.start()

Specified by:

start in interface HasLifecycle

shutdown

public void shutdown()

Description copied from interface: HasLifecycle

Called from the enclosing Subsystem when org.lsst.ccs.Subsystem#shutdown() has been called. At the time it is called :

• PhaseState is CLOSING.
• HardwareController.checkStopped() has been called

It should be overridden to free non hardware related resources.

Specified by:

shutdown in interface HasLifecycle

addDataProviderInfoToDictionary

public void addDataProviderInfoToDictionary(DataProviderInfo info,
                                            String nodePath)

getDataProviderDictionary

public DataProviderDictionary getDataProviderDictionary()

addMetadataForDataGroup

public void addMetadataForDataGroup(KeyValueDataList data,
                                    String metadataName,
                                    String metadataValue,
                                    String dataGroupName)

addMetadataForObject

public void addMetadataForObject(KeyValueDataList data,
                                 String metadataName,
                                 String metadataValue,
                                 Object origin)

publishMetadataForDataGroup

public void publishMetadataForDataGroup(String metadataName,
                                        String metadataValue,
                                        String dataGroupName)

publishMetadataForObject

public void publishMetadataForObject(String metadataName,
                                     String metadataValue,
                                     Object origin)