Interface ExportableDataProvider


  • public interface ExportableDataProvider
    A data provider which supports LDIF export 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.

    • Method Detail

      • exportEntries

        org.forgerock.opendj.ldap.LdapPromise<Void> exportEntries​(org.forgerock.opendj.ldif.EntryWriter writer,
                                                                  org.forgerock.opendj.ldap.LdapResultHandler<Void> handler)
        Exports the contents of this data provider to the provided entry writer.

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

        Parameters:
        writer - The entry writer.
        handler - A handler which will be notified when the export completes.
        Returns:
        A promise representing the completion of the export.
      • getDataProviderID

        DataProviderID getDataProviderID()
        Returns the ID of this data provider.
        Returns:
        The ID of this data provider.