org.opends.server.api
Interface ExportTaskListener

All Known Implementing Classes:
MultimasterReplication, ReplicationServer

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

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


Method Summary
 void processExportBegin(Backend backend, LDIFExportConfig config)
          Performs any processing that might be necessary just before the server begins processing on an LDIF export task.
 void processExportEnd(Backend backend, LDIFExportConfig config, boolean successful)
          Performs any processing that might be necessary after the server has completed processing on an LDIF export task.
 

Method Detail

processExportBegin

void processExportBegin(Backend backend,
                        LDIFExportConfig config)
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.

Parameters:
backend - The backend to be exported.
config - Configuration information about the LDIF export to be performed.

processExportEnd

void processExportEnd(Backend backend,
                      LDIFExportConfig config,
                      boolean successful)
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.

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.