Class Settings
java.lang.Object
com.atlassian.confluence.setup.settings.Settings
- All Implemented Interfaces:
- Serializable
- See Also:
- 
Field SummaryFieldsModifier and TypeFieldDescriptionstatic final StringDeprecated.since 6.9.0static final StringDeprecated.since 6.9.0static final StringDeprecated.since 6.9.0static final StringDeprecated.since 6.9.0static final StringDeprecated.since 6.9.0static final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final StringDeprecated.since 6.9.0static final Stringstatic final StringDeprecated.since 6.9.0static final StringDeprecated.static final StringDeprecated.since 6.9.0static final Stringstatic final Stringstatic final Stringstatic final Stringstatic final StringDeprecated.since 6.9.0
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionbooleanlongintDeprecated.since 5.0 because default space homepage content is now fetched from a global templateDeprecated.since 5.0 because default space homepage content is now fetched from a global templateintintintintDeprecated.since 7.20 usegetMaxThumbnailDimensions()intintintDeprecated.since 7.0.1, it will be removed by: https://jira.atlassian.com/browse/CONFSRVDEV-10243intDeprecated.since 5.0 The welcome message is now a system template.Deprecated.since 5.7.booleanlongbooleanbooleanbooleanbooleanbooleanbooleanDeprecated.since 7.0.1, it will be removed by this ticket: https://jira.atlassian.com/browse/CONFSRVDEV-10243booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanvoidsetAddWildcardsToUserAndGroupSearches(boolean addWildcardsToUserAndGroupSearches) voidsetAllowCamelCase(boolean allowCamelCase) voidsetAllowRemoteApi(boolean allowRemoteApi) voidsetAllowRemoteApiAnonymous(boolean allowRemoteApiAnonymous) voidsetAllowThreadedComments(boolean allowThreadedComments) voidsetAllowTrackbacks(boolean allowTrackbacks) Deprecated.since 7.0.1, it will be removed by this ticket: https://jira.atlassian.com/browse/CONFSRVDEV-10243voidsetAlmostSupportPeriodEndMessageOff(boolean almostSupportPeriodEndMessageOff) voidsetAntiXssMode(boolean antiXssMode) Deprecated.since 5.10, turning off antixss mode is not supportedvoidsetAttachmentDataStore(String attachmentDataStore) voidsetAttachmentMaxSize(long attachmentMaxSize) voidsetAttachmentSecurityLevel(AttachmentSecurityLevel attachmentSecurityLevel) voidsetAuditLogRetentionNumber(int auditLogRetentionNumber) voidsetAuditLogRetentionUnit(String auditLogRetentionUnit) voidsetBackupAttachmentsDaily(boolean backupAttachmentsDaily) voidsetBackupDaily(boolean backupDaily) Deprecated.since 6.11voidsetBackupPath(String backupPath) voidsetBaseUrl(String baseUrl) voidsetBaseUrlAdminMessageOff(boolean baseUrlAdminMessageOff) voidsetCaptchaSettings(CaptchaSettings captchaSettings) voidsetColourSchemesSettings(ColourSchemesSettings colourSchemesSettings) voidsetConfluenceHttpParameters(ConfluenceHttpParameters confluenceHttpParameters) voidsetCustomContactMessage(String customErrorMessage) voidsetCustomHtmlSettings(CustomHtmlSettings customHtmlSettings) voidsetDailyBackupDateFormatPattern(String dailyBackupDateFormatPattern) voidsetDailyBackupFilePrefix(String dailyBackupFilePrefix) voidsetDefaultEncoding(String defaultEncoding) voidsetDefaultPersonalSpaceHomepageContent(String defaultPersonalSpaceHomepageContent) Deprecated.since 5.0 because default space homepage content is now fetched from a global templatevoidsetDefaultSpaceHomepageContent(String defaultSpaceHomepageContent) Deprecated.since 5.0 because default space homepage content is now fetched from a global templatevoidsetDefaultSpaceHomepageTitle(String defaultSpaceHomepageTitle) voidsetDefaultTimezoneId(String defaultTimezoneId) voidsetDefaultUsersGroup(String defaultUsersGroup) voidsetDenyPublicSignup(boolean denyPublicSignup) voidsetDisableLogo(boolean disableLogo) voidsetDisplayLinkIcons(boolean displayLinkIcons) Deprecated.since 4.0voidsetDraftSaveInterval(int draftSaveInterval) voidsetEmailAddressVisibility(String emailAddressVisibility) voidsetEmailAdminMessageOff(boolean emailAdminMessageOff) voidsetEnableDidYouMean(boolean enableDidYouMean) Deprecated.since 5.2 because we don't use did you mean anymorevoidsetEnableJavascriptTop(boolean enableJavascriptTop) Deprecated.since 5.0.voidsetEnableOpenSearch(boolean enableOpenSearch) voidsetEnableQuickNav(boolean enableQuickNav) voidsetEnableSpaceStyles(boolean enableSpaceStyles) voidsetEnableWysiwyg(boolean enableWysiwyg) Deprecated.since 4.0voidsetExternalUserManagement(boolean externalUserManagement) voidsetGlobalDefaultLocale(String localeString) voidsetGzippingResponse(boolean gzippingResponse) voidsetIgnoredAdminTasks(String ignoredAdminTasks) voidsetIndexingLanguage(String indexingLanguage) voidsetLoginManagerSettings(LoginManagerSettings loginManagerSettings) voidsetMaintenanceBannerMessage(String maintenanceBannerMessage) voidsetMaintenanceBannerMessageOn(boolean maintenanceBannerMessageOn) voidsetMaxAttachmentsInUI(int maxAttachmentsInUI) voidsetMaxRssItems(int maxRssItems) voidsetMaxSimultaneousQuickNavRequests(int maxSimultaneousQuickNavRequests) voidsetMaxThumbHeight(int maxThumbHeight) Deprecated.since 4.0voidsetMaxThumbWidth(int maxThumbWidth) Deprecated.since 4.0voidsetNofollowExternalLinks(boolean nofollowExternalLinks) voidsetNumberOfBreadcrumbAncestors(int numberOfBreadcrumbAncestors) Deprecated.since 4.0voidsetPageTimeout(int pageTimeout) voidsetReferrerSettings(ReferrerSettings referrerSettings) Deprecated.since 7.0.1, it will be removed by: https://jira.atlassian.com/browse/CONFSRVDEV-10243voidsetRssTimeout(int rssTimeout) voidsetSenMissingInLicenseMessageOff(boolean senMissingInLicenseMessageOff) voidsetSharedMode(boolean sharedMode) Deprecated.since 5.1.voidsetShowApplicationTitle(boolean showApplicationTitle) voidsetShowContactAdministratorsForm(boolean showContactAdministratorsForm) voidsetShowSystemInfoIn500Page(boolean showSystemInfoIn500Page) voidsetSiteHomePage(String siteHomePage) voidsetSiteTitle(String siteTitle) voidsetSiteWelcomeMessage(String siteWelcomeMessage) Deprecated.since 5.0 The welcome message is now a system templatevoidsetSupportRequestEmail(String supportRequestEmail) voidsetUseWysiwygByDefault(boolean useWysiwygByDefault) Deprecated.since 4.0voidsetViewSpaceGoesToSpaceSummary(boolean viewSpaceGoesToSpaceSummary) Deprecated.since 5.0voidsetWebdavPassword(String webdavPassword) Deprecated.since 5.8 - WebDAV attachment storage functionality removedvoidsetWebdavServerUrl(String webdavServerUrl) Deprecated.since 5.8 - WebDAV attachment storage functionality removedvoidsetWebdavUsername(String webdavUsername) Deprecated.since 5.8 - WebDAV attachment storage functionality removedvoidsetWebSudoEnabled(boolean webSudoEnabled) voidsetWebSudoTimeout(long webSudoTimeout) voidsetXsrfAddComments(boolean xsrfAddComments) booleanstatic SettingsInstantiate a settings object that will be ignored by the settings manager if you attempt to save it.
- 
Field Details- 
DEFAULT_SITE_TITLE- See Also:
 
