public class

Settings

extends Object
implements Serializable
java.lang.Object
   ↳ com.atlassian.confluence.setup.settings.Settings

Summary

Constants
String BRAZILIAN
String CHINESE
String CJK
String CUSTOM_JAPANESE
String CZECH
String DAILY_BACKUP_DIRECTORY
String DEFAULT_DEFAULT_ENCODING
String DEFAULT_SITE_TITLE
String EMAIL_ADDRESS_MASKED
String EMAIL_ADDRESS_PRIVATE
String EMAIL_ADDRESS_PUBLIC
String EMAIL_FROMNAME_DEFAULT
String ENGLISH
String FRENCH
String GERMAN
String GREEK
String LOCALE_ENGLISH
String LOCALE_GERMAN
String LOCALE_JAPANESE
String LOCALE_RUSSIAN
String RUSSIAN
Public Constructors
Settings()
Settings(Settings settings)
Public Methods
boolean areEmailAddressesPrivate()
String getAttachmentDataStore()
long getAttachmentMaxSize()
String getBackupPath()
String getBaseUrl()
CaptchaSettings getCaptchaSettings()
ColourSchemesSettings getColourSchemesSettings()
ConfluenceHttpParameters getConfluenceHttpParameters()
String getCustomContactMessage()
CustomHtmlSettings getCustomHtmlSettings()
String getDailyBackupDateFormatPattern()
String getDailyBackupFilePrefix()
String getDefaultEncoding()
String getDefaultPersonalSpaceHomepageContent()
String getDefaultSpaceHomepageContent()
String getDefaultSpaceHomepageTitle()
int getDraftSaveInterval()
String getEmailAddressVisibility()
String getGlobalDefaultLocale()
String getIndexingLanguage()
LoginManagerSettings getLoginManagerSettings()
int getMaxAttachmentsInUI()
int getMaxRssItems()
int getMaxSimultaneousQuickNavRequests()
Dimensions getMaxThumbDimensions()
int getMaxThumbHeight()
int getMaxThumbWidth()
@Deprecated int getNumberOfBreadcrumbAncestors()
This method is deprecated. since 4.0
int getPageTimeout()
ReferrerSettings getReferrerSettings()
int getRssTimeout()
String getSiteHomePage()
String getSiteTitle()
String getSiteWelcomeMessage()
String getSupportRequestEmail()
TimeZone getTimeZone()
boolean getWebSudoEnabled()
long getWebSudoTimeout()
String getWebdavPassword()
String getWebdavServerUrl()
String getWebdavUsername()
boolean isAddWildcardsToUserAndGroupSearches()
boolean isAllowCamelCase()
boolean isAllowRemoteApi()
boolean isAllowRemoteApiAnonymous()
boolean isAllowThreadedComments()
boolean isAllowTrackbacks()
boolean isAlmostSupportPeriodEndMessageOff()
boolean isAntiXssMode()
boolean isBackupAttachmentsDaily()
boolean isBackupDaily()
boolean isBaseUrlAdminMessageOff()
boolean isDenyPublicSignup()
boolean isDisableLogo()
@Deprecated boolean isDisplayLinkIcons()
This method is deprecated. since 4.0
boolean isEmailAdminMessageOff()
boolean isEnableDidYouMean()
boolean isEnableJavascriptTop()
boolean isEnableOpenSearch()
boolean isEnableQuickNav()
boolean isEnableSpaceStyles()
@Deprecated boolean isEnableWysiwyg()
This method is deprecated. since 4.0
boolean isExternalUserManagement()
boolean isGzippingResponse()
boolean isNofollowExternalLinks()
boolean isSaveable()
boolean isSenMissingInLicenseMessageOff()
boolean isSharedMode()
boolean isShowContactAdministratorsForm()
boolean isShowSystemInfoIn500Page()
@Deprecated boolean isUseWysiwygByDefault()
This method is deprecated. since 4.0
boolean isViewSpaceGoesToSpaceSummary()
boolean isWebdavEnabled()
boolean isXsrfAddComments()
void setAddWildcardsToUserAndGroupSearches(boolean addWildcardsToUserAndGroupSearches)
void setAllowCamelCase(boolean allowCamelCase)
void setAllowRemoteApi(boolean allowRemoteApi)
void setAllowRemoteApiAnonymous(boolean allowRemoteApiAnonymous)
void setAllowThreadedComments(boolean allowThreadedComments)
void setAllowTrackbacks(boolean allowTrackbacks)
void setAlmostSupportPeriodEndMessageOff(boolean almostSupportPeriodEndMessageOff)
@Deprecated void setAnitXssMode(boolean antiXssMode)
This method is deprecated. since 3.5.8 use setAntiXssMode(boolean) instead.
void setAntiXssMode(boolean antiXssMode)
void setAttachmentDataStore(String attachmentDataStore)
void setAttachmentMaxSize(long attachmentMaxSize)
void setBackupAttachmentsDaily(boolean backupAttachmentsDaily)
void setBackupDaily(boolean backupDaily)
void setBackupPath(String backupPath)
void setBaseUrl(String baseUrl)
void setBaseUrlAdminMessageOff(boolean baseUrlAdminMessageOff)
void setCaptchaSettings(CaptchaSettings captchaSettings)
void setColourSchemesSettings(ColourSchemesSettings colourSchemesSettings)
void setConfluenceHttpParameters(ConfluenceHttpParameters confluenceHttpParameters)
void setCustomContactMessage(String customErrorMessage)
void setCustomHtmlSettings(CustomHtmlSettings customHtmlSettings)
void setDailyBackupDateFormatPattern(String dailyBackupDateFormatPattern)
void setDailyBackupFilePrefix(String dailyBackupFilePrefix)
void setDefaultEncoding(String defaultEncoding)
void setDefaultPersonalSpaceHomepageContent(String defaultPersonalSpaceHomepageContent)
void setDefaultSpaceHomepageContent(String defaultSpaceHomepageContent)
void setDefaultSpaceHomepageTitle(String defaultSpaceHomepageTitle)
void setDenyPublicSignup(boolean denyPublicSignup)
void setDisableLogo(boolean disableLogo)
@Deprecated void setDisplayLinkIcons(boolean displayLinkIcons)
This method is deprecated. since 4.0
void setDraftSaveInterval(int draftSaveInterval)
void setEmailAddressVisibility(String emailAddressVisibility)
void setEmailAdminMessageOff(boolean emailAdminMessageOff)
void setEnableDidYouMean(boolean enableDidYouMean)
void setEnableJavascriptTop(boolean enableJavascriptTop)
void setEnableOpenSearch(boolean enableOpenSearch)
void setEnableQuickNav(boolean enableQuickNav)
void setEnableSpaceStyles(boolean enableSpaceStyles)
@Deprecated void setEnableWysiwyg(boolean enableWysiwyg)
This method is deprecated. since 4.0
void setExternalUserManagement(boolean externalUserManagement)
void setGlobalDefaultLocale(String localeString)
void setGzippingResponse(boolean gzippingResponse)
void setIndexingLanguage(String indexingLanguage)
void setLoginManagerSettings(LoginManagerSettings loginManagerSettings)
void setMaxAttachmentsInUI(int maxAttachmentsInUI)
void setMaxRssItems(int maxRssItems)
void setMaxSimultaneousQuickNavRequests(int maxSimultaneousQuickNavRequests)
@Deprecated void setMaxThumbHeight(int maxThumbHeight)
This method is deprecated. since 4.0
@Deprecated void setMaxThumbWidth(int maxThumbWidth)
This method is deprecated. since 4.0
void setNofollowExternalLinks(boolean nofollowExternalLinks)
@Deprecated void setNumberOfBreadcrumbAncestors(int numberOfBreadcrumbAncestors)
This method is deprecated. since 4.0
void setPageTimeout(int pageTimeout)
void setReferrerSettings(ReferrerSettings referrerSettings)
void setRssTimeout(int rssTimeout)
void setSenMissingInLicenseMessageOff(boolean senMissingInLicenseMessageOff)
void setSharedMode(boolean sharedMode)
void setShowContactAdministratorsForm(boolean showContactAdministratorsForm)
void setShowSystemInfoIn500Page(boolean showSystemInfoIn500Page)
void setSiteHomePage(String siteHomePage)
void setSiteTitle(String siteTitle)
void setSiteWelcomeMessage(String siteWelcomeMessage)
void setSupportRequestEmail(String supportRequestEmail)
@Deprecated void setUseWysiwygByDefault(boolean useWysiwygByDefault)
This method is deprecated. since 4.0
void setViewSpaceGoesToSpaceSummary(boolean viewSpaceGoesToSpaceSummary)
void setWebSudoEnabled(boolean webSudoEnabled)
void setWebSudoTimeout(long webSudoTimeout)
void setWebdavPassword(String webdavPassword)
void setWebdavServerUrl(String webdavServerUrl)
void setWebdavUsername(String webdavUsername)
void setXsrfAddComments(boolean xsrfAddComments)
static Settings unsavableSettings()
Instantiate a settings object that will be ignored by the settings manager if you attempt to save it.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String BRAZILIAN

