org.lsst.ccs.subsystem.doorman.main

Interface LocalConfigurationService

All Known Implementing Classes:

CCSConfiguration

public interface LocalConfigurationService

Represents a repository of configuration information.

Author:

tether

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	makeConfigurationObjects() Read the external configuration info, from whatever source, and create the InstrumentConfig objects.

Method Detail

makeConfigurationObjects

void makeConfigurationObjects()

Read the external configuration info, from whatever source, and create the InstrumentConfig objects.

getInstrumentConfigs

List<InstrumentConfig> getInstrumentConfigs()

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

Returns:

The list of the configuration objects.

getReadoutInterval

Duration getReadoutInterval()

Gets the time between instrument readouts.

Returns:

The time.

getEmailSender

String getEmailSender()

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

Returns:

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

getEmailBounceAddress

String getEmailBounceAddress()

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

Returns:

The email address of a real mailbox.

getSMTPServer

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.

Returns:

The name string or the IPv4 address in dotted notation.

getEmailRecipients

List<String> getEmailRecipients()

Gets the list of recipients of alarm emails.

Returns:

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