Module LDAP::LDIF
In: lib/ldap/ldif.rb

This module provides the ability to process LDIF entries and files.

Methods

mods_to_ldif   parse_entry   parse_file  

Classes and Modules

Class LDAP::LDIF::Entry
Class LDAP::LDIF::LDIFError
Class LDAP::LDIF::Mod

Constants

LINE_LENGTH = 77

Public Class methods

mods_to_ldif( dn, *mods )

Given the DN, dn, convert a single LDAP::Mod or an array of LDAP::Mod objects, given in mods, to LDIF.

parse_entry( lines )

Parse the LDIF entry contained in lines and return an LDAP::Record object. lines should be an object that responds to each, such as a string or an array of lines, separated by \n characters.

parse_file( file, sort=false ) {|record| ...}

Open and parse a file containing LDIF entries. file should be a string containing the path to the file. If sort is true, the resulting array of LDAP::Record objects will be sorted on DN length, which can be useful to avoid a later attempt to process an entry whose parent does not yet exist. This can easily happen if your LDIF file is unordered, which is likely if it was produced with a tool such as slapcat(8).

If a block is given, each LDAP::Record object will be yielded to the block and nil will be returned instead of the array. This is much less memory-intensive when parsing a large LDIF file.

[Validate]