Interface BootstrapManager

    • Method Detail

      • getConfluenceHome

        @Deprecated
        String getConfluenceHome()
        Deprecated.
        since 5.5. Use ApplicationProperties.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. Use ApplicationProperties.getHomeDirectory() (plugins) or confluenceHome Spring bean (core)
        Specified by:
        getApplicationHome in interface com.atlassian.config.bootstrap.AtlassianBootstrapManager
      • getSharedHome

        @Deprecated
        File getSharedHome()
        Deprecated.
        since 7.14 Use ApplicationProperties.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 Use ApplicationProperties.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. Use ApplicationProperties.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. Use ApplicationProperties.getHomeDirectory() (plugins) or confluenceHome Spring bean (core)
        Specified by:
        getConfiguredApplicationHome in interface com.atlassian.config.bootstrap.AtlassianBootstrapManager
      • setWebAppContextPath

        @Deprecated
        void setWebAppContextPath​(String webAppContextPath)
                           throws com.atlassian.config.ConfigurationException
        Deprecated.
        since 7.14
        Throws:
        com.atlassian.config.ConfigurationException
      • 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.9
        Starts 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 Use ConfluenceDirectories
        Specified by:
        getFilePathProperty in interface com.atlassian.config.bootstrap.AtlassianBootstrapManager