org.opends.server.api

Interface ImportTaskListener

All Known Implementing Classes:

MultimasterReplication, PasswordPolicyImportPlugin

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

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

Method Summary

Modifier and Type	Method and Description
void	processImportBegin(LocalBackend<?> backend, LDIFImportConfig config) Performs any processing that might be necessary just before the server begins processing on an LDIF import task.
void	processImportEnd(LocalBackend<?> backend, LDIFImportConfig config, boolean successful) Performs any processing that might be necessary after the server has completed processing on an LDIF import task.

Method Detail

processImportBegin

void processImportBegin(LocalBackend<?> backend,
                        LDIFImportConfig config)

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.

Parameters:

backend - The backend to be imported.

config - Configuration information about the LDIF import to be performed.

processImportEnd

void processImportEnd(LocalBackend<?> backend,
                      LDIFImportConfig config,
                      boolean successful)

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.

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.