Interface SystemInformationService

All Known Implementing Classes:
DefaultSystemInformationService

public interface SystemInformationService
A service for retrieving information about the system.
  • Field Details

  • Method Details

    • getDatabaseInfo

      DatabaseInfo getDatabaseInfo()
      Returns:
      information about the database configuration for the system. Should the system be in a state in which information is not available (e.g. bootstrap failed) then null will be returned.
    • getSafeDatabaseInfo

      DatabaseInfo getSafeDatabaseInfo()
      Returns:
      information about the database configuration for the system. Properties that require the direct retrieval of a database connection will be skipped. Some properties are pulled out of the system config which technically could fault through to the database, but for the most part they'll be cached.
    • getSearchInfo

      SearchInfo getSearchInfo()
      Returns:
      information about the search configuration for the system.
      Since:
      8.9
    • getConfluenceInfo

      ConfluenceInfo getConfluenceInfo()
      Returns:
      information about the Confluence build and other basic configuration for the system. Should the system be in a state in which information is not available (e.g. bootstrap failed) then null will be returned.
    • getSystemProperties

      SystemInfo getSystemProperties()
      Returns:
      various useful system information points, mainly gathered from the System properties. Regardless of system state, an instance bean will always be returned from this call.
    • getAttachmentStorageProperties

      AttachmentStorageInfo getAttachmentStorageProperties()
      Returns:
      information about the storage type used for attachment files.
    • getMemoryInfo

      MemoryInfo getMemoryInfo()
      Returns:
      information about the memory status of the system.
    • getUsageInfo

      UsageInfo getUsageInfo()
      Returns:
      information about the amount of data in the system.
    • getModifications

      Map<String,String> getModifications()
    • isShowInfoOn500

      boolean isShowInfoOn500()
    • getAccessMode

      AccessMode getAccessMode()
      Returns:
      the maintenance info
      Since:
      6.7.0
    • getMaxHTTPThreads

      Integer getMaxHTTPThreads()
      Returns:
      max number of HTTP threads configured in Tomcat
      Since:
      6.11.0
    • getHibernateProperties

      Properties getHibernateProperties()
      Returns:
      a Properties map of Hibernate properties from the application config
      Since:
      6.11.0
    • getHardwareInfo

      HardwareInfo getHardwareInfo()
      Returns:
      information about the hardware specifications of the system on which Confluence is running
      Since:
      6.11.0
    • getCloudPlatformMetadata

      Optional<CloudPlatformMetadata> getCloudPlatformMetadata()
      Returns:
      information about the cloud platform on which Confluence is running, if any
      Since:
      6.12.0
    • getClusteredDatabaseInformation

      Optional<ClusteredDatabasePlatformMetadata> getClusteredDatabaseInformation(CloudPlatformType cloudPlatformType)
      Returns:
      information about the clustered DB system to which Confluence is connected, if any
      Since:
      7.0.0
    • getSecurityInfo

      SecurityInfo getSecurityInfo()
      Returns:
      information about the security configuration of the system.
      Since:
      8.6.0
    • getIsExactSearchQueryEnabled

      Boolean getIsExactSearchQueryEnabled()
      Returns:
      ExactSearchController, to determine if the ability to perform an exact search is enabled or not.
      Since:
      9.5.0
    • getIsExactSearchIndexingEnabled

      Boolean getIsExactSearchIndexingEnabled()
      Returns:
      ExactSearchController, to determine if the ability to index exact search tokens from content is enabled or not.
      Since:
      9.5.0