Class Settings
java.lang.Object
com.atlassian.confluence.setup.settings.Settings
- All Implemented Interfaces:
Serializable
- See Also:
-
Field Summary
FieldsModifier 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 Summary
Constructors -
Method Summary
Modifier 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:
-
ENGLISH
Deprecated.since 6.9.0- See Also:
-
GERMAN
Deprecated.deprecated since 6.9.0- See Also:
-
RUSSIAN
Deprecated.since 6.9.0- See Also:
-
CJK
Deprecated.since 6.9.0- See Also:
-
CUSTOM_JAPANESE
Deprecated.since 6.9.0- See Also:
-
CHINESE
Deprecated.since 6.9.0- See Also:
-
FRENCH
Deprecated.since 6.9.0- See Also:
-
GREEK
Deprecated.since 6.9.0- See Also:
-
BRAZILIAN
Deprecated.since 6.9.0- See Also:
-
CZECH
Deprecated.since 6.9.0- See Also:
-
LOCALE_ENGLISH
- See Also:
-
LOCALE_GERMAN
- See Also:
-
LOCALE_RUSSIAN
- See Also:
-
LOCALE_JAPANESE
- See Also:
-
-
Constructor Details
-
Settings
public Settings() -
Settings
-
-
Method Details
-
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
-
getConfluenceHttpParameters
-
setConfluenceHttpParameters
-
isAllowCamelCase
public boolean isAllowCamelCase() -
setAllowCamelCase
public void setAllowCamelCase(boolean allowCamelCase) -
isAllowTrackbacks
Deprecated.since 7.0.1, it will be removed by this ticket: https://jira.atlassian.com/browse/CONFSRVDEV-10243 -
setAllowTrackbacks
Deprecated.since 7.0.1, it will be removed by this ticket: https://jira.atlassian.com/browse/CONFSRVDEV-10243 -
isAllowThreadedComments
public boolean isAllowThreadedComments() -
setAllowThreadedComments
public void setAllowThreadedComments(boolean allowThreadedComments) -
setViewSpaceGoesToSpaceSummary
Deprecated.since 5.0You can no longer go to Space Summary -
isExternalUserManagement
public boolean isExternalUserManagement() -
setExternalUserManagement
public void setExternalUserManagement(boolean externalUserManagement) -
isDenyPublicSignup
public boolean isDenyPublicSignup() -
setDenyPublicSignup
public void setDenyPublicSignup(boolean denyPublicSignup) -
getReferrerSettings
Deprecated.since 7.0.1, it will be removed by: https://jira.atlassian.com/browse/CONFSRVDEV-10243 -
setReferrerSettings
Deprecated.since 7.0.1, it will be removed by: https://jira.atlassian.com/browse/CONFSRVDEV-10243 -
getCaptchaSettings
-
setCaptchaSettings
-
getSiteHomePage
-
setSiteHomePage
-
getSiteWelcomeMessage
Deprecated.since 5.0 The welcome message is now a system template. UseWelcomeMessageService -
setSiteWelcomeMessage
Deprecated.since 5.0 The welcome message is now a system template -
getCustomContactMessage
-
setCustomContactMessage
-
isShowContactAdministratorsForm
public boolean isShowContactAdministratorsForm() -
setShowContactAdministratorsForm
public void setShowContactAdministratorsForm(boolean showContactAdministratorsForm) -
getEmailAddressVisibility
-
setEmailAddressVisibility
-
areEmailAddressesPrivate
public boolean areEmailAddressesPrivate() -
getAttachmentMaxSize
public long getAttachmentMaxSize() -
setAttachmentMaxSize
public void setAttachmentMaxSize(long attachmentMaxSize) -
getDefaultEncoding
-
setDefaultEncoding
-
getMaxThumbHeight
public int getMaxThumbHeight() -
getMaxThumbWidth
public int getMaxThumbWidth() -
getMaxThumbDimensions
Deprecated.since 7.20 usegetMaxThumbnailDimensions() -
getMaxThumbnailDimensions
-
isBackupAttachmentsDaily
public boolean isBackupAttachmentsDaily() -
setBackupAttachmentsDaily
public void setBackupAttachmentsDaily(boolean backupAttachmentsDaily) -
getIndexingLanguage
-
setIndexingLanguage
-
getGlobalDefaultLocale
-
setGlobalDefaultLocale
-
isEmailAdminMessageOff
public boolean isEmailAdminMessageOff()- Returns:
- boolean saying whether or not to display reminder for admin to configure email servers
-
setEmailAdminMessageOff
public void setEmailAdminMessageOff(boolean emailAdminMessageOff) -
isBaseUrlAdminMessageOff
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
-
setBaseUrlAdminMessageOff
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
-
isMaintenanceBannerMessageOn
public boolean isMaintenanceBannerMessageOn()- Returns:
- boolean saying whether or not to display the banner message
- Since:
- 6.8.0
-
setMaintenanceBannerMessageOn
public void setMaintenanceBannerMessageOn(boolean maintenanceBannerMessageOn) - Parameters:
maintenanceBannerMessageOn- boolean sying whether or not to display the banner message- Since:
- 6.8.0
-
isAlmostSupportPeriodEndMessageOff
public boolean isAlmostSupportPeriodEndMessageOff()- Returns:
- boolean saying whether or not to display reminder for support period expiration
-
setAlmostSupportPeriodEndMessageOff
public void setAlmostSupportPeriodEndMessageOff(boolean almostSupportPeriodEndMessageOff) - Parameters:
almostSupportPeriodEndMessageOff- saying whether or not to display reminder for support period expiration
-
isAllowRemoteApi
public boolean isAllowRemoteApi() -
setAllowRemoteApi
public void setAllowRemoteApi(boolean allowRemoteApi) -
isAllowRemoteApiAnonymous
public boolean isAllowRemoteApiAnonymous() -
setAllowRemoteApiAnonymous
public void setAllowRemoteApiAnonymous(boolean allowRemoteApiAnonymous) -
getMaxAttachmentsInUI
public int getMaxAttachmentsInUI() -
setMaxAttachmentsInUI
public void setMaxAttachmentsInUI(int maxAttachmentsInUI) -
isGzippingResponse
public boolean isGzippingResponse() -
setGzippingResponse
public void setGzippingResponse(boolean gzippingResponse) -
setNofollowExternalLinks
public void setNofollowExternalLinks(boolean nofollowExternalLinks) -
isNofollowExternalLinks
public boolean isNofollowExternalLinks() -
getDailyBackupFilePrefix
-
setDailyBackupFilePrefix
-
getDailyBackupDateFormatPattern
-
setDailyBackupDateFormatPattern
-
getSiteTitle
-
setSiteTitle
-
setMaxThumbHeight
Deprecated.since 4.0You can no longer edit thumbnail sizes -
setMaxThumbWidth
Deprecated.since 4.0You can no longer edit thumbnail sizes -
setEnableWysiwyg
Deprecated.since 4.0You can no longer disable wysiwyg mode in 4.0 -
setUseWysiwygByDefault
Deprecated.since 4.0You can no longer disable wysiwyg mode in 4.0 -
setNumberOfBreadcrumbAncestors
Deprecated.since 4.0You can no longer conifgure the breadcrumb ancestors in 4.0 -
isDisableLogo
public boolean isDisableLogo() -
setDisableLogo
public void setDisableLogo(boolean disableLogo) -
showApplicationTitle
public boolean showApplicationTitle() -
setShowApplicationTitle
public void setShowApplicationTitle(boolean showApplicationTitle) -
getDraftSaveInterval
public int getDraftSaveInterval() -
setDraftSaveInterval
public void setDraftSaveInterval(int draftSaveInterval) -
getCustomHtmlSettings
-
setCustomHtmlSettings
-
getColourSchemesSettings
-
setColourSchemesSettings
-
getTimeZone
Deprecated.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
-
getDefaultSpaceHomepageContent
Deprecated.since 5.0 because default space homepage content is now fetched from a global template -
setDefaultSpaceHomepageContent
Deprecated.since 5.0 because default space homepage content is now fetched from a global template -
getBaseUrl
-
setBaseUrl
-
getAttachmentDataStore
-
setAttachmentDataStore
-
setWebdavServerUrl
Deprecated.since 5.8 - WebDAV attachment storage functionality removed -
setWebdavUsername
Deprecated.since 5.8 - WebDAV attachment storage functionality removed -
setWebdavPassword
Deprecated.since 5.8 - WebDAV attachment storage functionality removed -
isAntiXssMode
public boolean isAntiXssMode() -
setAntiXssMode
Deprecated.since 5.10, turning off antixss mode is not supported -
getDefaultPersonalSpaceHomepageContent
Deprecated.since 5.0 because default space homepage content is now fetched from a global template -
setDisplayLinkIcons
Deprecated.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.
-
setEnableDidYouMean
Deprecated.since 5.2 because we don't use did you mean anymore -
isEnableSpaceStyles
public boolean isEnableSpaceStyles() -
setEnableSpaceStyles
public void setEnableSpaceStyles(boolean enableSpaceStyles) -
isEnableOpenSearch
public boolean isEnableOpenSearch() -
setEnableOpenSearch
public void setEnableOpenSearch(boolean enableOpenSearch) -
setEnableJavascriptTop
Deprecated.since 5.0. We always serve javascript at the top. -
getMaxRssItems
public int getMaxRssItems() -
setMaxRssItems
public void setMaxRssItems(int maxRssItems) -
getRssTimeout
public int getRssTimeout() -
setRssTimeout
public void setRssTimeout(int rssTimeout) -
getPageTimeout
public int getPageTimeout() -
setPageTimeout
public void setPageTimeout(int pageTimeout) -
isBackupDaily
public boolean isBackupDaily() -
setBackupDaily
Deprecated.since 6.11This option could not be changed via UI, so it should not be used at all- Parameters:
backupDaily-
-
getBackupPath
-
setBackupPath
-
isAddWildcardsToUserAndGroupSearches
public boolean isAddWildcardsToUserAndGroupSearches() -
setAddWildcardsToUserAndGroupSearches
public void setAddWildcardsToUserAndGroupSearches(boolean addWildcardsToUserAndGroupSearches) -
isSaveable
public boolean isSaveable() -
isSenMissingInLicenseMessageOff
public boolean isSenMissingInLicenseMessageOff() -
setSenMissingInLicenseMessageOff
public void setSenMissingInLicenseMessageOff(boolean senMissingInLicenseMessageOff) -
isShowSystemInfoIn500Page
public boolean isShowSystemInfoIn500Page() -
setShowSystemInfoIn500Page
public void setShowSystemInfoIn500Page(boolean showSystemInfoIn500Page) -
getLoginManagerSettings
-
setLoginManagerSettings
-
isXsrfAddComments
public boolean isXsrfAddComments() -
setXsrfAddComments
public void setXsrfAddComments(boolean xsrfAddComments) -
getWebSudoTimeout
public long getWebSudoTimeout() -
setWebSudoTimeout
public void setWebSudoTimeout(long webSudoTimeout) -
getWebSudoEnabled
public boolean getWebSudoEnabled() -
setWebSudoEnabled
public void setWebSudoEnabled(boolean webSudoEnabled) -
getIgnoredAdminTasks
-
setIgnoredAdminTasks
-
getDefaultTimezoneId
- Since:
- 5.7
-
setDefaultTimezoneId
- Since:
- 5.7
-
getDefaultUsersGroup
-
setDefaultUsersGroup
-
getAttachmentSecurityLevel
-
setAttachmentSecurityLevel
-
getAuditLogRetentionNumber
public int getAuditLogRetentionNumber() -
setAuditLogRetentionNumber
public 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
-