com.atlassian.confluence.setup.settings
Class Settings

java.lang.Object
  com.atlassian.confluence.setup.settings.Settings

All Implemented Interfaces:

Serializable

public class Settings
extends Object
implements Serializable

See Also:

Serialized Form

Field Summary

static String	BRAZILIAN
static String	CHINESE
static String	CJK
static String	CUSTOM_JAPANESE
static String	CZECH
static String	DAILY_BACKUP_DIRECTORY
static String	DEFAULT_DEFAULT_ENCODING
static String	EMAIL_ADDRESS_MASKED
static String	EMAIL_ADDRESS_PRIVATE
static String	EMAIL_ADDRESS_PUBLIC
static String	EMAIL_FROMNAME_DEFAULT
static String	ENGLISH
static String	FRENCH
static String	GERMAN
static String	GREEK
static String	LOCALE_ENGLISH
static String	LOCALE_GERMAN
static String	LOCALE_JAPANESE
static String	LOCALE_RUSSIAN
static String	RUSSIAN

Constructor Summary

Settings()

Settings(Settings settings)

Method Summary

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()
int	getNumberOfBreadcrumbAncestors() Deprecated. since 4.0
ReferrerSettings	getReferrerSettings()
int	getRssTimeout()
String	getSiteHomePage()
String	getSiteTitle()
String	getSiteWelcomeMessage()
String	getSupportRequestEmail()
TimeZone	getTimeZone()
String	getWebdavPassword()
String	getWebdavServerUrl()
String	getWebdavUsername()
boolean	getWebSudoEnabled()
long	getWebSudoTimeout()
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()
boolean	isDisplayLinkIcons() Deprecated. since 4.0
boolean	isEmailAdminMessageOff()
boolean	isEnableDidYouMean()
boolean	isEnableJavascriptTop()
boolean	isEnableOpenSearch()
boolean	isEnableQuickNav()
boolean	isEnableSpaceStyles()
boolean	isEnableWysiwyg() Deprecated. since 4.0
boolean	isExternalUserManagement()
boolean	isGzippingResponse()
boolean	isNofollowExternalLinks()
boolean	isSaveable()
boolean	isSenMissingInLicenseMessageOff()
boolean	isSharedMode()
boolean	isShowContactAdministratorsForm()
boolean	isShowSystemInfoIn500Page()
boolean	isUseWysiwygByDefault() 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)
void	setAnitXssMode(boolean antiXssMode) 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)
void	setDisplayLinkIcons(boolean displayLinkIcons) 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)
void	setEnableWysiwyg(boolean enableWysiwyg) 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)
void	setMaxThumbHeight(int maxThumbHeight) Deprecated. since 4.0
void	setMaxThumbWidth(int maxThumbWidth) Deprecated. since 4.0
void	setNofollowExternalLinks(boolean nofollowExternalLinks)
void	setNumberOfBreadcrumbAncestors(int numberOfBreadcrumbAncestors) Deprecated. since 4.0
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)
void	setUseWysiwygByDefault(boolean useWysiwygByDefault) Deprecated. since 4.0
void	setViewSpaceGoesToSpaceSummary(boolean viewSpaceGoesToSpaceSummary)
void	setWebdavPassword(String webdavPassword)
void	setWebdavServerUrl(String webdavServerUrl)
void	setWebdavUsername(String webdavUsername)
void	setWebSudoEnabled(boolean webSudoEnabled)
void	setWebSudoTimeout(long webSudoTimeout)
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_DEFAULT_ENCODING

public static final String DEFAULT_DEFAULT_ENCODING

See Also:

Constant Field Values

EMAIL_ADDRESS_PUBLIC

public static final String EMAIL_ADDRESS_PUBLIC

See Also:

Constant Field Values

EMAIL_ADDRESS_MASKED

public static final String EMAIL_ADDRESS_MASKED

See Also:

Constant Field Values

EMAIL_ADDRESS_PRIVATE

public static final String EMAIL_ADDRESS_PRIVATE

See Also:

Constant Field Values

EMAIL_FROMNAME_DEFAULT