- 
FALLBACK_DEFAULT_USERS_GROUP- See Also:
 
- 
DEFAULT_USERS_GROUP_ENV_VAR_KEY- See Also:
 
- 
DEFAULT_DEFAULT_ENCODING- See Also:
 
- 
EMAIL_ADDRESS_PUBLIC- See Also:
 
- 
EMAIL_ADDRESS_MASKED- See Also:
 
- 
EMAIL_ADDRESS_PRIVATE- See Also:
 
- 
EMAIL_FROMNAME_DEFAULT- See Also:
 
- 
DAILY_BACKUP_DIRECTORY- See Also:
 
- 
ENGLISHDeprecated.since 6.9.0- See Also:
 
- 
GERMANDeprecated.deprecated since 6.9.0- See Also:
 
- 
RUSSIANDeprecated.since 6.9.0- See Also:
 
- 
CJKDeprecated.since 6.9.0- See Also:
 
- 
CUSTOM_JAPANESEDeprecated.since 6.9.0- See Also:
 
- 
CHINESEDeprecated.since 6.9.0- See Also:
 
- 
FRENCHDeprecated.since 6.9.0- See Also:
 
- 
GREEKDeprecated.since 6.9.0- See Also:
 
- 
BRAZILIANDeprecated.since 6.9.0- See Also:
 
