org.forgerock.opendj.server.core

Interface ImportableDataProvider

public interface ImportableDataProvider

A data provider which supports LDIF import functionality.

FIXME: the async APIs used below are a bad fit. We do not want to return an LdapException. We really need a more generic promises API.

FIXME: it would be nice if we can use EntryReader, however we may need to provide an optimized implementation for use in multi-threaded imports. E.g. performing DN checking as early as possible before doing schema validation.

FIXME: import allows you to append, merge, replace entries. Do we need to expose that here?

Method Summary

Methods

Modifier and Type	Method and Description
DataProviderID	getDataProviderID() Returns the ID of this data provider.
org.forgerock.opendj.ldap.LdapPromise<Void>	importEntries(org.forgerock.opendj.ldif.EntryReader reader, org.forgerock.opendj.ldap.LdapResultHandler<Void> handler) Imports the contents of this data provider from the provided entry reader.

Method Detail

getDataProviderID

DataProviderID getDataProviderID()

Returns the ID of this data provider.

Returns:

The ID of this data provider.

importEntries

org.forgerock.opendj.ldap.LdapPromise<Void> importEntries(org.forgerock.opendj.ldif.EntryReader reader,
                                                        org.forgerock.opendj.ldap.LdapResultHandler<Void> handler)

Imports the contents of this data provider from the provided entry reader.

Note that the server will not explicitly initialize this data provider before calling this method.

Parameters:

reader - The entry reader.

handler - A handler which will be notified when the import completes.

Returns:

A promise representing the completion of the import.