public static final String EMAIL_FROMNAME_DEFAULT

See Also:

Constant Field Values

DAILY_BACKUP_DIRECTORY

public static final String DAILY_BACKUP_DIRECTORY

See Also:

Constant Field Values

ENGLISH

public static final String ENGLISH

See Also:

Constant Field Values

GERMAN

public static final String GERMAN

See Also:

Constant Field Values

RUSSIAN

public static final String RUSSIAN

See Also:

Constant Field Values

CJK

public static final String CJK

See Also:

Constant Field Values

CUSTOM_JAPANESE

public static final String CUSTOM_JAPANESE

See Also:

Constant Field Values

CHINESE

public static final String CHINESE

See Also:

Constant Field Values

FRENCH

public static final String FRENCH

See Also:

Constant Field Values

GREEK

public static final String GREEK

See Also:

Constant Field Values

BRAZILIAN

public static final String BRAZILIAN

See Also:

Constant Field Values

CZECH

public static final String CZECH

See Also:

Constant Field Values

LOCALE_ENGLISH

public static final String LOCALE_ENGLISH

See Also:

Constant Field Values

LOCALE_GERMAN

public static final String LOCALE_GERMAN

See Also:

Constant Field Values

LOCALE_RUSSIAN

public static final String LOCALE_RUSSIAN

See Also:

Constant Field Values

LOCALE_JAPANESE

public static final String LOCALE_JAPANESE

See Also:

Constant Field Values

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

getConfluenceHttpParameters

public ConfluenceHttpParameters getConfluenceHttpParameters()

setConfluenceHttpParameters

public void setConfluenceHttpParameters(ConfluenceHttpParameters confluenceHttpParameters)

isAllowCamelCase

public boolean isAllowCamelCase()

setAllowCamelCase

public void setAllowCamelCase(boolean allowCamelCase)

isAllowTrackbacks

public boolean isAllowTrackbacks()

setAllowTrackbacks

public void setAllowTrackbacks(boolean allowTrackbacks)

isAllowThreadedComments

public boolean isAllowThreadedComments()

setAllowThreadedComments

public void setAllowThreadedComments(boolean allowThreadedComments)

isViewSpaceGoesToSpaceSummary

public boolean isViewSpaceGoesToSpaceSummary()

setViewSpaceGoesToSpaceSummary

public void setViewSpaceGoesToSpaceSummary(boolean viewSpaceGoesToSpaceSummary)

isExternalUserManagement

public boolean isExternalUserManagement()

setExternalUserManagement

public void setExternalUserManagement(boolean externalUserManagement)

isDenyPublicSignup

public boolean isDenyPublicSignup()

setDenyPublicSignup

public void setDenyPublicSignup(boolean denyPublicSignup)

getReferrerSettings

public ReferrerSettings getReferrerSettings()

setReferrerSettings

public void setReferrerSettings(ReferrerSettings referrerSettings)

getCaptchaSettings

public CaptchaSettings getCaptchaSettings()

setCaptchaSettings

public void setCaptchaSettings(CaptchaSettings captchaSettings)

getSiteHomePage

public String getSiteHomePage()

setSiteHomePage

public void setSiteHomePage(String siteHomePage)

getSiteWelcomeMessage

public String getSiteWelcomeMessage()

setSiteWelcomeMessage

public void setSiteWelcomeMessage(String siteWelcomeMessage)

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

getMaxThumbDimensions

public Dimensions getMaxThumbDimensions()

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

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

public void setMaxThumbHeight(int maxThumbHeight)

Deprecated. since 4.0

You can no longer edit thumbnail sizes

setMaxThumbWidth

public void setMaxThumbWidth(int maxThumbWidth)

Deprecated. since 4.0

You can no longer edit thumbnail sizes

isEnableWysiwyg

public boolean isEnableWysiwyg()

Deprecated. since 4.0

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

setEnableWysiwyg

public void setEnableWysiwyg(boolean enableWysiwyg)

Deprecated. since 4.0

You can no longer disable wysiwyg mode in 4.0

