AbstractSetupAction (Atlassian Confluence 7.9.1 API)

java.lang.Object
- com.opensymphony.xwork.ActionSupport
- - com.atlassian.confluence.core.ConfluenceActionSupport
  - - com.atlassian.confluence.setup.actions.AbstractSetupAction

All Implemented Interfaces:

WebInterface, MessageHolderAware, com.opensymphony.xwork.Action, com.opensymphony.xwork.LocaleProvider, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.Validateable, com.opensymphony.xwork.ValidationAware, Serializable

Direct Known Subclasses:

AbstractSelectBundleAction, AbstractSetupDatabaseAction, ChecklistAction, ConnectToJiraAction, ConnectToJiraSyncDirectoryAction, FinishSetupAction, GetBundlesAction, SelectGlobalLocaleAction, SelectSetupStepAction, SetupAdministrator, SetupClusterAction, SetupDataAction, SetupDemoContentAction, SetupPathsAction, SetupStartAction, SetupUserManagementChoiceAction
```
public abstract class AbstractSetupAction
extends ConfluenceActionSupport
```
This action communicates with BootstrapManager. BootstrapManager remembers state persistence for the setup cycle.
All control for setup sequences is, funnily enough, seated in xwork.xml (the Controller).

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected BundlePluginService`	`bundlePluginService`
`static String`	`DEMO_CONTENT_ZIP_FILE`
`protected static String`	`SELECT_BUNDLE`
`static String`	`SETUP_BUNDLE_PLUGINS_CREDENTIAL`
`protected static String`	`SETUP_CLUSTER`
`protected static String`	`SETUP_CLUSTER_TO_STANDALONE`
`protected static String`	`SETUP_CONTENT_BLANK`
`protected static String`	`SETUP_CONTENT_DEMO`
`protected static String`	`SETUP_CONTENT_IMPORT`
`protected static String`	`SETUP_CUSTOM`
`protected static String`	`SETUP_DB_CLUSTER_CONN_TYPE`
`protected static String`	`SETUP_DB_CONN_TYPE`
`protected static String`	`SETUP_DB_DATASOURCE`
`protected static String`	`SETUP_DB_EMBEDDED`
`protected static String`	`SETUP_DB_STANDARD`
`protected static String`	`SETUP_DB_TYPE_DATASOURCE`
`protected static String`	`SETUP_DB_TYPE_STANDARD`
`static String`	`SETUP_HAS_SELECTED_BUNDLE_PLUGINS`
`protected static String`	`SETUP_PATHS`
`protected static String`	`SETUP_QUICK`
`protected static String`	`SETUP_SESSION_ID_KEY`
`protected static String`	`SETUP_SKIP_TO_NEXT_STEP`
`protected static String`	`SETUP_SKIP_TO_NEXT_STEP_CLUSTER`
`protected static String`	`SETUP_USER_INTERNAL`
`protected static String`	`SETUP_USER_JAACS`

Fields inherited from class com.atlassian.confluence.core.ConfluenceActionSupport
accessModeService, CANCEL, DEVMODE, eventManager, i18NBeanFactory, labelManager, languageManager, LICENSE_EXPIRED, LICENSE_USERS_EXCEEDED, messageHolder, permissionManager, permitted, personService, pluginAccessor, PREVIEW, settingsManager, spacePermissionManager, userAccessor, webInterfaceManager

Fields inherited from class com.opensymphony.xwork.ActionSupport
LOG

Fields inherited from interface com.opensymphony.xwork.Action
ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors
Constructor and Description

AbstractSetupAction()

Constructors
Constructor and Description
`AbstractSetupAction()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`BootstrapManager`	`getBootstrapManager()`
`Collection<SetupBundlePluginDescriptor>`	`getBundledPlugins()`
`com.atlassian.spring.container.ContainerManager`	`getContainerManager()`
`Locale`	`getLocale()`
`String`	`getServerId()`
`ConfluenceSetupPersister`	`getSetupPersister()`
`String`	`getSetupSessionId()` The following methods are for collecting metadata used for installer analytics (CONFDEV-27425)
`protected <T> com.atlassian.fugue.Maybe<T>`	`getSingletonFromMainContext(Class<T> type)` Deprecated. since 7.0.1. Use `retrieveSingletonFromMainContext(Class)`
`String`	`getSupportEntitlementNumber()`
`String`	`getXsrfToken()`
`com.atlassian.xwork.XsrfTokenGenerator`	`getXsrfTokenGenerator()`
`boolean`	`isPermitted()` override the parent's implementation - everyone is allowed to perform a setup action.
`protected <T> Optional<T>`	`retrieveSingletonFromMainContext(Class<T> type)` Retrieves a single bean of the given type from the main context.
`protected void`	`saveAuthenticationInfo(String username, String password)`
`void`	`setBootstrapSidManager(ConfluenceSidManager bootstrapSidManager)`
`void`	`setBundlePluginService(BundlePluginService bundlePluginService)`
`void`	`setContainerManager(com.atlassian.spring.container.ContainerManager containerManager)`
`void`	`setLicenseService(LicenseService licenseService)`
`void`	`setSetupPersister(ConfluenceSetupPersister setupPersister)`
`void`	`setXsrfTokenGenerator(com.atlassian.xwork.XsrfTokenGenerator xsrfTokenGenerator)`
`protected void`	`transitionFromColdToTenantedState()`
`protected void`	`transitionFromColdToVacantState()` Cold to vacant transition.
`protected void`	`transitionFromVacantToTenantedState()` Vacant to tenanted transition.

