org.lsst.ccs.subsystem.airwatch.main

Class CCSConfiguration

java.lang.Object

org.lsst.ccs.subsystem.airwatch.main.CCSConfiguration

All Implemented Interfaces:

org.lsst.ccs.framework.HasLifecycle, LocalConfigService

public class CCSConfiguration
extends Object
implements LocalConfigService, org.lsst.ccs.framework.HasLifecycle

Implements a local configuration service based on the CCS subsystem configuration and persistence APIs. An instance will be the receptacle of all the subsystem configuration/persistent data which is declared here using the ConfigurationParameter or Persist annotations. The last-read time and last assigned location for each instrument is normally obtained from the persistence service unless overridden by the configuration.

Author:

tether

Constructor Summary

Constructors

Constructor and Description
CCSConfiguration() Makes an instance.

Method Summary

Modifier and Type	Method and Description
String	getEmailBounceAddress() Get the value of the "bounce-to" and "reply-to" fields for alarm emails.
List<String>	getEmailRecipients() Gets the list of recipients of alarm emails.
String	getEmailSender()
List<InstrumentConfig>	getInstrumentConfigs() Gets an InstrumentConfig for each instrument described by the configuration data.
List<LocationConfig>	getLocationConfigs() Gets a LocationConfig for each location described by the configuration data.
List<String>	getOPCServerInfo(String serverKey) Gets the list of information needed to contact a Lighthouse OPC server.
Duration	getReadoutInterval() Gets the time between instrument readouts.
String	getSMTPServer() Gets the host name or IPv4 address of the SMTP server used to send emails.
void	init()
void	makeConfigurationObjects() Checks configuration and persistent data and makes the configuration objects.
void	updateInstrument(InstrumentStatus stat) Updates the information in the configuration database for a particular instrument.

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.framework.HasLifecycle

build, postBuild, postInit, postShutdown, postStart, postStop, start, stop

Constructor Detail

CCSConfiguration

public CCSConfiguration()

Makes an instance.

Method Detail

makeConfigurationObjects

public void makeConfigurationObjects()

Checks configuration and persistent data and makes the configuration objects. Must only be called when full configuration data is available.

Specified by:

makeConfigurationObjects in interface LocalConfigService

getInstrumentConfigs

public List<InstrumentConfig> getInstrumentConfigs()

Gets an InstrumentConfig for each instrument described by the configuration data.

Specified by:

getInstrumentConfigs in interface LocalConfigService

Returns:

The list of the configuration objects.

updateInstrument

public void updateInstrument(InstrumentStatus stat)

Updates the information in the configuration database for a particular instrument.

Specified by:

updateInstrument in interface LocalConfigService

Parameters:

stat - The current status of the instrument.

getLocationConfigs

public List<LocationConfig> getLocationConfigs()

Gets a LocationConfig for each location described by the configuration data.

Specified by:

getLocationConfigs in interface LocalConfigService

Returns:

The list of configuration objects.

getReadoutInterval

public Duration getReadoutInterval()

Gets the time between instrument readouts.

Specified by:

getReadoutInterval in interface LocalConfigService

Returns:

The time.

getEmailSender

public String getEmailSender()

Specified by:

getEmailSender in interface LocalConfigService

Returns:

A syntactically valid email address. Doesn't need to be for a real mailbox.

getEmailBounceAddress

public String getEmailBounceAddress()

Get the value of the "bounce-to" and "reply-to" fields for alarm emails.

Specified by:

getEmailBounceAddress in interface LocalConfigService

Returns:

The email address of a real mailbox.

getSMTPServer

public String getSMTPServer()

Gets the host name or IPv4 address of the SMTP server used to send emails. This server should accept emails with no authentication.

Specified by:

getSMTPServer in interface LocalConfigService

Returns:

The name string or the IPv4 address in dotted notation.

getEmailRecipients

public List<String> getEmailRecipients()

Gets the list of recipients of alarm emails.

Specified by:

getEmailRecipients in interface LocalConfigService

Returns:

A possibly empty list of valid email addresses (strings).

getOPCServerInfo

public List<String> getOPCServerInfo(String serverKey)

Description copied from interface: LocalConfigService

Gets the list of information needed to contact a Lighthouse OPC server.

Specified by:

getOPCServerInfo in interface LocalConfigService

Parameters:

serverKey - The server name used in the device connection information.

Returns:

The contact information.

init

public void init()

Specified by:

init in interface org.lsst.ccs.framework.HasLifecycle