Constant Value: "brazilian"

public static final String CHINESE

Constant Value: "chinese"

public static final String CJK

Constant Value: "CJK"

public static final String CUSTOM_JAPANESE

Constant Value: "custom-japanese"

public static final String CZECH

Constant Value: "czech"

public static final String DAILY_BACKUP_DIRECTORY

Constant Value: "backups"

public static final String DEFAULT_DEFAULT_ENCODING

Constant Value: "UTF-8"

public static final String DEFAULT_SITE_TITLE

Constant Value: "Confluence"

public static final String EMAIL_ADDRESS_MASKED

Constant Value: "email.address.masked"

public static final String EMAIL_ADDRESS_PRIVATE

Constant Value: "email.address.private"

public static final String EMAIL_ADDRESS_PUBLIC

Constant Value: "email.address.public"

public static final String EMAIL_FROMNAME_DEFAULT

Constant Value: "${fullname} (Confluence)"

public static final String ENGLISH

Constant Value: "english"

public static final String FRENCH

Constant Value: "french"

public static final String GERMAN

Constant Value: "german"

public static final String GREEK

Constant Value: "greek"

public static final String LOCALE_ENGLISH

Constant Value: "en_GB"

public static final String LOCALE_GERMAN

Constant Value: "de_DE"

public static final String LOCALE_JAPANESE