Methods inherited from class com.atlassian.confluence.core.ConfluenceActionSupport
addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, doDefault, formatFriendlyDate, getAccessMode, getActionName, getActionName, getAuthenticatedUser, getCancel, getCancelResult, getConfluenceAccessManager, getContext, getCurrentRequest, getCurrentSession, getDateFormatSetting, getDateFormatter, getDefaultResourceBundle, getDefaultTimeZone, getDocLink, getEventManager, getFriendlyDateFormatter, getFrontendServiceURL, getGlobalSettings, getHelper, getI18n, getInstalledLanguages, getLabelManager, getLanguageJs, getLanguageManager, getLanguageUserFriendly, getLocaleManager, getLocaleString, getMessageHolder, getNiceContentType, getPermissionManager, getPermissionTypes, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPersonService, getPreviousLoginDate, getRemoteUser, getSession, getSystemInformationService, getText, getText, getText, getText, getTextStatic, getTextStatic, getTextStrict, getTimeZone, getUserAccessor, getUserByName, getUserFullName, getUserHasBrowseUsersPermission, getUserHasLicensedAccess, getUserInterfaceState, getUserLocaleDefaultDatePattern, getUserProfilePicUrl, getWebInterfaceContext, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPrintableVersion, isSkipAccessCheck, isUserStatusPluginEnabled, isUsingH2, isUsingHSQL, setAccessModeService, setApiDateFormatService, setApiPersonService, setBootstrapManager, setCancel, setConfluenceAccessManager, setContentUiSupport, setEventManager, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setMessageHolder, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setServletRequestSupplier, setSettingsManager, setSkipAccessCheck, setSpacePermissionManager, setSystemInformationService, setTimeZoneManager, setUserAccessor, setWebInterfaceManager, withServletRequestSupplier

Methods inherited from class com.opensymphony.xwork.ActionSupport
addActionError, addActionMessage, addFieldError, execute, getActionErrors, getActionMessages, getErrorMessages, getErrors, getFieldErrors, getText, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, setActionErrors, setActionMessages, setFieldErrors, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.atlassian.confluence.validation.MessageHolderAware
validate

- Field Detail
  - DEMO_CONTENT_ZIP_FILE
```
public static final String DEMO_CONTENT_ZIP_FILE
```
    See Also:
    
    Constant Field Values
  - SETUP_QUICK
```
protected static final String SETUP_QUICK
```
    See Also:
    
    Constant Field Values
  - SELECT_BUNDLE
```
protected static final String SELECT_BUNDLE
```
    See Also:
    
    Constant Field Values
  - SETUP_CLUSTER
```
protected static final String SETUP_CLUSTER
```
    See Also:
    
    Constant Field Values
  - SETUP_CUSTOM
```
protected static final String SETUP_CUSTOM
```
    See Also:
    
    Constant Field Values
  - SETUP_CLUSTER_TO_STANDALONE
```
protected static final String SETUP_CLUSTER_TO_STANDALONE
```
    See Also:
    
    Constant Field Values
  - SETUP_USER_INTERNAL
```
protected static final String SETUP_USER_INTERNAL
```
    See Also:
    
    Constant Field Values
  - SETUP_USER_JAACS
```
protected static final String SETUP_USER_JAACS
```
    See Also:
    
    Constant Field Values
  - SETUP_DB_EMBEDDED
```
protected static final String SETUP_DB_EMBEDDED
```
    See Also:
    
    Constant Field Values
  - SETUP_DB_STANDARD
```
protected static final String SETUP_DB_STANDARD
```
    See Also:
    
    Constant Field Values
  - SETUP_DB_DATASOURCE
