org.lsst.ccs.subsystem.doorman.main

Class CCSConfiguration

java.lang.Object

org.lsst.ccs.subsystem.doorman.main.CCSConfiguration

All Implemented Interfaces:

org.lsst.ccs.framework.HasLifecycle, LocalConfigurationService

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

Implements a local configuration service based on the CCS subsystem configuration API. An instance will be the receptacle of all the subsystem configuration data which is declared here using the ConfigurationParameter annotation.

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() Gets the value of the "From" fields for alarm emails.
List<InstrumentConfig>	getInstrumentConfigs() Gets an InstrumentConfig for each instrument described by the configuration data.
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() Check that all the subsystem services we need have been found.
void	makeConfigurationObjects() Checks the raw configuration data and makes the configuration objects.

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, shutdown, start

Constructor Detail

CCSConfiguration

public CCSConfiguration()

Makes an instance.

Method Detail

makeConfigurationObjects

public void makeConfigurationObjects()

Checks the raw configuration data and makes the configuration objects. Called at the start of the initialization phase.

Specified by:

makeConfigurationObjects in interface LocalConfigurationService

getInstrumentConfigs

public List<InstrumentConfig> getInstrumentConfigs()

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

Specified by:

getInstrumentConfigs in interface LocalConfigurationService

Returns:

The list of the configuration objects.

getReadoutInterval

public Duration getReadoutInterval()

Gets the time between instrument readouts.

Specified by:

getReadoutInterval in interface LocalConfigurationService

Returns:

The time.

getEmailSender

public String getEmailSender()

Gets the value of the "From" fields for alarm emails.

Specified by:

getEmailSender in interface LocalConfigurationService

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 LocalConfigurationService

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 LocalConfigurationService

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 LocalConfigurationService

Returns:

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

init

public void init()

Check that all the subsystem services we need have been found.

Specified by:

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

Throws:

RuntimeException - if any are missing.