Package com.atlassian.jira.web.action.setup

Class SetupDatabase

java.lang.Object

webwork.action.ActionSupport

com.atlassian.jira.web.action.JiraWebActionSupport

com.atlassian.jira.web.action.setup.AbstractSetupAction

com.atlassian.jira.web.action.setup.SetupDatabase

All Implemented Interfaces:

ErrorCollection, I18nHelper, HttpServletVariables, AuthorizationSupport, Serializable, webwork.action.Action, webwork.action.CommandDriven, webwork.action.IllegalArgumentAware

public class SetupDatabase
extends AbstractSetupAction

Action for configuring a database connection for JIRA and testing that it works. Also allows to set the server language for JIRA.

Step 1 of the setup wizard.

Since:

v4.4

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.atlassian.jira.web.action.JiraWebActionSupport

JiraWebActionSupport.MessageType

Nested classes/interfaces inherited from interface com.atlassian.jira.util.ErrorCollection

ErrorCollection.Reason

Nested classes/interfaces inherited from interface com.atlassian.jira.util.I18nHelper

I18nHelper.BeanFactory

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REDIRECT_URL

Fields inherited from class com.atlassian.jira.web.action.setup.AbstractSetupAction

DEFAULT_GROUP_ADMINS, fileFactory, jiraProperties, SETUP_ALREADY

Fields inherited from class com.atlassian.jira.web.action.JiraWebActionSupport

ISSUE_NOT_FOUND_RESULT, log, PERMISSION_VIOLATION_RESULT, request, RETURN_URL_PARAMETER, savedFilters, SECURITY_BREACH_RESULT

Fields inherited from class webwork.action.ActionSupport

command, errorMap, errorMessages

Fields inherited from interface webwork.action.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors

Constructor	Description
SetupDatabase(FileFactory fileFactory, BuildUtilsInfo buildUtilsInfo, DatabaseConfigurationManager databaseConfigurationManager, VelocityTemplatingEngine velocityEngine, DatabaseInitialImporter databaseInitialImporter, HelpUrls helpUrls, JiraProperties jiraProperties, JiraProductInformation jiraProductInformation)

Method Summary

Modifier and Type	Method	Description
String	doChangeLanguage()
String	doConnectionCheck()
String	doDefault()
protected String	doExecute()
String	doGetInstalledLocales()
String	doGetLanguageTexts()
String	doInput()
protected void	doValidation()
BuildUtilsInfo	getBuildUtilsInfo()
protected String	getCurrentTrackerStepId()
com.atlassian.config.db.DatabaseDetails	getDatabaseDetails(String database)
String	getDatabaseOption()
String	getDatabaseType()
boolean	getDbTestSuccessful()
String	getDefaultServerLanguage()
List<Map<String,Object>>	getExternalDatabases()
String	getImportOption()
List<Map<String,Object>>	getImportOptions()
String	getJdbcDatabase()
String	getJdbcHostname()
String	getJdbcPassword()
String	getJdbcPort()
String	getJdbcSid()
String	getJdbcUsername()
String	getJiraLanguage()
String	getLanguageTextsJson()
String	getSchemaName()
String	getSchemaName(String database)
Map<String,Object>	getSoyData()
Map<String,Object>	getSoyDataForConnectionCheck()
boolean	isDatabaseSetup()
void	setDatabaseOption(String databaseOption)
void	setDatabaseType(String databaseType)
void	setImportOption(String importOption)
void	setJdbcDatabase(String jdbcDatabase)
void	setJdbcHostname(String jdbcHostname)
void	setJdbcPassword(String jdbcPassword)
void	setJdbcPort(String jdbcPort)
void	setJdbcSid(String jdbcSid)
void	setJdbcUsername(String jdbcUsername)
void	setJiraLanguage(String jiraLanguage)
void	setLocaleForTexts(String localeForTexts)
void	setSchemaName(String schemaName)

Methods inherited from class com.atlassian.jira.web.action.setup.AbstractSetupAction

getAnalyticsIframeUrl, getLicenseProductKey, getModifierKey, getServerId, getSetupSessionId, getTrackerSteps, getXsrfToken, isInstantSetup, isLocaleValid, setIndexingLanguageForDefaultServerLocale, setJiraLocale, setupAlready, validateFormPathParam, validateSetupPath

Methods inherited from class com.atlassian.jira.web.action.JiraWebActionSupport