```
protected static final String SETUP_DB_DATASOURCE
```
    See Also:
    
    Constant Field Values
  - SETUP_DB_CONN_TYPE
```
protected static final String SETUP_DB_CONN_TYPE
```
    See Also:
    
    Constant Field Values
  - SETUP_DB_CLUSTER_CONN_TYPE
```
protected static final String SETUP_DB_CLUSTER_CONN_TYPE
```
    See Also:
    
    Constant Field Values
  - SETUP_DB_TYPE_STANDARD
```
protected static final String SETUP_DB_TYPE_STANDARD
```
    See Also:
    
    Constant Field Values
  - SETUP_DB_TYPE_DATASOURCE
```
protected static final String SETUP_DB_TYPE_DATASOURCE
```
    See Also:
    
    Constant Field Values
  - SETUP_CONTENT_BLANK
```
protected static final String SETUP_CONTENT_BLANK
```
    See Also:
    
    Constant Field Values
  - SETUP_CONTENT_DEMO
```
protected static final String SETUP_CONTENT_DEMO
```
    See Also:
    
    Constant Field Values
  - SETUP_CONTENT_IMPORT
```
protected static final String SETUP_CONTENT_IMPORT
```
    See Also:
    
    Constant Field Values
  - SETUP_SESSION_ID_KEY
```
protected static final String SETUP_SESSION_ID_KEY
```
    See Also:
    
    Constant Field Values
  - SETUP_PATHS
```
protected static final String SETUP_PATHS
```
    See Also:
    
    Constant Field Values
  - SETUP_SKIP_TO_NEXT_STEP
```
protected static final String SETUP_SKIP_TO_NEXT_STEP
```
    See Also:
    
    Constant Field Values
  - SETUP_SKIP_TO_NEXT_STEP_CLUSTER
```
protected static final String SETUP_SKIP_TO_NEXT_STEP_CLUSTER
```
    See Also:
    
    Constant Field Values
  - SETUP_HAS_SELECTED_BUNDLE_PLUGINS
```
public static final String SETUP_HAS_SELECTED_BUNDLE_PLUGINS
```
    See Also:
    
    Constant Field Values
  - SETUP_BUNDLE_PLUGINS_CREDENTIAL
```
public static final String SETUP_BUNDLE_PLUGINS_CREDENTIAL
```
    See Also:
    
    Constant Field Values
  - bundlePluginService
```
protected BundlePluginService bundlePluginService
```
- Constructor Detail
  - AbstractSetupAction
```
public AbstractSetupAction()
```
- Method Detail
  - setSetupPersister
```
public void setSetupPersister(ConfluenceSetupPersister setupPersister)
```
  - getSetupPersister
```
public ConfluenceSetupPersister getSetupPersister()
```
  - isPermitted
```
public boolean isPermitted()
```
    override the parent's implementation - everyone is allowed to perform a setup action.
    
    Overrides:
    
    isPermitted in class ConfluenceActionSupport
    
    Returns:
    
    true always
  - getBootstrapManager
```
public BootstrapManager getBootstrapManager()
```
    Overrides:
    
    getBootstrapManager in class ConfluenceActionSupport
  - getLocale
```
public Locale getLocale()
```
    Specified by:
    
    getLocale in interface com.opensymphony.xwork.LocaleProvider
    
    Overrides:
    
    getLocale in class ConfluenceActionSupport
  - transitionFromColdToTenantedState
```
protected void transitionFromColdToTenantedState()
                                          throws com.atlassian.config.ConfigurationException
```
    Throws:
    
    com.atlassian.config.ConfigurationException
  - transitionFromColdToVacantState
```
protected void transitionFromColdToVacantState()
                                        throws com.atlassian.config.ConfigurationException
```
    Cold to vacant transition.
    The main context is initialized without a configured database connection. Plugins which don't need a tenant on enablement or can react to tenant arrival are loaded.
    
    Throws:
    
    com.atlassian.config.ConfigurationException
    
    Since:
    
    5.6
    
    See Also:
    
    SplitStartupPluginSystemLifecycle.earlyStartup()
  - transitionFromVacantToTenantedState
```
protected void transitionFromVacantToTenantedState()
```
    Vacant to tenanted transition.
    Called after the database is configured. The (system) tenant is declared as arrived, allowing the initialisation of the session factories, and the plugins which need a tenant on enablement are loaded.
    
    Since:
    
    5.6
    
    See Also:
    
    SystemTenant.arrived(), SplitStartupPluginSystemLifecycle.lateStartup()
  - getSingletonFromMainContext
