Package com.atlassian.confluence.setup.settings

Class Settings

    • Constructor Detail

      • Settings

        public Settings()

      • Settings

        public Settings​(Settings settings)

    • Method Detail

      • unsavableSettings

        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

      • setConfluenceHttpParameters

        public void setConfluenceHttpParameters​(ConfluenceHttpParameters confluenceHttpParameters)

      • isAllowCamelCase

        public boolean isAllowCamelCase()

      • setAllowCamelCase

        public void setAllowCamelCase​(boolean allowCamelCase)

      • isAllowTrackbacks

        @Deprecated
public boolean isAllowTrackbacks()
        Deprecated.
        since 7.0.1, it will be removed by this ticket: https://jira.atlassian.com/browse/CONFSRVDEV-10243

      • setAllowTrackbacks

        @Deprecated
public void setAllowTrackbacks​(boolean allowTrackbacks)
        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
public void setViewSpaceGoesToSpaceSummary​(boolean viewSpaceGoesToSpaceSummary)
        Deprecated.
        since 5.0
        You 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
public ReferrerSettings getReferrerSettings()
        Deprecated.
        since 7.0.1, it will be removed by: https://jira.atlassian.com/browse/CONFSRVDEV-10243

      • setReferrerSettings

        @Deprecated
public void setReferrerSettings​(ReferrerSettings referrerSettings)
        Deprecated.
        since 7.0.1, it will be removed by: https://jira.atlassian.com/browse/CONFSRVDEV-10243

      • setCaptchaSettings

        public void setCaptchaSettings​(CaptchaSettings captchaSettings)

      • getSiteHomePage

        public String getSiteHomePage()

      • setSiteHomePage

        public void setSiteHomePage​(String siteHomePage)

      • setSiteWelcomeMessage

        @Deprecated
public void setSiteWelcomeMessage​(String siteWelcomeMessage)
        Deprecated.
        since 5.0 The welcome message is now a system template

      • getCustomContactMessage

        public String getCustomContactMessage()

      • setCustomContactMessage

        public void setCustomContactMessage​(String customErrorMessage)

      • isShowContactAdministratorsForm

        public boolean isShowContactAdministratorsForm()

      • setShowContactAdministratorsForm

        public void setShowContactAdministratorsForm​(boolean showContactAdministratorsForm)

      • getEmailAddressVisibility

        public String getEmailAddressVisibility()

      • setEmailAddressVisibility

        public void setEmailAddressVisibility​(String emailAddressVisibility)

      • areEmailAddressesPrivate

        public boolean areEmailAddressesPrivate()

      • getAttachmentMaxSize

        public long getAttachmentMaxSize()

      • setAttachmentMaxSize

        public void setAttachmentMaxSize​(long attachmentMaxSize)

      • getDefaultEncoding

        public String getDefaultEncoding()

      • setDefaultEncoding

        public void setDefaultEncoding​(String defaultEncoding)

      • getMaxThumbHeight

        public int getMaxThumbHeight()

      • getMaxThumbWidth

        public int getMaxThumbWidth()

      • getMaxThumbnailDimensions

        public ImageDimensions getMaxThumbnailDimensions()

      • isBackupAttachmentsDaily

        public boolean isBackupAttachmentsDaily()

      • setBackupAttachmentsDaily

        public void setBackupAttachmentsDaily​(boolean backupAttachmentsDaily)

      • getIndexingLanguage

        public String getIndexingLanguage()

      • setIndexingLanguage

        public void setIndexingLanguage​(String indexingLanguage)

      • getGlobalDefaultLocale

        public String getGlobalDefaultLocale()

      • setGlobalDefaultLocale

        public void setGlobalDefaultLocale​(String localeString)

      • 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

        public String getDailyBackupFilePrefix()

      • setDailyBackupFilePrefix

        public void setDailyBackupFilePrefix​(String dailyBackupFilePrefix)

      • getDailyBackupDateFormatPattern

        public String getDailyBackupDateFormatPattern()

      • setDailyBackupDateFormatPattern

        public void setDailyBackupDateFormatPattern​(String dailyBackupDateFormatPattern)

      • getSiteTitle

        public String getSiteTitle()

      • setSiteTitle

        public void setSiteTitle​(String siteTitle)

      • setMaxThumbHeight

        @Deprecated
public void setMaxThumbHeight​(int maxThumbHeight)
        Deprecated.
        since 4.0
        You can no longer edit thumbnail sizes

      • setMaxThumbWidth

        @Deprecated
public void setMaxThumbWidth​(int maxThumbWidth)
        Deprecated.
        since 4.0
        You can no longer edit thumbnail sizes

      • setEnableWysiwyg

        @Deprecated
public void setEnableWysiwyg​(boolean enableWysiwyg)
        Deprecated.
        since 4.0
        You can no longer disable wysiwyg mode in 4.0

      • setUseWysiwygByDefault

        @Deprecated
public void setUseWysiwygByDefault​(boolean useWysiwygByDefault)
        Deprecated.
        since 4.0
        You can no longer disable wysiwyg mode in 4.0

      • setNumberOfBreadcrumbAncestors

        @Deprecated
public void setNumberOfBreadcrumbAncestors​(int numberOfBreadcrumbAncestors)
        Deprecated.
        since 4.0
        You 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)

      • setCustomHtmlSettings

        public void setCustomHtmlSettings​(CustomHtmlSettings customHtmlSettings)

      • setColourSchemesSettings

        public void setColourSchemesSettings​(ColourSchemesSettings colourSchemesSettings)

      • getTimeZone

        @Deprecated