- 
CZECHDeprecated.since 6.9.0- See Also:
 
- 
LOCALE_ENGLISH- See Also:
 
- 
LOCALE_GERMAN- See Also:
 
- 
LOCALE_RUSSIAN- See Also:
 
- 
LOCALE_JAPANESE- See Also:
 
 
- 
- 
Constructor Details- 
Settingspublic Settings()
- 
Settings
 
- 
- 
Method Details- 
unsavableSettingsInstantiate 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
 
- 
getConfluenceHttpParameters
- 
setConfluenceHttpParameters
- 
isAllowCamelCasepublic boolean isAllowCamelCase()
- 
setAllowCamelCasepublic void setAllowCamelCase(boolean allowCamelCase) 
- 
isAllowTrackbacksDeprecated.since 7.0.1, it will be removed by this ticket: https://jira.atlassian.com/browse/CONFSRVDEV-10243
- 
setAllowTrackbacksDeprecated.since 7.0.1, it will be removed by this ticket: https://jira.atlassian.com/browse/CONFSRVDEV-10243
- 
isAllowThreadedCommentspublic boolean isAllowThreadedComments()
- 
setAllowThreadedCommentspublic void setAllowThreadedComments(boolean allowThreadedComments) 
- 
setViewSpaceGoesToSpaceSummaryDeprecated.since 5.0You can no longer go to Space Summary
- 
isExternalUserManagementpublic boolean isExternalUserManagement()
- 
setExternalUserManagementpublic void setExternalUserManagement(boolean externalUserManagement) 
- 
isDenyPublicSignuppublic boolean isDenyPublicSignup()
- 
setDenyPublicSignuppublic void setDenyPublicSignup(boolean denyPublicSignup) 
- 
getReferrerSettingsDeprecated.since 7.0.1, it will be removed by: https://jira.atlassian.com/browse/CONFSRVDEV-10243
- 
setReferrerSettingsDeprecated.since 7.0.1, it will be removed by: https://jira.atlassian.com/browse/CONFSRVDEV-10243
- 
getCaptchaSettings
- 
setCaptchaSettings
- 
getSiteHomePage
- 
setSiteHomePage
- 
getSiteWelcomeMessageDeprecated.since 5.0 The welcome message is now a system template. UseWelcomeMessageService
- 
setSiteWelcomeMessageDeprecated.since 5.0 The welcome message is now a system template
- 
getCustomContactMessage
- 
setCustomContactMessage
- 
isShowContactAdministratorsFormpublic boolean isShowContactAdministratorsForm()
- 
setShowContactAdministratorsFormpublic void setShowContactAdministratorsForm(boolean showContactAdministratorsForm) 
- 
getEmailAddressVisibility
- 
setEmailAddressVisibility
- 
areEmailAddressesPrivatepublic boolean areEmailAddressesPrivate()
- 
getAttachmentMaxSizepublic long getAttachmentMaxSize()
- 
setAttachmentMaxSizepublic void setAttachmentMaxSize(long attachmentMaxSize) 
- 
getDefaultEncoding
- 
setDefaultEncoding
- 
getMaxThumbHeightpublic int getMaxThumbHeight()
- 
getMaxThumbWidthpublic int getMaxThumbWidth()
- 
getMaxThumbDimensionsDeprecated.since 7.20 usegetMaxThumbnailDimensions()
- 
getMaxThumbnailDimensions
- 
isBackupAttachmentsDailypublic boolean isBackupAttachmentsDaily()
- 
setBackupAttachmentsDailypublic void setBackupAttachmentsDaily(boolean backupAttachmentsDaily) 
- 
getIndexingLanguage
- 
setIndexingLanguage
- 
getGlobalDefaultLocale
- 
setGlobalDefaultLocale
- 
isEmailAdminMessageOffpublic boolean isEmailAdminMessageOff()- Returns:
- boolean saying whether or not to display reminder for admin to configure email servers
 
- 
setEmailAdminMessageOffpublic void setEmailAdminMessageOff(boolean emailAdminMessageOff) 
- 
isBaseUrlAdminMessageOffpublic 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
 