```
@Deprecated
protected <T> com.atlassian.fugue.Maybe<T> getSingletonFromMainContext(Class<T> type)
```
    Deprecated. since 7.0.1. Use retrieveSingletonFromMainContext(Class)
    
    Retrieves a single bean of the given type from the main context.
    
    Type Parameters:
    
    T - the type of the singleton
    
    Parameters:
    
    type - the class instance of the type
    
    Returns:
    
    maybe the singleton
    
    Since:
    
    5.6
  - retrieveSingletonFromMainContext
```
protected <T> Optional<T> retrieveSingletonFromMainContext(Class<T> type)
```
    Retrieves a single bean of the given type from the main context.
    
    Type Parameters:
    
    T - the type of the singleton
    
    Parameters:
    
    type - the class instance of the type
    
    Returns:
    
    maybe the singleton
    
    Since:
    
    7.0.1
  - getContainerManager
```
public com.atlassian.spring.container.ContainerManager getContainerManager()
```
  - setContainerManager
```
public void setContainerManager(com.atlassian.spring.container.ContainerManager containerManager)
```
  - getSetupSessionId
```
public String getSetupSessionId()
```
    The following methods are for collecting metadata used for installer analytics (CONFDEV-27425)
  - setBootstrapSidManager
```
public void setBootstrapSidManager(ConfluenceSidManager bootstrapSidManager)
                            throws com.atlassian.config.ConfigurationException
```
    Throws:
    
    com.atlassian.config.ConfigurationException
  - getXsrfToken
```
public String getXsrfToken()
```
  - getXsrfTokenGenerator
```
public com.atlassian.xwork.XsrfTokenGenerator getXsrfTokenGenerator()
```
  - setXsrfTokenGenerator
```
public void setXsrfTokenGenerator(com.atlassian.xwork.XsrfTokenGenerator xsrfTokenGenerator)
```
  - getServerId
```
public String getServerId()
```
  - setLicenseService
```
public void setLicenseService(LicenseService licenseService)
```
  - getSupportEntitlementNumber
```
public String getSupportEntitlementNumber()
```
  - saveAuthenticationInfo
```
protected void saveAuthenticationInfo(String username,
                                      String password)
```
  - setBundlePluginService
```
public void setBundlePluginService(BundlePluginService bundlePluginService)
```
  - getBundledPlugins
```
public Collection<SetupBundlePluginDescriptor> getBundledPlugins()
```

Class AbstractSetupAction

Field Summary

Fields inherited from class com.atlassian.confluence.core.ConfluenceActionSupport

Fields inherited from class com.opensymphony.xwork.ActionSupport

Fields inherited from interface com.opensymphony.xwork.Action

Constructor Summary

Method Summary

Methods inherited from class com.atlassian.confluence.core.ConfluenceActionSupport

Methods inherited from class com.opensymphony.xwork.ActionSupport

Methods inherited from class java.lang.Object

Methods inherited from interface com.atlassian.confluence.validation.MessageHolderAware

Field Detail

DEMO_CONTENT_ZIP_FILE

SETUP_QUICK

SELECT_BUNDLE

SETUP_CLUSTER

SETUP_CUSTOM

SETUP_CLUSTER_TO_STANDALONE

SETUP_USER_INTERNAL

SETUP_USER_JAACS

SETUP_DB_EMBEDDED

SETUP_DB_STANDARD

SETUP_DB_DATASOURCE

SETUP_DB_CONN_TYPE

SETUP_DB_CLUSTER_CONN_TYPE

SETUP_DB_TYPE_STANDARD

SETUP_DB_TYPE_DATASOURCE

SETUP_CONTENT_BLANK

SETUP_CONTENT_DEMO

SETUP_CONTENT_IMPORT

SETUP_SESSION_ID_KEY

SETUP_PATHS

SETUP_SKIP_TO_NEXT_STEP

SETUP_SKIP_TO_NEXT_STEP_CLUSTER

SETUP_HAS_SELECTED_BUNDLE_PLUGINS

SETUP_BUNDLE_PLUGINS_CREDENTIAL

bundlePluginService

Constructor Detail

AbstractSetupAction

Method Detail

setSetupPersister

getSetupPersister

isPermitted

getBootstrapManager

getLocale

transitionFromColdToTenantedState

transitionFromColdToVacantState

transitionFromVacantToTenantedState

getSingletonFromMainContext

retrieveSingletonFromMainContext

getContainerManager

setContainerManager

getSetupSessionId

setBootstrapSidManager

getXsrfToken

getXsrfTokenGenerator

setXsrfTokenGenerator

getServerId

setLicenseService

getSupportEntitlementNumber

saveAuthenticationInfo

setBundlePluginService

getBundledPlugins