Constant Value: "ja_JP"

public static final String LOCALE_RUSSIAN

Constant Value: "ru_RU"

public static final String RUSSIAN

Constant Value: "russian"

Public Constructors

public Settings ()

public Settings (Settings settings)

Public Methods

public boolean areEmailAddressesPrivate ()

public String getAttachmentDataStore ()

public long getAttachmentMaxSize ()

public String getBackupPath ()

public String getBaseUrl ()

public CaptchaSettings getCaptchaSettings ()

public ColourSchemesSettings getColourSchemesSettings ()

public ConfluenceHttpParameters getConfluenceHttpParameters ()

public String getCustomContactMessage ()

public CustomHtmlSettings getCustomHtmlSettings ()

public String getDailyBackupDateFormatPattern ()

public String getDailyBackupFilePrefix ()

public String getDefaultEncoding ()

public String getDefaultPersonalSpaceHomepageContent ()

public String getDefaultSpaceHomepageContent ()

public String getDefaultSpaceHomepageTitle ()

public int getDraftSaveInterval ()

public String getEmailAddressVisibility ()

public String getGlobalDefaultLocale ()

public String getIndexingLanguage ()

public LoginManagerSettings getLoginManagerSettings ()

public int getMaxAttachmentsInUI ()

public int getMaxRssItems ()

public int getMaxSimultaneousQuickNavRequests ()

public Dimensions getMaxThumbDimensions ()

public int getMaxThumbHeight ()

public int getMaxThumbWidth ()

@Deprecated public int getNumberOfBreadcrumbAncestors ()

This method is deprecated.
since 4.0

You can no longer conifgure the breadcrumb ancestors in 4.0

public int getPageTimeout ()

public ReferrerSettings getReferrerSettings ()

public int getRssTimeout ()

public String getSiteHomePage ()

public String getSiteTitle ()

public String getSiteWelcomeMessage ()

public String getSupportRequestEmail ()

Returns
  • the default e-mail address that support requests will be sent to.

public TimeZone getTimeZone ()

