org.opends.server.api
Interface BackupTaskListener

All Known Implementing Classes:

MultimasterReplication, ReplicationServer

@PublicAPI(stability=VOLATILE,
           mayInstantiate=false,
           mayExtend=true,
           mayInvoke=false)
public interface BackupTaskListener

This interface defines a set of methods that may be used to notify various Directory Server components whenever a backend backup task is about to begin or has just completed. Note that these methods will only be invoked for the backup task and not for offline backup processing.

Method Summary

void	processBackupBegin(Backend backend, BackupConfig config) Performs any processing that might be necessary just before the server begins processing on a backup task.
void	processBackupEnd(Backend backend, BackupConfig config, boolean successful) Performs any processing that might be necessary after the server has completed processing on a backup task.

Method Detail

processBackupBegin

void processBackupBegin(Backend backend,
                        BackupConfig config)

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.

Parameters:

backend - The backend to be archived.

config - Configuration information about the backup to be performed.

processBackupEnd

void processBackupEnd(Backend backend,
                      BackupConfig config,
                      boolean successful)

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.

Parameters:

backend - The backend that was archived.

config - Configuration information about the backup that was performed.

successful - Indicates whether the backup operation completed successfully.