Package com.inductiveautomation.historian.gateway.api

Interface HistorianManager

All Known Implementing Classes:
HistorianManagerImpl
public interface HistorianManager
The HistorianManager interface defines methods for retrieving and managing historian-related components in the system. It provides functionality to obtain historian names, storage engines, and query engines based on the historian identifier.

  • Method Details

    • getHistorianNames

      Collection<String> getHistorianNames()
      Retrieves a collection of historian names available in the system.
      Returns:
      a Collection of String representing the names of available historians

    • getStorageEngine

      Optional<StorageEngine> getStorageEngine(String historianName)
      Retrieves the StorageEngine associated with the specified historian name, if available. The StorageEngine serves as the interface for managing data storage and retrieval operations for the given historian.
      Parameters:
      historianName - the name of the historian for which the storage engine is to be retrieved; must not be null
      Returns:
      an Optional containing the StorageEngine if one is available for the specified historian, or an empty Optional otherwise

    • getQueryEngine

      Optional<QueryEngine> getQueryEngine(String historianName)
      Retrieves the QueryEngine associated with the specified historian name, if available. The QueryEngine provides methods for querying historical data managed by the specified historian.
      Parameters:
      historianName - the name of the historian for which the query engine is to be retrieved; must not be null
      Returns:
      an Optional containing the QueryEngine if one is available for the specified historian, or an empty Optional otherwise

    • get

      static HistorianManager get(GatewayContext context)
      Retrieves the HistorianManager associated with the given GatewayContext.
      Parameters:
      context - the GatewayContext instance used to retrieve the HistorianManager; must not be null
      Returns:
      the HistorianManager associated with the provided GatewayContext