Package com.atlassian.confluence.setup.settings

Interface ConfluenceDirectories

@ParametersAreNonnullByDefault @ReturnValuesAreNonnullByDefault public interface ConfluenceDirectories
Provides operations to obtain the location of various filesystem directory locations used by Confluence.
Since:
7.14

  • Method Details

    • getTempDirectory

      Path getTempDirectory()
      Returns:
      The Path of the directory for storing temporary files.
      Throws:
      IllegalStateException - if the directory has not yet been configured (e.g. during setup)

    • getLuceneIndexDirectory

      @Internal Path getLuceneIndexDirectory()
      Returns:
      The Path of the directory for storing the Lucene index.
      Throws:
      IllegalStateException - if the directory has not yet been configured (e.g. during setup)

    • getLegacyTempDirectory

      @Deprecated static File getLegacyTempDirectory()
      Deprecated.
      since 7.14 Use getTempDirectory()
      A legacy convenience method for obtaining the temp directory path statically.

    • getLegacyTempDirectory

      @Deprecated static File getLegacyTempDirectory(com.atlassian.config.bootstrap.AtlassianBootstrapManager bootstrapManager)
      Deprecated.
      since 7.14 Use getTempDirectory()
      A legacy convenience method for obtaining the temp directory path statically.

    • getLegacyLuceneIndexDirectory

      @Deprecated @Internal static File getLegacyLuceneIndexDirectory()
      Deprecated.
      since 7.14 Use getLuceneIndexDirectory()
      A legacy convenience method for obtaining the Lucene index directory path statically.

    • getLegacyLuceneIndexDirectory

      @Deprecated @Internal static File getLegacyLuceneIndexDirectory(com.atlassian.config.bootstrap.AtlassianBootstrapManager bootstrapManager)
      Deprecated.
      since 7.14 Use getLuceneIndexDirectory()
      A legacy convenience method for obtaining the Lucene index directory path statically.