Package com.inductiveautomation.historian.gateway.api.storage.realtime

Interface DataCollector

All Known Implementing Classes:
DataCollectorDelegate, DataCollectorFactory.AbstractDataCollector, DataCollectorFactory.ManualDataCollector, DataCollectorFactory.StreamingDataCollector, ErroredDataCollector
public interface DataCollector
Provides a contract for interacting with data nodes, managing their lifecycle, and facilitating operations like data collection, metadata updates, and source changes. The DataCollector implementation acts as a middleware for handling data-related functionalities across various data nodes.

  • Method Details

    • createNodeSession

      DataNodeSession createNodeSession(QualifiedPath source, DataType dataType, PropertySet configuration)
      Creates a new session for interacting with a data node. This session allows processing various operations like data changes, metadata updates, and source changes for the specified node. It provides a dedicated context for managing the lifecycle and state of a data node.
      Parameters:
      source - The QualifiedPath representing the source of the data node.
      dataType - The DataType specifying the type of data handled by the session.
      configuration - A PropertySet containing the configuration properties for the session.
      Returns:
      A DataNodeSession instance for managing operations and observing state changes for the specified data node.

    • executeDataCollection

      CompletionStage<Void> executeDataCollection(CollectionContext context)
      Executes the data collection process using the provided context. This operation initiates data retrieval or aggregation based on the configuration and parameters specified in the CollectionContext instance. The process could include handling periodic or one-time data collections, as well as processing heartbeat operations if indicated in the context.
      Parameters:
      context - The CollectionContext object encapsulating all necessary details for the data collection operation, such as identifiers, source, interval, timestamp, and value origin.
      Returns:
      A CompletionStage that completes when the data collection process is finished. If any errors occur during the operation, the CompletionStage will complete exceptionally.

    • shutdown

      CompletionStage<Void> shutdown()
      Initiates an orderly shutdown of this DataCollector. This operation will:
      1. Stop accepting new data points or node sessions
      2. Process and flush any remaining queued data
      3. Close all active DataNodeSessions
      4. Release any system resources
      After calling this method, the DataCollector instance should be considered unusable and any subsequent method calls will result in undefined behavior.
      Returns:
      A CompletionStage that completes normally when shutdown is finished, or completes exceptionally if errors occurred during shutdown

    • identifier

      CollectorId identifier()
      Retrieves the unique identifier for this data collector. The identifier is used to distinguish between different data collectors and is essential for managing and referencing the collector in various operations.
      Returns:
      The CollectorId representing the unique identifier of this data collector.