Package org.gridgain.internal.cdc.api

Interface CdcManager

All Superinterfaces:
org.apache.ignite.internal.lang.Debuggable, org.apache.ignite.internal.manager.IgniteComponent
public interface CdcManager extends org.apache.ignite.internal.manager.IgniteComponent
Manager for CDC. Provides methods to create, delete, retrieve, list, and update main entities.

  • Method Details

    • createSource

      CompletableFuture<Void> createSource(SourceDefinition sourceDefinition)
      Creates a new source.
      Parameters:
      sourceDefinition - The definition of the source to create.
      Returns:
      A future that will be completed when the source is created.

    • deleteSource

      CompletableFuture<Void> deleteSource(String sourceName)
      Deletes a source by its name.
      Parameters:
      sourceName - The name of the source to delete.
      Returns:
      A future that will be completed when the source is deleted.

    • getSource

      CompletableFuture<SourceDefinition> getSource(String sourceName)
      Retrieves a source by its name.
      Parameters:
      sourceName - The name of the source to retrieve.
      Returns:
      A future that will be completed with the source definition when retrieved.

    • listSources

      CompletableFuture<Collection<SourceDefinition>> listSources()
      Lists all sources.
      Returns:
      A future that will be completed with a collection of all source definitions.

    • updateSource

      CompletableFuture<Void> updateSource(SourceDefinition source)
      Updates an existing source.
      Parameters:
      source - The updated source definition.
      Returns:
      A future that will be completed when the source is updated.

    • getSourceStatus

      CompletableFuture<SourceStatus> getSourceStatus(String name)
      Retrieves the status of a source by its name. Status contains information like the source health and connectivity.
      Parameters:
      name - The name of the source.
      Returns:
      A future that will be completed with the source status when retrieved.

    • createSink

      CompletableFuture<Void> createSink(SinkDefinition sinkDefinition)
      Creates a new sink.
      Parameters:
      sinkDefinition - The definition of the sink to create.
      Returns:
      A future that will be completed when the sink is created.

    • deleteSink

      CompletableFuture<Void> deleteSink(String sinkName)
      Deletes a sink by its name.
      Parameters:
      sinkName - The name of the sink to delete.
      Returns:
      A future that will be completed when the sink is deleted.

    • getSink

      CompletableFuture<SinkDefinition> getSink(String sinkName)
      Retrieves a sink by its name.
      Parameters:
      sinkName - The name of the sink to retrieve.
      Returns:
      A future that will be completed with the sink definition when retrieved.

    • listSinks

      CompletableFuture<Collection<SinkDefinition>> listSinks()
      Lists all sinks.
      Returns:
      A future that will be completed with a collection of all sink definitions.

    • updateSink

      CompletableFuture<Void> updateSink(SinkDefinition sink)
      Updates an existing sink.
      Parameters:
      sink - The updated sink definition.
      Returns:
      A future that will be completed when the sink is updated.

    • getSinkStatus

      CompletableFuture<SinkStatus> getSinkStatus(String name)
      Retrieves the status of a sink by its name. Status contains information like the sink health and connectivity.
      Parameters:
      name - The name of the source.
      Returns:
      A future that will be completed with the source status when retrieved.

    • createReplication

      CompletableFuture<CdcReplicationInstance> createReplication(CdcReplicationDefinition replicationDefinition)
      Creates a new replication.
      Parameters:
      replicationDefinition - The definition of the replication to create.
      Returns:
      A future that will be completed when the replication is created.

    • deleteReplication

      CompletableFuture<Void> deleteReplication(String replicationName)
      Deletes a replication by its name.
      Parameters:
      replicationName - The name of the replication to delete.
      Returns:
      A future that will be completed when the replication is deleted.

    • getReplication

      CompletableFuture<CdcReplicationInstance> getReplication(String replicationName)
      Retrieves a replication by its name.
      Parameters:
      replicationName - The name of the replication to retrieve.
      Returns:
      A future that will be completed with the replication instance when retrieved.

    • listReplications

      CompletableFuture<Collection<CdcReplicationInstance>> listReplications()
      Lists all replications.
      Returns:
      A future that will be completed with a collection of all replication instances.

    • listReplicationsByStatus

      CompletableFuture<Collection<CdcReplicationInstance>> listReplicationsByStatus(CdcReplicationStatus status)
      Lists all replications filtered by their status.
      Parameters:
      status - The status to filter replications by.
      Returns:
      A future that will be completed with a collection of replication instances matching the specified status.

    • startReplication

      CompletableFuture<CdcReplicationInstance> startReplication(String replicationName)
      Starts a replication by its name. The replication must be in a state that allows it to be started.
      Parameters:
      replicationName - The name of the replication to start.
      Returns:
      A future that will be completed with the started replication instance when the operation is successful.

    • stopReplication

      CompletableFuture<CdcReplicationInstance> stopReplication(String replicationName)
      Stops a replication by its name. The replication must be in a state that allows it to be stopped.
      Parameters:
      replicationName - The name of the replication to stop.
      Returns:
      A future that will be completed with the stopped replication instance when the operation is successful.

    • updateReplication

      CompletableFuture<Void> updateReplication(CdcReplicationInstance replicationInstance)
      Updates an existing replication instance. This method is for internal use by failover mechanisms.
      Parameters:
      replicationInstance - The updated replication instance.
      Returns:
      A future that will be completed when the replication is updated.