org.lsst.ccs.services

Class AgentPropertiesService

java.lang.Object

org.lsst.ccs.services.AgentPropertiesService

All Implemented Interfaces:

ServiceLifecycle, AgentService

public class AgentPropertiesService
extends Object
implements ServiceLifecycle, AgentService

A Service to add Properties CCS Agents. It starts for all agents. Properties can be set in two ways: * programmatically using the setAgentProperty method either in the HasLifecycle::build or HasLifecycle::init phases. * via bootstrap properties. These properties must precede the name of the property to be set with org.lsst.ccs.subsystem.agent.property. Properties set via the bootstrap method will override any agent property set programmatically.

Author:

The LSST CCS Team

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AgentPropertiesService.AgentPropertiesServiceCommands

Constructor Summary

Constructors

Constructor and Description
AgentPropertiesService()

Method Summary

Modifier and Type	Method and Description
void	afterInit()
Properties	getAgentProperties() Get the agent properties.
Set	getAgentPropertiesKeySet() Get the Set of agent properties.
String	getAgentProperty(String property) Get an agent property.
String	getAgentServiceName() Get the name of this service.
void	preInit()
void	setAgentProperty(String property, String value)
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

afterStart, preBuild, preShutdown, preStart

Constructor Detail

AgentPropertiesService

public AgentPropertiesService()

Method Detail

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.

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.

setAgentProperty

public void setAgentProperty(String property,
                             String value)

preInit

public void preInit()

Specified by:

preInit in interface ServiceLifecycle

afterInit

public void afterInit()

Specified by:

afterInit in interface ServiceLifecycle

getAgentProperty

public String getAgentProperty(String property)

Get an agent property.

Parameters:

property - The property name.

Returns:

The value of the property.

getAgentPropertiesKeySet

public Set getAgentPropertiesKeySet()

Get the Set of agent properties.

Returns:

The Set of available Agent properties.

getAgentProperties

public Properties getAgentProperties()

Get the agent properties.

Returns:

The Agent properties.