Package com.atlassian.crowd.console.action.setup

Class Database

java.lang.Object

org.apache.struts2.ActionSupport

com.atlassian.crowd.console.action.BaseAction

com.atlassian.crowd.console.action.setup.BaseSetupAction

com.atlassian.crowd.console.action.setup.Database

All Implemented Interfaces:

Serializable, org.apache.struts2.action.Action, org.apache.struts2.interceptor.ValidationAware, org.apache.struts2.locale.LocaleProvider, org.apache.struts2.text.TextProvider, org.apache.struts2.Validateable

public class Database
extends BaseSetupAction

Select the type of database to configure Crowd with:

1. Embedded (HSQLDB)
2. External JDBC (C3P0 pooled)

Once a database type is correctly selected, this action will configure the database with the appropriate schema.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Database.CustomBannerError
static final record	Database.DatabaseListOption

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DATABASE_STEP
static final String	EMPTY_DB_TYPE_KEY

Fields inherited from class com.atlassian.crowd.console.action.setup.BaseSetupAction

SELECT_SETUP_STEP

Fields inherited from class com.atlassian.crowd.console.action.BaseAction

actionHelper, actionMessageAlertColor, ALERT_BLUE, ALERT_GREEN, ALERT_RED, ALERT_YELLOW, applicationManager, applicationService, BASIC_AUTH_PLUGIN_KEY, BASIC_AUTH_SYS_PROP_DISABLED, clientProperties, clusterService, crowdLicenseManager, directoryManager, initialLoad, pluginPropertyManager, propertyManager, rememberMeService, SMALL_AVATAR_SIZE, smallAvatarUrl, tab, tokenAuthenticationManager

Fields inherited from class org.apache.struts2.ActionSupport

container

Fields inherited from interface org.apache.struts2.action.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors

Constructor	Description
Database()

Method Summary

Modifier and Type	Method	Description
void	clearErrors()
String	execute()
List<Database.CustomBannerError>	getCustomBannerErrors()
Optional<String>	getCustomBannerErrorsTitle()
com.atlassian.config.db.DatabaseDetails	getDatabaseDetails(String database)
List<com.atlassian.config.internal.db.DatabaseList.DatabaseType>	getDatabaseList()
String	getDatabaseOption()
List<Database.DatabaseListOption>	getDatabaseOptionList()
List<Map<String,String>>	getDatabaseOptions()
com.atlassian.config.internal.db.DatabaseList	getDatabases()
String	getEmbeddedValue()
String	getJdbcDatabaseType()
String	getJdbcDriverClassName()
String	getJdbcHibernateDialect()
String	getJdbcPassword()
String	getJdbcUrl()
String	getJdbcUsername()
String	getJdbcValue()
RequiredPluginsStartupCheck	getRequiredPluginsStartupCheck()
String	getStepName()
boolean	hasCustomBannerErrors()
boolean	hasErrors()
boolean	isClusteringEnabled()
boolean	isDatabaseContainsExistingData()
boolean	isEmbeddedSelected()
boolean	isFormEnabled()
boolean	isJdbcOverwriteData()
boolean	isJdbcSelected()
boolean	isOverwriteExistingData()
void	setBannerErrorsTitle(String title)
void	setDatabaseConfiguredListeners(DatabaseConfiguredListeners databaseConfiguredListeners)
void	setDatabaseOption(String databaseOption)
void	setDatabases(com.atlassian.config.internal.db.DatabaseList databases)
void	setJdbcDatabaseType(String jdbcDatabaseType)
void	setJdbcDriverClassName(String jdbcDriverClassName)
void	setJdbcHibernateDialect(String jdbcHibernateDialect)
void	setJdbcOverwriteData(boolean jdbcOverwriteData)
void	setJdbcPassword(String jdbcPassword)
void	setJdbcUrl(String jdbcUrl)
void	setJdbcUsername(String jdbcUsername)
void	setRequiredPluginsStartupCheck(RequiredPluginsStartupCheck requiredPluginsStartupCheck)
String	update()

Methods inherited from class com.atlassian.crowd.console.action.setup.BaseSetupAction

getCrowdLicenseStore, getSetupPersister, isApplicationHomeOk, isAtCorrectStep, isEverythingOk, isServlet24, setSetupPersister

Methods inherited from class com.atlassian.crowd.console.action.BaseAction

addActionError, addActionMessage, applyFieldError, applyFieldErrors, applyValidationErrors, authorisedToAccessCrowdAdminConsole, authorisedToAccessCrowdConsole, bindInformationAboutLicense, containsActionMessages, containsErrorMessages, directory, findAvatarUrl, getActionMessageAlertColor, getBootstrapManager, getCrowdApplication, getCurrentLicenseResourceTotal, getDisplayableLink, getHttpRequest, getImageLocation, getImageTitle, getLabel, getLicense, getLink, getLocaleProvider, getPasswordComplexityMessage, getPrincipalName, getRemoteUser, getSession, getSitemeshPageProperties, getSmallAvatarUrl, getTab, getText, getText, getTextProvider, getUserName, getWebFragmentsContextMap, getWebInterfaceManager, getWebItemsForSection, getWebResourceManager, getWebSectionsForLocation, getXsrfToken, getXsrfTokenName, isAtResourceLimit, isAuthenticated, isBasicAuthEnabled, isDataCenterLicense, isEvaluation, isGroupAdmin, isInitialLoad, isLicenseExpired, isLicenseForged, isRestartRequiredToEnableClustering, isSubscription, isSysAdmin, isWithinGracePeriod, renderFreemarkerTemplate, resolveAvatarUri, setActionHelper, setApplicationManager, setApplicationService, setClientProperties, setClusterService, setCrowdApplication, setCrowdLicenseManager, setDirectoryManager, setPluginPropertyManager, setPropertyManager, setRememberMeService, setTab, setTokenAuthenticationManager, setWebInterfaceManager, setWebResourceManager, setXsrfTokenGenerator