Returns
  • the server's default time zone. Each user has a preference for the time zone, but if the preference isn't set, it defaults to this value.
See Also

public boolean getWebSudoEnabled ()

public long getWebSudoTimeout ()

public String getWebdavPassword ()

public String getWebdavServerUrl ()

public String getWebdavUsername ()

public boolean isAddWildcardsToUserAndGroupSearches ()

public boolean isAllowCamelCase ()

public boolean isAllowRemoteApi ()

public boolean isAllowRemoteApiAnonymous ()

public boolean isAllowThreadedComments ()

public boolean isAllowTrackbacks ()

public boolean isAlmostSupportPeriodEndMessageOff ()

Returns
  • boolean saying whether or not to display reminder for support period expiration

public boolean isAntiXssMode ()

public boolean isBackupAttachmentsDaily ()

public boolean isBackupDaily ()

public boolean isBaseUrlAdminMessageOff ()

Returns
  • boolean saying whether or not to display reminder for admin to configure base url if set to 127.0.0.1 or localhost

public boolean isDenyPublicSignup ()

public boolean isDisableLogo ()

@Deprecated public boolean isDisplayLinkIcons ()

This method is deprecated.
since 4.0

public boolean isEmailAdminMessageOff ()

Returns
  • boolean saying whether or not to display reminder for admin to configure email servers

public boolean isEnableDidYouMean ()

public boolean isEnableJavascriptTop ()

public boolean isEnableOpenSearch ()

public boolean isEnableQuickNav ()

public boolean isEnableSpaceStyles ()

@Deprecated public boolean isEnableWysiwyg ()

This method is deprecated.
since 4.0

You can no longer disable wysiwyg mode in 4.0. Will always return true.

public boolean isExternalUserManagement ()

public boolean isGzippingResponse ()

public boolean isNofollowExternalLinks ()

public boolean isSaveable ()

public boolean isSenMissingInLicenseMessageOff ()

public boolean isSharedMode ()

public boolean isShowContactAdministratorsForm ()

public boolean isShowSystemInfoIn500Page ()

@Deprecated public boolean isUseWysiwygByDefault ()

This method is deprecated.
since 4.0

You can no longer disable wysiwyg mode in 4.0. Will always return true.

public boolean isViewSpaceGoesToSpaceSummary ()

public boolean isWebdavEnabled ()

public boolean isXsrfAddComments ()

public void setAddWildcardsToUserAndGroupSearches (boolean addWildcardsToUserAndGroupSearches)

public void setAllowCamelCase (boolean allowCamelCase)

public void setAllowRemoteApi (boolean allowRemoteApi)

public void setAllowRemoteApiAnonymous (boolean allowRemoteApiAnonymous)

public void setAllowThreadedComments (boolean allowThreadedComments)

public void setAllowTrackbacks (boolean allowTrackbacks)

public void setAlmostSupportPeriodEndMessageOff (boolean almostSupportPeriodEndMessageOff)

Parameters
almostSupportPeriodEndMessageOff saying whether or not to display reminder for support period expiration

@Deprecated public void setAnitXssMode (boolean antiXssMode)

This method is deprecated.
since 3.5.8 use setAntiXssMode(boolean) instead.

public void setAntiXssMode (boolean antiXssMode)

public void setAttachmentDataStore (String attachmentDataStore)

public void setAttachmentMaxSize (long attachmentMaxSize)

public void setBackupAttachmentsDaily (boolean backupAttachmentsDaily)

public void setBackupDaily (boolean backupDaily)

public void setBackupPath (String backupPath)

public void setBaseUrl (String baseUrl)

public void setBaseUrlAdminMessageOff (boolean baseUrlAdminMessageOff)

Parameters
baseUrlAdminMessageOff boolean saying whether or not display reminder for admin to configure base url if set to 127.0.0.1 or localhost

public void setCaptchaSettings (CaptchaSettings captchaSettings)

public void setColourSchemesSettings (ColourSchemesSettings colourSchemesSettings)

public void setConfluenceHttpParameters (ConfluenceHttpParameters confluenceHttpParameters)

public void setCustomContactMessage (String customErrorMessage)

public void setCustomHtmlSettings (CustomHtmlSettings customHtmlSettings)