isUseWysiwygByDefault

public boolean isUseWysiwygByDefault()

Deprecated. since 4.0

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

setUseWysiwygByDefault

public void setUseWysiwygByDefault(boolean useWysiwygByDefault)

Deprecated. since 4.0

You can no longer disable wysiwyg mode in 4.0

getNumberOfBreadcrumbAncestors

public int getNumberOfBreadcrumbAncestors()

Deprecated. since 4.0

You can no longer conifgure the breadcrumb ancestors in 4.0

setNumberOfBreadcrumbAncestors

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)

getDraftSaveInterval

public int getDraftSaveInterval()

setDraftSaveInterval

public void setDraftSaveInterval(int draftSaveInterval)

getCustomHtmlSettings

public CustomHtmlSettings getCustomHtmlSettings()

setCustomHtmlSettings

public void setCustomHtmlSettings(CustomHtmlSettings customHtmlSettings)

getColourSchemesSettings

public ColourSchemesSettings getColourSchemesSettings()

setColourSchemesSettings

public void setColourSchemesSettings(ColourSchemesSettings colourSchemesSettings)

getTimeZone

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:

TimeZone.getDefault()

getDefaultSpaceHomepageTitle

public String getDefaultSpaceHomepageTitle()

setDefaultSpaceHomepageTitle

public void setDefaultSpaceHomepageTitle(String defaultSpaceHomepageTitle)

getDefaultSpaceHomepageContent

public String getDefaultSpaceHomepageContent()

setDefaultSpaceHomepageContent

public void setDefaultSpaceHomepageContent(String defaultSpaceHomepageContent)

getBaseUrl

public String getBaseUrl()

setBaseUrl

public void setBaseUrl(String baseUrl)

getAttachmentDataStore

public String getAttachmentDataStore()

setAttachmentDataStore

public void setAttachmentDataStore(String attachmentDataStore)

getWebdavServerUrl

public String getWebdavServerUrl()

setWebdavServerUrl

public void setWebdavServerUrl(String webdavServerUrl)

getWebdavUsername

public String getWebdavUsername()

setWebdavUsername

public void setWebdavUsername(String webdavUsername)

getWebdavPassword

public String getWebdavPassword()

setWebdavPassword

public void setWebdavPassword(String webdavPassword)

isWebdavEnabled

public boolean isWebdavEnabled()

isAntiXssMode

public boolean isAntiXssMode()

setAnitXssMode

@Deprecated
public void setAnitXssMode(boolean antiXssMode)

Deprecated. since 3.5.8 use setAntiXssMode(boolean) instead.

setAntiXssMode

public void setAntiXssMode(boolean antiXssMode)

isSharedMode

public boolean isSharedMode()

setSharedMode

public void setSharedMode(boolean sharedMode)

isDisplayLinkIcons

public boolean isDisplayLinkIcons()

Deprecated. since 4.0

setDisplayLinkIcons

public void setDisplayLinkIcons(boolean displayLinkIcons)

Deprecated. since 4.0

getDefaultPersonalSpaceHomepageContent

public String getDefaultPersonalSpaceHomepageContent()

setDefaultPersonalSpaceHomepageContent

public void setDefaultPersonalSpaceHomepageContent(String defaultPersonalSpaceHomepageContent)

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.

isEnableDidYouMean

public boolean isEnableDidYouMean()

setEnableDidYouMean

public void setEnableDidYouMean(boolean enableDidYouMean)

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)

isEnableJavascriptTop

public boolean isEnableJavascriptTop()

setEnableJavascriptTop

public void setEnableJavascriptTop(boolean enableJavascriptTop)

getMaxRssItems

public int getMaxRssItems()

setMaxRssItems

public void setMaxRssItems(int maxRssItems)

getRssTimeout

public int getRssTimeout()

setRssTimeout

public void setRssTimeout(int rssTimeout)

isBackupDaily

public boolean isBackupDaily()

setBackupDaily

public void setBackupDaily(boolean 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)

getLoginManagerSettings

public LoginManagerSettings getLoginManagerSettings()

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)