addError, addErrorCollection, addErrorMessage, addErrorMessageByKeyIfAbsent, addErrorMessageIfAbsent, addErrorMessages, addErrorMessages, addErrors, addIllegalArgumentException, addMessageToResponse, addReason, addReasons, checkIfUrlIsAllowed, execute, forceRedirect, getActionName, getActionNameJspa, getAdministratorContactLink, getApplicationProperties, getAuthorizationSupport, getComponentInstanceOfType, getConglomerateCookieValue, getConstantsManager, getDateFormat, getDateTimeFormat, getDateTimeFormatter, getDefaultResourceBundle, getDescTranslation, getDescTranslation, getDmyDateFormatter, getEmptyResponse, getErrorMessages, getErrors, getField, getFlushedErrorMessages, getGlobalPermissionManager, getHint, getHintManager, getHttpRequest, getHttpResponse, getHttpSession, getI18nHelper, getJiraContactHelper, getJiraServiceContext, getKeysForPrefix, getLanguage, getLocale, getLoggedInApplicationUser, getLoggedInUser, getNameTranslation, getNameTranslation, getOfBizDelegator, getOutboundWhitelistProvider, getOutlookDate, getPermissionManager, getProjectManager, getRandomHint, getReasons, getRedirect, getRedirect, getRedirectSanitiser, getRequestSourceType, getResourceBundle, getResult, getReturnUrl, getReturnUrlForCancelLink, getSearchSortDescriptions, getSelectedProject, getSelectedProjectObject, getServletContext, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getTimeFormat, getUnescapedText, getUntransformedRawText, getUriValidator, getUserFullName, getUserManager, getUserPreferences, getUserProjectHistoryManager, getVersionManager, getWebworkStack, getWebworkStack, hasAnyErrors, hasErrorMessage, hasErrorMessageByKey, hasGlobalPermission, hasGlobalPermission, hasIssuePermission, hasIssuePermission, hasIssuePermission, hasPermission, hasProjectPermission, hasProjectPermission, htmlEncode, insertContextPath, isAdministrator, isIndexing, isInlineDialogMode, isKeyDefined, isSystemAdministrator, isUserExists, isUserExistsByKey, isUserExistsByName, removeKeyOrAddError, returnComplete, returnComplete, returnCompleteWithInlineRedirect, returnCompleteWithInlineRedirectAndMsg, returnCompleteWithInlineRedirectAndMsg, returnMsgToUser, returnMsgToUser, setConglomerateCookieValue, setInline, setReasons, setReturnUrl, setSelectedProjectId, tagMauEventWithApplication, tagMauEventWithProject, urlEncode

Methods inherited from class webwork.action.ActionSupport

addError, addErrorMessage, getCommandName, getHasErrorMessages, getHasErrors, getPropertyEditorMessage, getTexts, getTexts, getTimezone, invalidInput, invokeCommand, isCommand, setCommand, setErrorMessages, setErrors, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface webwork.action.CommandDriven

getCommandName, setCommand

Methods inherited from interface com.atlassian.jira.util.ErrorCollection

addError, addErrorMessage, setErrorMessages

Field Details

REDIRECT_URL

public static final String REDIRECT_URL

See Also:

• Constant Field Values

Constructor Details

SetupDatabase

public SetupDatabase(FileFactory fileFactory,
 BuildUtilsInfo buildUtilsInfo,
 DatabaseConfigurationManager databaseConfigurationManager,
 VelocityTemplatingEngine velocityEngine,
 DatabaseInitialImporter databaseInitialImporter,
 HelpUrls helpUrls,
 JiraProperties jiraProperties,
 JiraProductInformation jiraProductInformation)

Method Details

doInput

public String doInput()
               throws Exception

Throws:

Exception

doConnectionCheck

public String doConnectionCheck()
                         throws IOException

Throws:

IOException

doDefault

public String doDefault()

Overrides:

doDefault in class webwork.action.ActionSupport

doValidation

protected void doValidation()

Overrides:

doValidation in class webwork.action.ActionSupport

doExecute

protected String doExecute()
                    throws Exception

Overrides:

doExecute in class webwork.action.ActionSupport

Throws:

Exception

getImportOptions

public List<Map<String,Object>> getImportOptions()

getSoyData

public Map<String,Object> getSoyData()

getSoyDataForConnectionCheck

public Map<String,Object> getSoyDataForConnectionCheck()

doGetInstalledLocales

public String doGetInstalledLocales()
                             throws JSONException,
IOException

Throws:

JSONException

IOException

getLanguageTextsJson

public String getLanguageTextsJson()
                            throws JSONException

Throws:

JSONException

doGetLanguageTexts

public String doGetLanguageTexts()
                          throws JSONException,
IOException

Throws:

JSONException

IOException

doChangeLanguage

public String doChangeLanguage()
                        throws IOException

Throws:

IOException

setLocaleForTexts

public void setLocaleForTexts(String localeForTexts)

getJiraLanguage

public String getJiraLanguage()

setJiraLanguage

public void setJiraLanguage(String jiraLanguage)

getExternalDatabases

public List<Map<String,Object>> getExternalDatabases()

getDatabaseDetails

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

getDefaultServerLanguage

public String getDefaultServerLanguage()

getSchemaName

public String getSchemaName(String database)

getDbTestSuccessful

public boolean getDbTestSuccessful()

isDatabaseSetup

public boolean isDatabaseSetup()

getDatabaseType

public String getDatabaseType()

setDatabaseType

public void setDatabaseType(String databaseType)

getDatabaseOption

public String getDatabaseOption()

setDatabaseOption

public void setDatabaseOption(String databaseOption)

getImportOption

public String getImportOption()

setImportOption

public void setImportOption(String importOption)

getBuildUtilsInfo

public BuildUtilsInfo getBuildUtilsInfo()

getJdbcHostname

public String getJdbcHostname()

setJdbcHostname

public void setJdbcHostname(String jdbcHostname)

getJdbcPassword

public String getJdbcPassword()

setJdbcPassword

public void setJdbcPassword(String jdbcPassword)

getJdbcPort

public String getJdbcPort()

setJdbcPort

public void setJdbcPort(String jdbcPort)

getJdbcDatabase

public String getJdbcDatabase()

setJdbcDatabase

public void setJdbcDatabase(String jdbcDatabase)

getJdbcSid

public String getJdbcSid()

setJdbcSid

public void setJdbcSid(String jdbcSid)

getJdbcUsername

public String getJdbcUsername()

setJdbcUsername

public void setJdbcUsername(String jdbcUsername)

getSchemaName

public String getSchemaName()

setSchemaName

public void setSchemaName(String schemaName)

getCurrentTrackerStepId

protected String getCurrentTrackerStepId()

Overrides:

getCurrentTrackerStepId in class AbstractSetupAction