Package org.opennms.netmgt.dao.api
Interface JavaMailConfigurationDao
-
- All Known Implementing Classes:
DefaultJavamailConfigurationDao,MockJavaMailConfigurationDao
public interface JavaMailConfigurationDaoThe Interface JavaMailConfigurationDao.- Author:
- David Hustace
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidaddEnd2endMailConfig(End2endMailConfig end2endConfig)Adds the end2end mail configuration.voidaddReadMailConfig(ReadmailConfig readmailConfig)Adds the read mail configuration.voidaddSendMailConfig(SendmailConfig sendmailConfig)Adds the send mail configuration.ReadmailConfiggetDefaultReadmailConfig()Gets the default readmail configuration.SendmailConfiggetDefaultSendmailConfig()Gets the default sendmail configuration.End2endMailConfiggetEnd2endConfig(java.lang.String end2endConfigName)Gets the end2end mail configuration.java.util.List<End2endMailConfig>getEnd2EndConfigs()Gets the end2end mail configurations.ReadmailConfiggetReadMailConfig(java.lang.String readmailConfigName)Gets the read mail configuration.java.util.List<ReadmailConfig>getReadmailConfigs()Gets the readmail configurations.SendmailConfiggetSendMailConfig(java.lang.String sendmailConfigName)Gets the send mail configuration.java.util.List<SendmailConfig>getSendmailConfigs()Gets the sendmail configurations.voidreloadConfiguration()Reloads the configuration.booleanremoveEnd2endConfig(java.lang.String end2endConfigName)Removes the end2 end configuration.booleanremoveReadMailConfig(java.lang.String readmailConfigName)Removes the readmail configuration.booleanremoveSendMailConfig(java.lang.String sendmailConfigName)Removes the sendmail configuration.voidsaveConfiguration()Saves the current configuration on disk.voidsetDefaultReadmailConfig(java.lang.String readmailConfigName)Sets the default readmail configuration.voidsetDefaultSendmailConfig(java.lang.String sendmailConfigName)Sets the default sendmail configuration.voidverifyMarshaledConfiguration()Verifies marshaled configuration.
-
-
-
Method Detail
-
getDefaultSendmailConfig
SendmailConfig getDefaultSendmailConfig()
Gets the default sendmail configuration.- Returns:
- the default sendmail configuration
-
setDefaultSendmailConfig
void setDefaultSendmailConfig(java.lang.String sendmailConfigName)
Sets the default sendmail configuration.- Parameters:
sendmailConfigName- the new default sendmail configuration
-
getDefaultReadmailConfig
ReadmailConfig getDefaultReadmailConfig()
Gets the default readmail configuration.- Returns:
- the default readmail configuration
-
setDefaultReadmailConfig
void setDefaultReadmailConfig(java.lang.String readmailConfigName)
Sets the default readmail configuration.- Parameters:
readmailConfigName- the new default readmail configuration
-
getSendMailConfig
SendmailConfig getSendMailConfig(java.lang.String sendmailConfigName)
Gets the send mail configuration.- Parameters:
sendmailConfigName- the sendmail configuration name- Returns:
- the send mail configuration
-
addSendMailConfig
void addSendMailConfig(SendmailConfig sendmailConfig)
Adds the send mail configuration.If there is a sendmail-config object with the same name, it will be replaced; otherwise, the new object will be added.
- Parameters:
sendmailConfig- the sendmail configuration
-
removeSendMailConfig
boolean removeSendMailConfig(java.lang.String sendmailConfigName)
Removes the sendmail configuration.- Parameters:
sendmailConfigName- the sendmail configuration name- Returns:
- true, if successful
-
getSendmailConfigs
java.util.List<SendmailConfig> getSendmailConfigs()
Gets the sendmail configurations.- Returns:
- the sendmail configurations
-
getReadMailConfig
ReadmailConfig getReadMailConfig(java.lang.String readmailConfigName)
Gets the read mail configuration.- Parameters:
readmailConfigName- the readmail configuration name- Returns:
- the read mail configuration
-
addReadMailConfig
void addReadMailConfig(ReadmailConfig readmailConfig)
Adds the read mail configuration.If there is a readmail-config object with the same name, it will be replaced; otherwise, the new object will be added.
- Parameters:
readmailConfig- the readmail configuration
-
removeReadMailConfig
boolean removeReadMailConfig(java.lang.String readmailConfigName)
Removes the readmail configuration.- Parameters:
readmailConfigName- the readmail configuration name- Returns:
- true, if successful
-
getReadmailConfigs
java.util.List<ReadmailConfig> getReadmailConfigs()
Gets the readmail configurations.- Returns:
- the readmail configurations
-
getEnd2endConfig
End2endMailConfig getEnd2endConfig(java.lang.String end2endConfigName)
Gets the end2end mail configuration.- Parameters:
end2endConfigName- the end2end configuration name- Returns:
- the end2end configuration
-
addEnd2endMailConfig
void addEnd2endMailConfig(End2endMailConfig end2endConfig)
Adds the end2end mail configuration.If there is a end2end-mail-config object with the same name, it will be replaced; otherwise, the new object will be added.
- Parameters:
end2endConfig- the end2end configuration
-
removeEnd2endConfig
boolean removeEnd2endConfig(java.lang.String end2endConfigName)
Removes the end2 end configuration.- Parameters:
end2endConfigName- the end2end configuration name- Returns:
- true, if successful
-
getEnd2EndConfigs
java.util.List<End2endMailConfig> getEnd2EndConfigs()
Gets the end2end mail configurations.- Returns:
- the end2end mail configurations
-
verifyMarshaledConfiguration
void verifyMarshaledConfiguration() throws java.lang.IllegalStateExceptionVerifies marshaled configuration.- Throws:
java.lang.IllegalStateException- the illegal state exception
-
reloadConfiguration
void reloadConfiguration() throws org.springframework.dao.DataAccessResourceFailureExceptionReloads the configuration.- Throws:
org.springframework.dao.DataAccessResourceFailureException- the data access resource failure exception
-
saveConfiguration
void saveConfiguration()
Saves the current configuration on disk.
-
-