Package com.atlassian.confluence.setup
Interface BootstrapManager
-
- All Superinterfaces:
com.atlassian.config.bootstrap.AtlassianBootstrapManager
,ConfluenceBootstrapConstants
- All Known Subinterfaces:
BootstrapManagerInternal
- All Known Implementing Classes:
BootstrapStatusProviderImpl
,DefaultBootstrapManager
public interface BootstrapManager extends com.atlassian.config.bootstrap.AtlassianBootstrapManager, ConfluenceBootstrapConstants
Controls the bootstrapping of Confluence - starting essential, core services.
-
-
Field Summary
Fields Modifier and Type Field Description static String
JWT_KEY_LENGTH
static String
JWT_PRIVATE_KEY
static String
JWT_PUBLIC_KEY
static String
SYNCHRONY_SERVICE_AUTHTOKEN
-
Fields inherited from interface com.atlassian.confluence.setup.ConfluenceBootstrapConstants
ATLASSIAN_LICENSE_KEY, ATTACHMENTS_DIR_PROP, CONFLUENCE_HOME_CONSTANT, CONFLUENCE_LOCAL_HOME_CONSTANT, DEFAULT_LICENSE_REGISTRY_KEY, GLOBAL_PLUGIN_STATE, INSTALLATION_DATE_KEY, LICENSE_HASH_KEY, LICENSE_MESSAGE_KEY, LUCENE_INDEX_DIR_PROP, TEMP_DIR_PROP, WEBAPP_CONTEXT_PATH_KEY
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description void
bootstrapSharedConfiguration(SharedConfigurationMap sharedConfig)
Deprecated.since 5.9void
checkConfigurationOnStartup()
void
cleanupOnShutdown()
If there's any resource that needs to be cleaned up, do it here.String
getApplicationHome()
Deprecated.since 7.14.String
getConfiguredApplicationHome()
Deprecated.since 7.14.File
getConfiguredLocalHome()
Deprecated.since 7.14.String
getConfluenceHome()
Deprecated.since 5.5.Optional<String>
getDataSourceName()
Returns the name of the JNDI-based DataSource, if any.String
getFilePathProperty(String key)
Deprecated.since 7.14 UseConfluenceDirectories
String
getHibernateDialect()
Returns the SQL dialect being used by Hibernate.File
getLocalHome()
Deprecated.since 7.14 UseApplicationProperties.getLocalHomeDirectory()
(plugins) or the localHome Spring bean (core)File
getSharedHome()
Deprecated.since 7.14 UseApplicationProperties.getSharedHomeDirectory()
(plugins) or the sharedHome Spring bean (core)String
getWebAppContextPath()
Deprecated.since 7.14 UseContextPathHolder.getContextPath()
boolean
isWebAppContextPathSet()
Deprecated.since 7.14 UseContextPathHolder.getContextPath()
void
setConfluenceHome(String confluenceHome)
Deprecated.since 7.14void
setWebAppContextPath(String webAppContextPath)
Deprecated.since 7.14-
Methods inherited from interface com.atlassian.config.bootstrap.AtlassianBootstrapManager
bootstrapDatabase, bootstrapDatasource, databaseContainsExistingData, getApplicationConfig, getBootstrapFailureReason, getBuildNumber, getHibernateConfig, getHibernateConfigurator, getHibernateProperties, getOperation, getPropertiesWithPrefix, getProperty, getPropertyKeys, getSetupPersister, getString, getTestDatabaseConnection, getTestDatasourceConnection, init, isApplicationHomeValid, isBootstrapped, isPropertyTrue, isSetupComplete, publishConfiguration, removeProperty, save, setBuildNumber, setHibernateConfigurator, setOperation, setProperty, setSetupComplete
-
-
-
-
Field Detail
-
JWT_PRIVATE_KEY
static final String JWT_PRIVATE_KEY
- Since:
- 6.0
- See Also:
- Constant Field Values
-
JWT_PUBLIC_KEY
static final String JWT_PUBLIC_KEY
- See Also:
- Constant Field Values
-
JWT_KEY_LENGTH
static final String JWT_KEY_LENGTH
- See Also:
- Constant Field Values
-
SYNCHRONY_SERVICE_AUTHTOKEN
static final String SYNCHRONY_SERVICE_AUTHTOKEN
- Since:
- 8.1
- See Also:
- Constant Field Values
-
-
Method Detail
-
getConfluenceHome
@Deprecated String getConfluenceHome()
Deprecated.since 5.5. UseApplicationProperties.getHomeDirectory()
(plugins) or confluenceHome Spring bean (core)Returns local home in standalone installation and shared home in clustered installation.- Returns:
- local home in standalone installation and shared home in clustered installation
-
getApplicationHome
@Deprecated String getApplicationHome()
Deprecated.since 7.14. UseApplicationProperties.getHomeDirectory()
(plugins) or confluenceHome Spring bean (core)- Specified by:
getApplicationHome
in interfacecom.atlassian.config.bootstrap.AtlassianBootstrapManager
-
getSharedHome
@Deprecated File getSharedHome()
Deprecated.since 7.14 UseApplicationProperties.getSharedHomeDirectory()
(plugins) or the sharedHome Spring bean (core)Confluence shared home directory.This directory is shared between all nodes in a cluster. In non-clustered installations without a shared directory, directory called "shared-home" inside local home directory is returned instead.
This directory should be used for data that can be safely shared across a cluster. Any users of this directory should take into account locking to prevent concurrency errors.
- Returns:
- shared home directory
- Since:
- 5.5
-
getLocalHome
@Deprecated File getLocalHome()
Deprecated.since 7.14 UseApplicationProperties.getLocalHomeDirectory()
(plugins) or the localHome Spring bean (core)Confluence local home directory.This directory is only visible to the local node in a cluster.
This directory should be used for data that must be node specific and cannot be shared between cluster nodes.
- Returns:
- local home directory
- Since:
- 5.5
-
setConfluenceHome
@Deprecated void setConfluenceHome(String confluenceHome) throws com.atlassian.config.ConfigurationException
Deprecated.since 7.14- Throws:
com.atlassian.config.ConfigurationException
-
getConfiguredLocalHome
@Deprecated File getConfiguredLocalHome()
Deprecated.since 7.14. UseApplicationProperties.getLocalHomeDirectory()
(plugins) or localHome Spring bean (core)Returns the configured local home or null if not configured.Only bootstrap code should need this method. Most code should use
getLocalHome()
instead.- Returns:
- configured local home
- Since:
- 5.5
-
getConfiguredApplicationHome
@Deprecated String getConfiguredApplicationHome()
Deprecated.since 7.14. UseApplicationProperties.getHomeDirectory()
(plugins) or confluenceHome Spring bean (core)- Specified by:
getConfiguredApplicationHome
in interfacecom.atlassian.config.bootstrap.AtlassianBootstrapManager
-
getWebAppContextPath
@Deprecated String getWebAppContextPath()
Deprecated.since 7.14 UseContextPathHolder.getContextPath()
-
setWebAppContextPath
@Deprecated void setWebAppContextPath(String webAppContextPath) throws com.atlassian.config.ConfigurationException
Deprecated.since 7.14- Throws:
com.atlassian.config.ConfigurationException
-
isWebAppContextPathSet
@Deprecated boolean isWebAppContextPathSet()
Deprecated.since 7.14 UseContextPathHolder.getContextPath()
-
checkConfigurationOnStartup
void checkConfigurationOnStartup() throws com.atlassian.config.bootstrap.BootstrapException
- Throws:
com.atlassian.config.bootstrap.BootstrapException
-
cleanupOnShutdown
void cleanupOnShutdown()
If there's any resource that needs to be cleaned up, do it here.
-
getDataSourceName
Optional<String> getDataSourceName()
Returns the name of the JNDI-based DataSource, if any.- Returns:
- empty if Confluence is using a direct JDBC connection
- Since:
- 6.7.0
-
getHibernateDialect
String getHibernateDialect()
Returns the SQL dialect being used by Hibernate.- Returns:
- see above
- Since:
- 6.7.0
- See Also:
AvailableSettings.DIALECT
-
bootstrapSharedConfiguration
@Deprecated void bootstrapSharedConfiguration(SharedConfigurationMap sharedConfig) throws com.atlassian.config.bootstrap.BootstrapException
Deprecated.since 5.9Starts Confluence with a database configuration that has been retrieved from another cluster node.- Throws:
com.atlassian.config.bootstrap.BootstrapException
- Since:
- 2.3
-
getFilePathProperty
@Deprecated String getFilePathProperty(String key)
Deprecated.since 7.14 UseConfluenceDirectories
- Specified by:
getFilePathProperty
in interfacecom.atlassian.config.bootstrap.AtlassianBootstrapManager
-
-