Interface ConfigLogic
-
public interface ConfigLogic
-
-
Field Summary
Fields Modifier and Type Field Description static StringALLOW_PREFIX_CHANGE_PROPstatic StringCONFIG_SAVEDstatic StringDEFAULT_SUBJECT_PREFIXstatic StringDEFAULT_SUBJECT_PREFIX_PROPstatic StringDISPLAY_EMPTY_GROUPSstatic StringEMAIL_TEST_MODE_PROPstatic StringUPLOAD_DIRECTORY_PROP
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description booleanallowSubjectPrefixChange()Allow the user to change the prefix that is prepended to the subject of emails.ConfigEntrygetConfig()Get the current tool placement configStringgetDefaultSubjectPrefix()Returns the default subject prefix.StringgetUploadDirectory()Get the directory where uploads should be storedbooleanisEmailTestMode()Check if the system is currently set up in a "test" mode, indicating that e-mails should not be actually dispatched, but rather spit into a log or external file for verification purposes.StringsaveConfig(ConfigEntry ce)Save the configuration to the tool placement config space
-
-
-
Field Detail
-
DEFAULT_SUBJECT_PREFIX
static final String DEFAULT_SUBJECT_PREFIX
- See Also:
- Constant Field Values
-
ALLOW_PREFIX_CHANGE_PROP
static final String ALLOW_PREFIX_CHANGE_PROP
- See Also:
- Constant Field Values
-
DEFAULT_SUBJECT_PREFIX_PROP
static final String DEFAULT_SUBJECT_PREFIX_PROP
- See Also:
- Constant Field Values
-
UPLOAD_DIRECTORY_PROP
static final String UPLOAD_DIRECTORY_PROP
- See Also:
- Constant Field Values
-
DISPLAY_EMPTY_GROUPS
static final String DISPLAY_EMPTY_GROUPS
- See Also:
- Constant Field Values
-
EMAIL_TEST_MODE_PROP
static final String EMAIL_TEST_MODE_PROP
- See Also:
- Constant Field Values
-
CONFIG_SAVED
static final String CONFIG_SAVED
- See Also:
- Constant Field Values
-
-
Method Detail
-
getConfig
ConfigEntry getConfig()
Get the current tool placement config- Returns:
-
saveConfig
String saveConfig(ConfigEntry ce)
Save the configuration to the tool placement config space- Parameters:
ce-- Returns:
- "saveConfig" is returned upon completion
-
getUploadDirectory
String getUploadDirectory()
Get the directory where uploads should be stored- Returns:
-
allowSubjectPrefixChange
boolean allowSubjectPrefixChange()
Allow the user to change the prefix that is prepended to the subject of emails. Set through system property "mailsender.allowSubjectPrefixChange".- Returns:
- true if allowed, false otherwise [default: false]
-
getDefaultSubjectPrefix
String getDefaultSubjectPrefix()
Returns the default subject prefix. This is normallyDEFAULT_SUBJECT_PREFIXbut can be set by the system property "mailsender.subjectprefix".- Returns:
-
isEmailTestMode
boolean isEmailTestMode()
Check if the system is currently set up in a "test" mode, indicating that e-mails should not be actually dispatched, but rather spit into a log or external file for verification purposes.- Returns:
- true if the system has specified an email test mode, false otherwise
-
-