Methods inherited from class org.apache.struts2.ActionSupport

addActionError, addActionMessage, addFieldError, clearActionErrors, clearErrorsAndMessages, clearFieldErrors, clearMessages, clone, getActionErrors, getActionMessages, getContainer, getFieldErrors, getFormatted, getLocale, getText, getText, getText, getText, getText, getText, getText, getText, getTexts, getTexts, hasActionErrors, hasActionMessages, hasFieldErrors, hasKey, input, isValidLocale, isValidLocaleString, pause, setActionErrors, setActionMessages, setContainer, setFieldErrors, toLocale, validate

Methods inherited from class java.lang.Object

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

Field Details

DATABASE_STEP

public static final String DATABASE_STEP

See Also:

• Constant Field Values

EMPTY_DB_TYPE_KEY

public static final String EMPTY_DB_TYPE_KEY

See Also:

• Constant Field Values

Constructor Details

Database

public Database()

Method Details

execute

public String execute()

Specified by:

execute in interface org.apache.struts2.action.Action

Overrides:

execute in class BaseSetupAction

hasErrors

public boolean hasErrors()

Specified by:

hasErrors in interface org.apache.struts2.interceptor.ValidationAware

Overrides:

hasErrors in class org.apache.struts2.ActionSupport

clearErrors

public void clearErrors()

Overrides:

clearErrors in class org.apache.struts2.ActionSupport

update

public String update()

Overrides:

update in class BaseSetupAction

getStepName

public String getStepName()

Specified by:

getStepName in class BaseSetupAction

getDatabaseDetails

public com.atlassian.config.db.DatabaseDetails getDatabaseDetails(String database)

getDatabaseOptionList

public List<Database.DatabaseListOption> getDatabaseOptionList()

getDatabaseOption

public String getDatabaseOption()

setDatabaseOption

public void setDatabaseOption(String databaseOption)

getDatabaseList

public List<com.atlassian.config.internal.db.DatabaseList.DatabaseType> getDatabaseList()

getEmbeddedValue

public String getEmbeddedValue()

getJdbcValue

public String getJdbcValue()

isEmbeddedSelected

public boolean isEmbeddedSelected()

isJdbcSelected

public boolean isJdbcSelected()

getDatabases

public com.atlassian.config.internal.db.DatabaseList getDatabases()

setDatabases

public void setDatabases(com.atlassian.config.internal.db.DatabaseList databases)

getJdbcDatabaseType

public String getJdbcDatabaseType()

setJdbcDatabaseType

public void setJdbcDatabaseType(String jdbcDatabaseType)

getJdbcDriverClassName

public String getJdbcDriverClassName()

setJdbcDriverClassName

public void setJdbcDriverClassName(String jdbcDriverClassName)

getJdbcUrl

public String getJdbcUrl()

setJdbcUrl

public void setJdbcUrl(String jdbcUrl)

getJdbcUsername

public String getJdbcUsername()

setJdbcUsername

public void setJdbcUsername(String jdbcUsername)

getJdbcPassword

public String getJdbcPassword()

setJdbcPassword

public void setJdbcPassword(String jdbcPassword)

getJdbcHibernateDialect

public String getJdbcHibernateDialect()

setJdbcHibernateDialect

public void setJdbcHibernateDialect(String jdbcHibernateDialect)

isJdbcOverwriteData

public boolean isJdbcOverwriteData()

setJdbcOverwriteData

public void setJdbcOverwriteData(boolean jdbcOverwriteData)

isOverwriteExistingData

public boolean isOverwriteExistingData()

setRequiredPluginsStartupCheck

public void setRequiredPluginsStartupCheck(RequiredPluginsStartupCheck requiredPluginsStartupCheck)

setDatabaseConfiguredListeners

public void setDatabaseConfiguredListeners(DatabaseConfiguredListeners databaseConfiguredListeners)

getRequiredPluginsStartupCheck

public RequiredPluginsStartupCheck getRequiredPluginsStartupCheck()

getDatabaseOptions

public List<Map<String,String>> getDatabaseOptions()

isDatabaseContainsExistingData

public boolean isDatabaseContainsExistingData()

isClusteringEnabled

public boolean isClusteringEnabled()

isFormEnabled

public boolean isFormEnabled()

hasCustomBannerErrors

public boolean hasCustomBannerErrors()

getCustomBannerErrors

public List<Database.CustomBannerError> getCustomBannerErrors()

setBannerErrorsTitle

public void setBannerErrorsTitle(String title)

getCustomBannerErrorsTitle

public Optional<String> getCustomBannerErrorsTitle()