- 
setBaseUrlAdminMessageOffpublic 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
 
- 
isMaintenanceBannerMessageOnpublic boolean isMaintenanceBannerMessageOn()- Returns:
- boolean saying whether or not to display the banner message
- Since:
- 6.8.0
 
- 
setMaintenanceBannerMessageOnpublic void setMaintenanceBannerMessageOn(boolean maintenanceBannerMessageOn) - Parameters:
- maintenanceBannerMessageOn- boolean sying whether or not to display the banner message
- Since:
- 6.8.0
 
- 
isAlmostSupportPeriodEndMessageOffpublic boolean isAlmostSupportPeriodEndMessageOff()- Returns:
- boolean saying whether or not to display reminder for support period expiration
 
- 
setAlmostSupportPeriodEndMessageOffpublic void setAlmostSupportPeriodEndMessageOff(boolean almostSupportPeriodEndMessageOff) - Parameters:
- almostSupportPeriodEndMessageOff- saying whether or not to display reminder for support period expiration
 
- 
isAllowRemoteApipublic boolean isAllowRemoteApi()
- 
setAllowRemoteApipublic void setAllowRemoteApi(boolean allowRemoteApi) 
- 
isAllowRemoteApiAnonymouspublic boolean isAllowRemoteApiAnonymous()
- 
setAllowRemoteApiAnonymouspublic void setAllowRemoteApiAnonymous(boolean allowRemoteApiAnonymous) 
- 
getMaxAttachmentsInUIpublic int getMaxAttachmentsInUI()
- 
setMaxAttachmentsInUIpublic void setMaxAttachmentsInUI(int maxAttachmentsInUI) 
- 
isGzippingResponsepublic boolean isGzippingResponse()
- 
setGzippingResponsepublic void setGzippingResponse(boolean gzippingResponse) 
- 
setNofollowExternalLinkspublic void setNofollowExternalLinks(boolean nofollowExternalLinks) 
- 
isNofollowExternalLinkspublic boolean isNofollowExternalLinks()
- 
getDailyBackupFilePrefix
- 
setDailyBackupFilePrefix
- 
getDailyBackupDateFormatPattern
- 
setDailyBackupDateFormatPattern
- 
getSiteTitle
- 
setSiteTitle
- 
setMaxThumbHeightDeprecated.since 4.0You can no longer edit thumbnail sizes
- 
setMaxThumbWidthDeprecated.since 4.0You can no longer edit thumbnail sizes
- 
setEnableWysiwygDeprecated.since 4.0You can no longer disable wysiwyg mode in 4.0
- 
setUseWysiwygByDefaultDeprecated.since 4.0You can no longer disable wysiwyg mode in 4.0
- 
setNumberOfBreadcrumbAncestorsDeprecated.since 4.0You can no longer conifgure the breadcrumb ancestors in 4.0
- 
isDisableLogopublic boolean isDisableLogo()
- 
setDisableLogopublic void setDisableLogo(boolean disableLogo) 
- 
showApplicationTitlepublic boolean showApplicationTitle()
- 
setShowApplicationTitlepublic void setShowApplicationTitle(boolean showApplicationTitle) 
- 
getDraftSaveIntervalpublic int getDraftSaveInterval()
- 
setDraftSaveIntervalpublic void setDraftSaveInterval(int draftSaveInterval) 
- 
getCustomHtmlSettings
- 
setCustomHtmlSettings
- 
getColourSchemesSettings
- 
setColourSchemesSettings
- 
getTimeZoneDeprecated.since 5.7. Do not use this method, useTimeZoneManager.getDefaultTimeZone()- Returns:
- the tenant'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.
 
- 
getDefaultSpaceHomepageTitle
- 
setDefaultSpaceHomepageTitle
- 
getDefaultSpaceHomepageContentDeprecated.since 5.0 because default space homepage content is now fetched from a global template
- 
setDefaultSpaceHomepageContentDeprecated.since 5.0 because default space homepage content is now fetched from a global template
- 
getBaseUrl
- 
setBaseUrl
- 
getAttachmentDataStore
- 
setAttachmentDataStore
- 
setWebdavServerUrlDeprecated.since 5.8 - WebDAV attachment storage functionality removed
- 
setWebdavUsernameDeprecated.since 5.8 - WebDAV attachment storage functionality removed
- 
setWebdavPasswordDeprecated.since 5.8 - WebDAV attachment storage functionality removed
- 
isAntiXssModepublic boolean isAntiXssMode()
- 
setAntiXssModeDeprecated.since 5.10, turning off antixss mode is not supported
- 
getDefaultPersonalSpaceHomepageContentDeprecated.since 5.0 because default space homepage content is now fetched from a global template
- 
setDisplayLinkIconsDeprecated.since 4.0
- 
setDefaultPersonalSpaceHomepageContent@Deprecated public void setDefaultPersonalSpaceHomepageContent(String defaultPersonalSpaceHomepageContent) Deprecated.since 5.0 because default space homepage content is now fetched from a global template
- 
getSupportRequestEmail- Returns:
- the default e-mail address that support requests will be sent to.
 
