Package org.apache.kafka.connect.connector

Interface ConnectorContext

All Known Subinterfaces:
SinkConnectorContext, SourceConnectorContext
public interface ConnectorContext
ConnectorContext allows Connectors to proactively interact with the Kafka Connect runtime.

  • Method Details

    • requestTaskReconfiguration

      void requestTaskReconfiguration()
      Requests that the runtime reconfigure the Tasks for this source. This should be used to indicate to the runtime that something about the input/output has changed (e.g. partitions added/removed) and the running Tasks will need to be modified.

    • raiseError

      void raiseError(Exception e)
      Raise an unrecoverable exception to the Connect framework. This will cause the status of the connector to transition to FAILED.
      Parameters:
      e - Exception to be raised.

    • pluginMetrics

      PluginMetrics pluginMetrics()
      Get a PluginMetrics that can be used to define metrics

      This method was added in Apache Kafka 4.1. Connectors that use this method but want to maintain backward compatibility so they can also be deployed to older Connect runtimes should guard the call to this method with a try-catch block, since calling this method will result in a NoSuchMethodError or NoClassDefFoundError when the connector is deployed to Connect runtimes older than Kafka 4.1. For example: 

           PluginMetrics pluginMetrics;
     try {
         pluginMetrics = context.pluginMetrics();
     } catch (NoSuchMethodError | NoClassDefFoundError e) {
         pluginMetrics = null;
     }
      Returns:
      the pluginMetrics instance
      Since:
      4.1