public void setDailyBackupDateFormatPattern (String dailyBackupDateFormatPattern)

public void setDailyBackupFilePrefix (String dailyBackupFilePrefix)

public void setDefaultEncoding (String defaultEncoding)

public void setDefaultPersonalSpaceHomepageContent (String defaultPersonalSpaceHomepageContent)

public void setDefaultSpaceHomepageContent (String defaultSpaceHomepageContent)

public void setDefaultSpaceHomepageTitle (String defaultSpaceHomepageTitle)

public void setDenyPublicSignup (boolean denyPublicSignup)

public void setDisableLogo (boolean disableLogo)

@Deprecated public void setDisplayLinkIcons (boolean displayLinkIcons)

This method is deprecated.
since 4.0

public void setDraftSaveInterval (int draftSaveInterval)

public void setEmailAddressVisibility (String emailAddressVisibility)

public void setEmailAdminMessageOff (boolean emailAdminMessageOff)

public void setEnableDidYouMean (boolean enableDidYouMean)

public void setEnableJavascriptTop (boolean enableJavascriptTop)

public void setEnableOpenSearch (boolean enableOpenSearch)

public void setEnableQuickNav (boolean enableQuickNav)

public void setEnableSpaceStyles (boolean enableSpaceStyles)

@Deprecated public void setEnableWysiwyg (boolean enableWysiwyg)

This method is deprecated.
since 4.0

You can no longer disable wysiwyg mode in 4.0

public void setExternalUserManagement (boolean externalUserManagement)

public void setGlobalDefaultLocale (String localeString)

public void setGzippingResponse (boolean gzippingResponse)

public void setIndexingLanguage (String indexingLanguage)

public void setLoginManagerSettings (LoginManagerSettings loginManagerSettings)

public void setMaxAttachmentsInUI (int maxAttachmentsInUI)

public void setMaxRssItems (int maxRssItems)

public void setMaxSimultaneousQuickNavRequests (int maxSimultaneousQuickNavRequests)

@Deprecated public void setMaxThumbHeight (int maxThumbHeight)

This method is deprecated.
since 4.0

You can no longer edit thumbnail sizes

@Deprecated public void setMaxThumbWidth (int maxThumbWidth)

This method is deprecated.
since 4.0

You can no longer edit thumbnail sizes

public void setNofollowExternalLinks (boolean nofollowExternalLinks)

@Deprecated public void setNumberOfBreadcrumbAncestors (int numberOfBreadcrumbAncestors)

This method is deprecated.
since 4.0

You can no longer conifgure the breadcrumb ancestors in 4.0

public void setPageTimeout (int pageTimeout)

public void setReferrerSettings (ReferrerSettings referrerSettings)

public void setRssTimeout (int rssTimeout)

public void setSenMissingInLicenseMessageOff (boolean senMissingInLicenseMessageOff)

public void setSharedMode (boolean sharedMode)

public void setShowContactAdministratorsForm (boolean showContactAdministratorsForm)

public void setShowSystemInfoIn500Page (boolean showSystemInfoIn500Page)

public void setSiteHomePage (String siteHomePage)

public void setSiteTitle (String siteTitle)

public void setSiteWelcomeMessage (String siteWelcomeMessage)

public void setSupportRequestEmail (String supportRequestEmail)

Parameters
supportRequestEmail the default e-mail address that support requests will be sent to.

@Deprecated public void setUseWysiwygByDefault (boolean useWysiwygByDefault)

This method is deprecated.
since 4.0

You can no longer disable wysiwyg mode in 4.0

public void setViewSpaceGoesToSpaceSummary (boolean viewSpaceGoesToSpaceSummary)

public void setWebSudoEnabled (boolean webSudoEnabled)

public void setWebSudoTimeout (long webSudoTimeout)

public void setWebdavPassword (String webdavPassword)

public void setWebdavServerUrl (String webdavServerUrl)

public void setWebdavUsername (String webdavUsername)

public void setXsrfAddComments (boolean xsrfAddComments)

public static Settings unsavableSettings ()

Instantiate a settings object that will be ignored by the settings manager if you attempt to save it. This method was introduced to work around CONF-15646 and SHOULD NOT be used for anything else.

Returns
  • a new settings object that cannot be saved