public TimeZone getTimeZone()
        Deprecated.
        since 5.7. Do not use this method, use TimeZoneManager.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

        public String getDefaultSpaceHomepageTitle()

      • setDefaultSpaceHomepageTitle

        public void setDefaultSpaceHomepageTitle​(String defaultSpaceHomepageTitle)

      • getDefaultSpaceHomepageContent

        @Deprecated
public String getDefaultSpaceHomepageContent()
        Deprecated.
        since 5.0 because default space homepage content is now fetched from a global template

      • setDefaultSpaceHomepageContent

        @Deprecated
public void setDefaultSpaceHomepageContent​(String defaultSpaceHomepageContent)
        Deprecated.
        since 5.0 because default space homepage content is now fetched from a global template

      • getBaseUrl

        public String getBaseUrl()

      • setBaseUrl

        public void setBaseUrl​(String baseUrl)

      • getAttachmentDataStore

        public String getAttachmentDataStore()

      • setAttachmentDataStore

        public void setAttachmentDataStore​(String attachmentDataStore)

      • setWebdavServerUrl

        @Deprecated
public void setWebdavServerUrl​(String webdavServerUrl)
        Deprecated.
        since 5.8 - WebDAV attachment storage functionality removed

      • setWebdavUsername

        @Deprecated
public void setWebdavUsername​(String webdavUsername)
        Deprecated.
        since 5.8 - WebDAV attachment storage functionality removed

      • setWebdavPassword

        @Deprecated
public void setWebdavPassword​(String webdavPassword)
        Deprecated.
        since 5.8 - WebDAV attachment storage functionality removed

      • isAntiXssMode

        public boolean isAntiXssMode()

      • setAntiXssMode

        @Deprecated
public void setAntiXssMode​(boolean antiXssMode)
        Deprecated.
        since 5.10, turning off antixss mode is not supported

      • setSharedMode

        @Deprecated
public void setSharedMode​(boolean sharedMode)
        Deprecated.
        since 5.1. "Shared mode" no longer supported. Do not use.

      • getDefaultPersonalSpaceHomepageContent

        @Deprecated
public String getDefaultPersonalSpaceHomepageContent()
        Deprecated.
        since 5.0 because default space homepage content is now fetched from a global template

      • setDisplayLinkIcons

        @Deprecated
public void setDisplayLinkIcons​(boolean displayLinkIcons)
        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

        public String getSupportRequestEmail()
        Returns:
        the default e-mail address that support requests will be sent to.

      • setSupportRequestEmail

        public void setSupportRequestEmail​(String supportRequestEmail)
        Parameters:
        supportRequestEmail - the default e-mail address that support requests will be sent to.

      • setEnableDidYouMean

        @Deprecated
public void setEnableDidYouMean​(boolean enableDidYouMean)
        Deprecated.
        since 5.2 because we don't use did you mean anymore

      • isEnableSpaceStyles

        public boolean isEnableSpaceStyles()

      • setEnableSpaceStyles

        public void setEnableSpaceStyles​(boolean enableSpaceStyles)

      • isEnableQuickNav

        public boolean isEnableQuickNav()

      • setEnableQuickNav

        public void setEnableQuickNav​(boolean enableQuickNav)

      • getMaxSimultaneousQuickNavRequests

        public int getMaxSimultaneousQuickNavRequests()

      • setMaxSimultaneousQuickNavRequests

        public void setMaxSimultaneousQuickNavRequests​(int maxSimultaneousQuickNavRequests)

      • isEnableOpenSearch

        public boolean isEnableOpenSearch()

      • setEnableOpenSearch

        public void setEnableOpenSearch​(boolean enableOpenSearch)

      • setEnableJavascriptTop

        @Deprecated
public void setEnableJavascriptTop​(boolean enableJavascriptTop)
        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
public void setBackupDaily​(boolean backupDaily)
        Deprecated.
        since 6.11
        This option could not be changed via UI, so it should not be used at all
        Parameters:
        backupDaily -

      • getBackupPath

        public String getBackupPath()

      • setBackupPath

        public void setBackupPath​(String backupPath)

      • 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)

      • setLoginManagerSettings

        public void setLoginManagerSettings​(LoginManagerSettings loginManagerSettings)

      • 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

        public String getIgnoredAdminTasks()

      • setIgnoredAdminTasks

        public void setIgnoredAdminTasks​(String ignoredAdminTasks)

      • getDefaultTimezoneId

        public String getDefaultTimezoneId()
        Since:
        5.7

      • setDefaultTimezoneId

        public void setDefaultTimezoneId​(String defaultTimezoneId)
        Since:
        5.7

      • getDefaultUsersGroup

        public String getDefaultUsersGroup()

      • setDefaultUsersGroup

        public void setDefaultUsersGroup​(String defaultUsersGroup)

      • setAttachmentSecurityLevel

        public void setAttachmentSecurityLevel​(AttachmentSecurityLevel attachmentSecurityLevel)

      • getAuditLogRetentionNumber

        public int getAuditLogRetentionNumber()

      • setAuditLogRetentionNumber

        public void setAuditLogRetentionNumber​(int auditLogRetentionNumber)

      • getAuditLogRetentionUnit

        public String getAuditLogRetentionUnit()

      • setAuditLogRetentionUnit

        public void setAuditLogRetentionUnit​(String auditLogRetentionUnit)

      • getMaintenanceBannerMessage

        public String getMaintenanceBannerMessage()
        Returns:
        a string representing the maintenance banner message
        Since:
        6.8.0

      • setMaintenanceBannerMessage

        public void setMaintenanceBannerMessage​(String maintenanceBannerMessage)
        Parameters:
        maintenanceBannerMessage - the maintenance banner message
        Since:
        6.8.0