com.atlassian.confluence.it.admin
Class AdminConsole

java.lang.Object
  com.atlassian.confluence.it.admin.AdminConsole

public class AdminConsole
extends Object

Field Summary

protected org.slf4j.Logger

log

Method Summary

void	addSmtpServer(String serverName, String from, String subjectPrefix, String hostname, int port) Adds a SMTP server to the Confluence configuration
EditGeneralConfiguration	editGeneralConfig()
void	editLayout(String decoratorName, String value)
void	editSecurityConfig()
void	enableAddWildcardsToUserAndGroupSearches(boolean enabled)
void	enableAntiXssMode(boolean enable) Enables or disables the auto HTML encoding
void	enableCaptcha(boolean enable) Configures captcha for all users, including administrator
void	enableContactAdministratorsForm(boolean enable) Set the ContactAdministratorsForm global setting to the value passed in.
void	enableElevatedSecurityCheck(boolean enabled)
void	enableExternalUserManagement(boolean enable)
void	enablePublicSignup(boolean enabled)
void	enableShowSystemInfoIn500Page(boolean enabled)
void	enableSpaceStyles(boolean enabled)
void	enableWebSudo(boolean enabled)
static AdminConsole	getAdminConsole(net.sourceforge.jwebunit.junit.WebTester webTester)
int	getLoginAttemptsThreshold()
boolean	isAddWildcardsToUserAndGroupSearches()
boolean	isAntiXssModeEnabled()
boolean	isEnableElevatedSecurityCheck()
boolean	isEnableSpaceStyles()
boolean	isExternalUserManagement()
boolean	isPublicSignup()
boolean	isShowSystemInfoIn500Page()
boolean	isXsrfAddComments()
boolean	migrateAttachmentStorageToDatabase(boolean nonBackgroundTask)
boolean	migrateAttachmentStorageToFileSystem(boolean nonBackgroundTask)
void	removeAllSmtpServers() Removes all configured SMTP servers from the Confluence configuration
void	resetGlobalLogo()
void	resetGlobalThemeToDefault()
void	resetLayout(String decoratorName)
void	setAllowAnonymousRemoteApi(boolean enabled)
void	setBaseUrl(String baseUrl)
void	setCamelCaseLinks(boolean enabled)
void	setCustomContactAdministratorsMessage(String message)
void	setEmailMask(String setting)
void	setExternalUserManagement(boolean enabled)
void	setGlobalLogo(File logo)
void	setGlobalTheme(String themeKey)
void	setHttpCompression(boolean enabled) Set the Http Compression setting according to the given parameter.
void	setLoginAttemptsThreshold(int loginAttemptsThreshold)
int	setMaxRssItems(int max)
void	setPublicSignup(boolean enabled)
void	setRemoteApi(boolean enabled)
void	setSpaceSyles(boolean enabled)
void	setTrackBack(boolean enabled)
void	setWebSudoTimeout(long timeout) Enables WebSudo support and sets the timeout in minutes
boolean	setXsrfAddComments(boolean enable)
void	snipSnapImport(String importResource, Long spaceId)
void	updateLicense(License license) Change the system's license.
void	validateWebSudo(String password)
void	viewAdminConsole() View the admin console via direct URL request.
void	viewAttachmentStorage()
void	viewGlobalLogo()
void	viewLayoutsPage()
void	viewPlugin(String pluginKey)
void	viewPlugins()
void	viewSecurityConfiguration()
void	viewSystemInformation()
void	viewUser(User user)

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final transient org.slf4j.Logger log

Method Detail

getAdminConsole

public static AdminConsole getAdminConsole(net.sourceforge.jwebunit.junit.WebTester webTester)

editGeneralConfig

public EditGeneralConfiguration editGeneralConfig()

editSecurityConfig

public void editSecurityConfig()

viewAdminConsole

public void viewAdminConsole()

View the admin console via direct URL request.

setGlobalTheme

public void setGlobalTheme(String themeKey)

resetGlobalThemeToDefault

public void resetGlobalThemeToDefault()

enableCaptcha

public void enableCaptcha(boolean enable)

Configures captcha for all users, including administrator

Parameters:

enable - true to enable captcha, false to disable captcha

enableWebSudo

public void enableWebSudo(boolean enabled)

validateWebSudo

public void validateWebSudo(String password)

setWebSudoTimeout

public void setWebSudoTimeout(long timeout)

Enables WebSudo support and sets the timeout in minutes

Parameters:

timeout - the timeout in minutes

enableAntiXssMode

public void enableAntiXssMode(boolean enable)

Enables or disables the auto HTML encoding

Parameters:

enable - the new state of this property

enableExternalUserManagement

public void enableExternalUserManagement(boolean enable)

isAntiXssModeEnabled

public boolean isAntiXssModeEnabled()

isExternalUserManagement

public boolean isExternalUserManagement()

isAddWildcardsToUserAndGroupSearches

public boolean isAddWildcardsToUserAndGroupSearches()

isPublicSignup

public boolean isPublicSignup()

isEnableSpaceStyles

public boolean isEnableSpaceStyles()

isShowSystemInfoIn500Page

public boolean isShowSystemInfoIn500Page()

setGlobalLogo

public void setGlobalLogo(File logo)

resetGlobalLogo

public void resetGlobalLogo()

viewGlobalLogo

public void viewGlobalLogo()

addSmtpServer

public void addSmtpServer(String serverName,
                          String from,
                          String subjectPrefix,
                          String hostname,
                          int port)

Adds a SMTP server to the Confluence configuration

Parameters:

serverName - description of the server for Confluence

from - emails sent via this server will have this value in the from header

subjectPrefix - this prefix will be appended to all mail sent via this server

hostname - the host name of the server to connect to

port - the port of the server to connect to

removeAllSmtpServers

public void removeAllSmtpServers()

Removes all configured SMTP servers from the Confluence configuration

viewAttachmentStorage

public void viewAttachmentStorage()

migrateAttachmentStorageToDatabase

public boolean migrateAttachmentStorageToDatabase(boolean nonBackgroundTask)

migrateAttachmentStorageToFileSystem

public boolean migrateAttachmentStorageToFileSystem(boolean nonBackgroundTask)

viewUser

public void viewUser(User user)

viewPlugins

public void viewPlugins()

viewPlugin

public void viewPlugin(String pluginKey)

viewSystemInformation

public void viewSystemInformation()

viewLayoutsPage

public void viewLayoutsPage()

viewSecurityConfiguration

public void viewSecurityConfiguration()

editLayout

public void editLayout(String decoratorName,
                       String value)

resetLayout

public void resetLayout(String decoratorName)

setCustomContactAdministratorsMessage

public void setCustomContactAdministratorsMessage(String message)

enableContactAdministratorsForm

public void enableContactAdministratorsForm(boolean enable)

Set the ContactAdministratorsForm global setting to the value passed in.

updateLicense

public void updateLicense(License license)

Change the system's license. Remember to set it back to the default afterwards.

isXsrfAddComments

public boolean isXsrfAddComments()

setXsrfAddComments

public boolean setXsrfAddComments(boolean enable)

setMaxRssItems

public int setMaxRssItems(int max)

setExternalUserManagement

public void setExternalUserManagement(boolean enabled)

setEmailMask

public void setEmailMask(String setting)

setPublicSignup

public void setPublicSignup(boolean enabled)

setAllowAnonymousRemoteApi

public void setAllowAnonymousRemoteApi(boolean enabled)

setRemoteApi

public void setRemoteApi(boolean enabled)

setHttpCompression

public void setHttpCompression(boolean enabled)

Set the Http Compression setting according to the given parameter. Current logged in user must have administrative permission.

Parameters:

enabled - true to turn (or leave) compression on.

setCamelCaseLinks

public void setCamelCaseLinks(boolean enabled)

setTrackBack

public void setTrackBack(boolean enabled)

setBaseUrl

public void setBaseUrl(String baseUrl)

snipSnapImport

public void snipSnapImport(String importResource,
                           Long spaceId)

setSpaceSyles

public void setSpaceSyles(boolean enabled)

setLoginAttemptsThreshold

public void setLoginAttemptsThreshold(int loginAttemptsThreshold)

enableElevatedSecurityCheck

public void enableElevatedSecurityCheck(boolean enabled)

getLoginAttemptsThreshold

public int getLoginAttemptsThreshold()

isEnableElevatedSecurityCheck

public boolean isEnableElevatedSecurityCheck()

enableShowSystemInfoIn500Page

public void enableShowSystemInfoIn500Page(boolean enabled)

enableSpaceStyles

public void enableSpaceStyles(boolean enabled)

enablePublicSignup

public void enablePublicSignup(boolean enabled)

enableAddWildcardsToUserAndGroupSearches

public void enableAddWildcardsToUserAndGroupSearches(boolean enabled)