Package org.forgerock.opendj.server.leaderbasedreplication

Class LeaderBasedReplication

java.lang.Object
org.opends.server.api.SynchronizationProvider<LeaderBasedReplicationSynchronizationProviderCfg>
org.forgerock.opendj.server.leaderbasedreplication.LeaderBasedReplication
All Implemented Interfaces:
ConfigurationChangeListener<ReplicationSynchronizationProviderCfg>, BackupTaskListener, ExportTaskListener, ImportTaskListener, RestoreTaskListener, HealthStatusProvider, ShutdownSynchronizer
public final class LeaderBasedReplication extends SynchronizationProvider<LeaderBasedReplicationSynchronizationProviderCfg> implements ConfigurationChangeListener<ReplicationSynchronizationProviderCfg>, BackupTaskListener, RestoreTaskListener, ImportTaskListener, ExportTaskListener, HealthStatusProvider, ShutdownSynchronizer
The entry point of the Leader Based Replication.

  • Constructor Details

    • LeaderBasedReplication

      public LeaderBasedReplication()

  • Method Details

    • initializeSynchronizationProvider

      public void initializeSynchronizationProvider(ServerContext serverContext, LeaderBasedReplicationSynchronizationProviderCfg config)
      Description copied from class: SynchronizationProvider
      Performs any initialization that might be necessary for this synchronization provider.
      Specified by:
      initializeSynchronizationProvider in class SynchronizationProvider<LeaderBasedReplicationSynchronizationProviderCfg>
      Parameters:
      serverContext - The server context.
      config - The configuration information for this synchronization provider.

    • start

      public void start(ExecutionContext context)
      Starts the replication provider functionality. For use in the simulator.
      Parameters:
      context - the execution context

    • stop

      public void stop()
      Stops the replication provider functionality. For use in the simulator.

    • finalizeSynchronizationProvider

      public void finalizeSynchronizationProvider()
      Description copied from class: SynchronizationProvider
      Performs any necessary finalization for this synchronization provider. This will be called just after the provider has been unregistered with the server but before it has been unloaded.
      Overrides:
      finalizeSynchronizationProvider in class SynchronizationProvider<LeaderBasedReplicationSynchronizationProviderCfg>

    • isConfigurationChangeAcceptable

      public boolean isConfigurationChangeAcceptable(ReplicationSynchronizationProviderCfg configuration, List<LocalizableMessage> unacceptableReasons)
      Description copied from interface: ConfigurationChangeListener
      Indicates whether the proposed change to the configuration is acceptable to this change listener.
      Specified by:
      isConfigurationChangeAcceptable in interface ConfigurationChangeListener<ReplicationSynchronizationProviderCfg>
      Parameters:
      configuration - The new configuration containing the changes.
      unacceptableReasons - A list that can be used to hold messages about why the provided configuration is not acceptable.
      Returns:
      Returns true if the proposed change is acceptable, or false if it is not.

    • applyConfigurationChange

      public ConfigChangeResult applyConfigurationChange(ReplicationSynchronizationProviderCfg configuration)
      Description copied from interface: ConfigurationChangeListener
      Applies the configuration changes to this change listener.
      Specified by:
      applyConfigurationChange in interface ConfigurationChangeListener<ReplicationSynchronizationProviderCfg>
      Parameters:
      configuration - The new configuration containing the changes.
      Returns:
      Returns information about the result of changing the configuration.

    • processBackupBegin

      public void processBackupBegin(LocalBackend<?> backend)
      Description copied from interface: BackupTaskListener
      Performs any processing that might be necessary just before the server begins processing on a backup task. This may include flushing any outstanding writes to disk so they are included in the backup and/or pausing interaction with the provided backend while the backup is in progress.
      Specified by:
      processBackupBegin in interface BackupTaskListener
      Parameters:
      backend - The backend to be archived.

    • processBackupEnd

      public void processBackupEnd(LocalBackend<?> backend)
      Description copied from interface: BackupTaskListener
      Performs any processing that might be necessary after the server has completed processing on a backup task. Note that this will always be called when backup processing completes, regardless of whether it was successful.
      Specified by:
      processBackupEnd in interface BackupTaskListener
      Parameters:
      backend - The backend that was archived.

    • processExportBegin

      public void processExportBegin(LocalBackend<?> backend, LDIFExportConfig config)
      Description copied from interface: ExportTaskListener
      Performs any processing that might be necessary just before the server begins processing on an LDIF export task. This may include flushing any outstanding writes to disk so they are included in the export and/or pausing interaction with the provided backend while the export is in progress.
      Specified by:
      processExportBegin in interface ExportTaskListener
      Parameters:
      backend - The backend to be exported.
      config - Configuration information about the LDIF export to be performed.

    • processExportEnd

      public void processExportEnd(LocalBackend<?> backend, LDIFExportConfig config, boolean successful)
      Description copied from interface: ExportTaskListener
      Performs any processing that might be necessary after the server has completed processing on an LDIF export task. Note that this will always be called when export processing completes, regardless of whether it was successful.
      Specified by:
      processExportEnd in interface ExportTaskListener
      Parameters:
      backend - The backend that was exported.
      config - Configuration information about the LDIF export that was performed.
      successful - Indicates whether the export operation completed successfully.

    • processImportBegin

      public void processImportBegin(LocalBackend<?> backend, LDIFImportConfig config)
      Description copied from interface: ImportTaskListener
      Performs any processing that might be necessary just before the server begins processing on an LDIF import task. This should include pausing interaction with the provided backend while the import is in progress.
      Specified by:
      processImportBegin in interface ImportTaskListener
      Parameters:
      backend - The backend to be imported.
      config - Configuration information about the LDIF import to be performed.

    • processImportEnd

      public void processImportEnd(LocalBackend<?> backend, LDIFImportConfig config, boolean successful)
      Description copied from interface: ImportTaskListener
      Performs any processing that might be necessary after the server has completed processing on an LDIF import task. Note that this will always be called when import processing completes, regardless of whether it was successful.
      Specified by:
      processImportEnd in interface ImportTaskListener
      Parameters:
      backend - The backend that was imported.
      config - Configuration information about the LDIF import that was performed.
      successful - Indicates whether the import operation completed successfully.

    • processRestoreBegin

      public void processRestoreBegin(LocalBackend<?> backend)
      Description copied from interface: RestoreTaskListener
      Performs any processing that might be necessary just before the server begins processing on a restore task. This should include pausing interaction with the provided backend while the restore is in progress.
      Specified by:
      processRestoreBegin in interface RestoreTaskListener
      Parameters:
      backend - The backend to be restored.

    • processRestoreEnd

      public void processRestoreEnd(LocalBackend<?> backend)
      Description copied from interface: RestoreTaskListener
      Performs any processing that might be necessary after the server has completed processing on a restore task. Note that this will always be called when restore processing completes, regardless of whether it was successful.
      Specified by:
      processRestoreEnd in interface RestoreTaskListener
      Parameters:
      backend - The backend that was restored.

    • doPreOperation

      public void doPreOperation(PreOperationAddOperation addOperation)
      Description copied from class: SynchronizationProvider
      Performs any necessary synchronization processing that may be needed before the provided add operation is performed. This method will be invoked immediately before processing the add operation in the backend.
      Specified by:
      doPreOperation in class SynchronizationProvider<LeaderBasedReplicationSynchronizationProviderCfg>
      Parameters:
      addOperation - The add operation to be processed.

    • doPostOperation

      public void doPostOperation(PostOperationAddOperation addOperation)
      Description copied from class: SynchronizationProvider
      Performs any necessary synchronization processing that may be needed after the provided add operation is performed. This method will be invoked immediately after processing the add operation in the backend and releasing the lock on the target entry.
      Specified by:
      doPostOperation in class SynchronizationProvider<LeaderBasedReplicationSynchronizationProviderCfg>
      Parameters:
      addOperation - The add operation to be processed.

    • doPreOperation

      public void doPreOperation(PreOperationDeleteOperation deleteOperation)
      Description copied from class: SynchronizationProvider
      Performs any necessary synchronization processing that may be needed before the provided delete operation is performed. This method will be invoked immediately before processing the delete operation in the backend.
      Specified by:
      doPreOperation in class SynchronizationProvider<LeaderBasedReplicationSynchronizationProviderCfg>
      Parameters:
      deleteOperation - The delete operation to be processed.

    • doPostOperation

      public void doPostOperation(PostOperationDeleteOperation deleteOperation)
      Description copied from class: SynchronizationProvider
      Performs any necessary synchronization processing that may be needed after the provided delete operation is performed. This method will be invoked immediately after processing the delete operation in the backend and releasing the lock on the target entry.
      Specified by:
      doPostOperation in class SynchronizationProvider<LeaderBasedReplicationSynchronizationProviderCfg>
      Parameters:
      deleteOperation - The delete operation to be processed.

    • doPreOperation

      public void doPreOperation(PreOperationModifyOperation modifyOperation)
      Description copied from class: SynchronizationProvider
      Performs any necessary synchronization processing that may be needed before the provided modify operation is performed. This method will be invoked immediately before processing the modify operation in the backend.
      Specified by:
      doPreOperation in class SynchronizationProvider<LeaderBasedReplicationSynchronizationProviderCfg>
      Parameters:
      modifyOperation - The modify operation to be processed.

    • doPostOperation

      public void doPostOperation(PostOperationModifyOperation modifyOperation)
      Description copied from class: SynchronizationProvider
      Performs any necessary synchronization processing that may be needed after the provided modify operation is performed. This method will be invoked immediately after processing the modify operation in the backend and releasing the lock on the target entry.
      Specified by:
      doPostOperation in class SynchronizationProvider<LeaderBasedReplicationSynchronizationProviderCfg>
      Parameters:
      modifyOperation - The modify operation to be processed.

    • doPreOperation

      public void doPreOperation(PreOperationModifyDNOperation modifyDNOperation)
      Description copied from class: SynchronizationProvider
      Performs any necessary synchronization processing that may be needed before the provided modify DN operation is performed. This method will be invoked immediately before processing the modify DN operation in the backend.
      Specified by:
      doPreOperation in class SynchronizationProvider<LeaderBasedReplicationSynchronizationProviderCfg>
      Parameters:
      modifyDNOperation - The modify DN operation to be processed.

    • doPostOperation

      public void doPostOperation(PostOperationModifyDNOperation modifyDNOperation)
      Description copied from class: SynchronizationProvider
      Performs any necessary synchronization processing that may be needed after the provided modify DN operation is performed. This method will be invoked immediately after processing the modify DN operation in the backend and releasing the lock on the target entry.
      Specified by:
      doPostOperation in class SynchronizationProvider<LeaderBasedReplicationSynchronizationProviderCfg>
      Parameters:
      modifyDNOperation - The modify DN operation to be processed.

    • synchronizeOfflineChanges

      public void synchronizeOfflineChanges(Collection<ChangeRecord> changes)
      Description copied from class: SynchronizationProvider
      Synchronizes changes that have occurred to server data while the server was offline. This may happen when the server detects that the schema has been updated while the server was offline or if new symmetric keys have been added, e.g. when performing an offline encrypted backup or import.

      At the time this method is called, the changes will have already been applied to the local server. As such, this method must make a best effort attempt to process the associated changes, and is not allowed to throw any exceptions.

      Specified by:
      synchronizeOfflineChanges in class SynchronizationProvider<LeaderBasedReplicationSynchronizationProviderCfg>
      Parameters:
      changes - The set of changes that have been made to the server while it was offline.

    • getHealthStatus

      public HealthStatus getHealthStatus()
      Description copied from interface: HealthStatusProvider
      Returns the HealthStatus for the underlying component.
      Specified by:
      getHealthStatus in interface HealthStatusProvider
      Returns:
      The HealthStatus.

    • notifyReplicaOfflineMsgHasBeenSentByDS

      public void notifyReplicaOfflineMsgHasBeenSentByDS(Dn baseDn)
      Description copied from interface: ShutdownSynchronizer
      Notifies an offline message has been sent by the DS for the provided domain.
      Specified by:
      notifyReplicaOfflineMsgHasBeenSentByDS in interface ShutdownSynchronizer
      Parameters:
      baseDn - the domain for which the offline message has been sent.

    • clearReplicaOfflineMsgNotifications

      public void clearReplicaOfflineMsgNotifications(Dn baseDn)
      Description copied from interface: ShutdownSynchronizer
      Clear the notifications for the provided domain. In other words, reset the counter of offline messages to forward to remote replication servers to zero.

      If the synchronization has failed or must be aborted for any reason, this method allows to reset the synchronizer to a clean state. For example, if a ReplicaOfflineMsg is ignored due to a DS in a bad data status, the shutdown for the peer DS should not wait for the forwarding of the message to other replication servers.

      Specified by:
      clearReplicaOfflineMsgNotifications in interface ShutdownSynchronizer
      Parameters:
      baseDn - the domain for which the notifications must be cleared

    • notifyReplicaOfflineMsgHasBeenForwardedToRS

      public void notifyReplicaOfflineMsgHasBeenForwardedToRS(Dn baseDn)
      Description copied from interface: ShutdownSynchronizer
      Notifies the offline message for the provided domain has been forwarded to a RS.
      Specified by:
      notifyReplicaOfflineMsgHasBeenForwardedToRS in interface ShutdownSynchronizer
      Parameters:
      baseDn - the domain for which the offline message has been forwarded.

    • waitForReplicaOfflineMessageToBeForwardedToRS

      public void waitForReplicaOfflineMessageToBeForwardedToRS(Dn baseDn)
      Description copied from interface: ShutdownSynchronizer
      Waits until a Replication Server can proceed with shutdown.

      The shutdown can be performed only when the offline message have been forwarded to all remote replications servers, or if the timeout has been reached.

      Specified by:
      waitForReplicaOfflineMessageToBeForwardedToRS in interface ShutdownSynchronizer
      Parameters:
      baseDn - the domain for which the offline message should be forwarded.