Interface GatewaySink

All Known Implementing Classes:
DefaultGatewaySink

public interface GatewaySink
A sink is a GatewayProcessingUnit component which handles incoming replication from other gateways. The sink is also used to bootstrap a space from another space, and it takes part in both sides of the bootstrap process. It is used for initiating a bootstrap process and replicate incoming data of the bootstrap process to the local Space. And it is used to respond to a remote bootstrap request by providing the relevant bootstrap data to the remote sink.
Since:
8.0.4
Author:
eitany
  • Method Details

    • getGatewayProcessingUnit

      GatewayProcessingUnit getGatewayProcessingUnit()
      Returns the gateway this sink is part of.
    • enableIncomingReplication

      void enableIncomingReplication()
      Enables incoming replication for this sink, only relevant if this sink requiresBootstrapOnStartup() and no bootstrap was executed yet, otherwise the sink incoming replication is already enabled.
    • getSources

      GatewaySinkSource[] getSources()
      Returns the gateway sink sources of this sink.
    • containsSource

      boolean containsSource(String sourceGatewayName)
      Returns true if this sink has a source gateway with the specified name; false otherwise.
    • getSourceByName

      GatewaySinkSource getSourceByName(String sourceGatewayName)
      Returns a gateway sink source for the specified source gateway name or null if no such gateway sink source exists.
    • requiresBootstrapOnStartup

      boolean requiresBootstrapOnStartup()
      Returns whether this sink is configured to require a bootstrap on startup.
    • getLocalSpaceUrl

      String getLocalSpaceUrl()
      Returns the url of the space this sink is replicating in to.