- 
setSupportRequestEmail- Parameters:
- supportRequestEmail- the default e-mail address that support requests will be sent to.
 
- 
setEnableDidYouMeanDeprecated.since 5.2 because we don't use did you mean anymore
- 
isEnableSpaceStylespublic boolean isEnableSpaceStyles()
- 
setEnableSpaceStylespublic void setEnableSpaceStyles(boolean enableSpaceStyles) 
- 
isEnableOpenSearchpublic boolean isEnableOpenSearch()
- 
setEnableOpenSearchpublic void setEnableOpenSearch(boolean enableOpenSearch) 
- 
setEnableJavascriptTopDeprecated.since 5.0. We always serve javascript at the top.
- 
getMaxRssItemspublic int getMaxRssItems()
- 
setMaxRssItemspublic void setMaxRssItems(int maxRssItems) 
- 
getRssTimeoutpublic int getRssTimeout()
- 
setRssTimeoutpublic void setRssTimeout(int rssTimeout) 
- 
getPageTimeoutpublic int getPageTimeout()
- 
setPageTimeoutpublic void setPageTimeout(int pageTimeout) 
- 
isBackupDailypublic boolean isBackupDaily()
- 
setBackupDailyDeprecated.since 6.11This option could not be changed via UI, so it should not be used at all- Parameters:
- backupDaily-
 
- 
getBackupPath
- 
setBackupPath
- 
isAddWildcardsToUserAndGroupSearchespublic boolean isAddWildcardsToUserAndGroupSearches()
- 
setAddWildcardsToUserAndGroupSearchespublic void setAddWildcardsToUserAndGroupSearches(boolean addWildcardsToUserAndGroupSearches) 
- 
isSaveablepublic boolean isSaveable()
- 
isSenMissingInLicenseMessageOffpublic boolean isSenMissingInLicenseMessageOff()
- 
setSenMissingInLicenseMessageOffpublic void setSenMissingInLicenseMessageOff(boolean senMissingInLicenseMessageOff) 
- 
isShowSystemInfoIn500Pagepublic boolean isShowSystemInfoIn500Page()
- 
setShowSystemInfoIn500Pagepublic void setShowSystemInfoIn500Page(boolean showSystemInfoIn500Page) 
- 
getLoginManagerSettings
- 
setLoginManagerSettings
- 
isXsrfAddCommentspublic boolean isXsrfAddComments()
- 
setXsrfAddCommentspublic void setXsrfAddComments(boolean xsrfAddComments) 
- 
getWebSudoTimeoutpublic long getWebSudoTimeout()
- 
setWebSudoTimeoutpublic void setWebSudoTimeout(long webSudoTimeout) 
- 
getWebSudoEnabledpublic boolean getWebSudoEnabled()
- 
setWebSudoEnabledpublic void setWebSudoEnabled(boolean webSudoEnabled) 
- 
getIgnoredAdminTasks
- 
setIgnoredAdminTasks
- 
getDefaultTimezoneId- Since:
- 5.7
 
- 
setDefaultTimezoneId- Since:
- 5.7
 
- 
getDefaultUsersGroup
- 
setDefaultUsersGroup
- 
getAttachmentSecurityLevel
- 
setAttachmentSecurityLevel
- 
getAuditLogRetentionNumberpublic int getAuditLogRetentionNumber()
- 
setAuditLogRetentionNumberpublic void setAuditLogRetentionNumber(int auditLogRetentionNumber) 
- 
getAuditLogRetentionUnit
- 
setAuditLogRetentionUnit
- 
getMaintenanceBannerMessage- Returns:
- a string representing the maintenance banner message
- Since:
- 6.8.0
 
- 
setMaintenanceBannerMessage- Parameters:
- maintenanceBannerMessage- the maintenance banner message
- Since:
- 6.8.0
 
 
-