com.atlassian.confluence.setup
Interface BootstrapManager

All Superinterfaces:
com.atlassian.config.bootstrap.AtlassianBootstrapManager, ConfluenceBootstrapConstants
All Known Implementing Classes:
DefaultBootstrapManager

public interface BootstrapManager
extends com.atlassian.config.bootstrap.AtlassianBootstrapManager, ConfluenceBootstrapConstants

Controls the bootstrapping of Confluence - starting essential, core services.


Field Summary
 
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
 void bootstrapSharedConfiguration(SharedConfigurationMap sharedConfig)
          Starts Confluence with a database configuration that has been retrieved from another cluster node.
 void checkConfigurationOnStartup()
           
 String getBaseUrl()
          Deprecated. since 2.8 use getBaseUrl() on SettingsManager.getGlobalSettings() instead
 String getConfiguredConfluenceHome()
          Deprecated. since 2.8 use getConfiguredLocalHome() or AtlassianBootstrapManager.getConfiguredApplicationHome() instead
 File getConfiguredLocalHome()
          Returns the configured local home or null if not configured.
 String getConfluenceHome()
          Deprecated. since 5.5. Migrate to either getSharedHome() or getLocalHome() instead.
 String getDomainName()
          Deprecated. since 4.2 use getBaseUrl() on SettingsManager.getGlobalSettings() instead
 File getLocalHome()
          Confluence local home directory.
 File getSharedHome()
          Confluence shared home directory.
 String getWebAppContextPath()
           
 boolean isWebAppContextPathSet()
           
 void setConfluenceHome(String confluenceHome)
           
 void setWebAppContextPath(String webAppContextPath)
           
 
Methods inherited from interface com.atlassian.config.bootstrap.AtlassianBootstrapManager
bootstrapDatabase, bootstrapDatasource, databaseContainsExistingData, getApplicationConfig, getApplicationHome, getBootstrapFailureReason, getBuildNumber, getConfiguredApplicationHome, getFilePathProperty, getHibernateConfig, getHibernateConfigurator, getHibernateProperties, getOperation, getPropertiesWithPrefix, getProperty, getPropertyKeys, getSetupPersister, getString, getTestDatabaseConnection, getTestDatasourceConnection, init, isApplicationHomeValid, isBootstrapped, isPropertyTrue, isSetupComplete, publishConfiguration, removeProperty, save, setBuildNumber, setHibernateConfigurator, setOperation, setProperty, setSetupComplete
 

Method Detail

getConfluenceHome

@Deprecated
String getConfluenceHome()
Deprecated. since 5.5. Migrate to either getSharedHome() or getLocalHome() instead.

Returns local home in standalone installation and shared home in clustered installation.

Returns:
local home in standalone installation and shared home in clustered installation

getSharedHome

File getSharedHome()
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

File getLocalHome()
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

void setConfluenceHome(String confluenceHome)
                       throws com.atlassian.config.ConfigurationException
Throws:
com.atlassian.config.ConfigurationException

getBaseUrl

@Deprecated
String getBaseUrl()
Deprecated. since 2.8 use getBaseUrl() on SettingsManager.getGlobalSettings() instead


getDomainName

@Deprecated
String getDomainName()
Deprecated. since 4.2 use getBaseUrl() on SettingsManager.getGlobalSettings() instead


getConfiguredConfluenceHome

@Deprecated
String getConfiguredConfluenceHome()
Deprecated. since 2.8 use getConfiguredLocalHome() or AtlassianBootstrapManager.getConfiguredApplicationHome() instead


getConfiguredLocalHome

File getConfiguredLocalHome()
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

getWebAppContextPath

String getWebAppContextPath()

setWebAppContextPath

void setWebAppContextPath(String webAppContextPath)
                          throws com.atlassian.config.ConfigurationException
Throws:
com.atlassian.config.ConfigurationException

isWebAppContextPathSet

boolean isWebAppContextPathSet()

checkConfigurationOnStartup

void checkConfigurationOnStartup()
                                 throws com.atlassian.config.bootstrap.BootstrapException
Throws:
com.atlassian.config.bootstrap.BootstrapException

bootstrapSharedConfiguration

void bootstrapSharedConfiguration(SharedConfigurationMap sharedConfig)
                                  throws com.atlassian.config.bootstrap.BootstrapException
Starts Confluence with a database configuration that has been retrieved from another cluster node.

Throws:
com.atlassian.config.bootstrap.BootstrapException
Since:
2.3


Copyright © 2003–2015 Atlassian. All rights reserved.