1 .TH SLAPD-PERL 5 "25 April 2002" "OpenLDAP LDVERSION"
4 slapd-perl \- Perl backend to slapd
14 Any perl database section of the configuration file
16 must then specify what Perl module to use.
18 then creates a new Perl object that handles all the requests for that
19 particular instance of the backend.
21 You will need to create a method for each one of the
25 * new # creates a new object,
26 * search # performs the ldap search,
27 * compare # does a compare,
28 * modify # modifies an entry,
29 * add # adds an entry to backend,
30 * modrdn # modifies an entry's rdn,
31 * delete # deletes an ldap entry,
32 * config # process unknown config file lines,
33 * init # called after backend is initialized.
36 Unless otherwise specified, the methods return the result code
37 which will be returned to the client. Unimplemented actions
38 can just return unwillingToPerform (53).
41 This method is called when the configuration file encounters a
44 The module in that line is then effectively `use'd into the perl
45 interpreter, then the \fBnew\fR method is called to create a new
47 Note that multiple instances of that object may be instantiated, as
52 method receives the class name as argument.
55 This method is called when a search request comes from a client.
56 It arguments are as follows:
61 * alias deferencing policy
65 * attributes only flag (1 for yes)
66 * list of attributes that are to be returned (may be empty).
69 Return value: (resultcode, ldif-entry, ldif-entry, ...)
72 This method is called when a compare request comes from a client.
73 Its arguments are as follows.
77 * attribute assertion string
82 This method is called when a modify request comes from a client.
83 Its arguments are as follows.
87 * a list formatted as follows
88 { "ADD" | "DELETE" | "REPLACE" }, attributetype, value..., ...
93 This method is called when a add request comes from a client.
94 Its arguments are as follows.
97 * entry in string format.
102 This method is called when a modrdn request comes from a client.
103 Its arguments are as follows.
108 * delete old dn flag (1 means yes)
113 This method is called when a delete request comes from a client.
114 Its arguments are as follows.
122 This method is called with unknown
124 configuration file lines.
125 Its arguments are as follows.
128 * array of arguments on line
131 Return value: nonzero if this is not a valid option.
134 This method is called after backend is initialized.
135 Its argument is as follows.
140 Return value: nonzero if initialization failed.
144 options in this category apply to the PERL backend database.
145 That is, they must follow a "database perl" line and come before any
146 subsequent "backend" or "database" lines.
147 Other database options are described in the
151 .B perlModulePath /path/to/libs
152 Add the path to the @INC variable.
154 .B perlModule ModName
155 `Use' the module name ModName from ModName.pm
157 .B filterSearchResults
158 Search results are candidates that need to be filtered (with the
159 filter in the search request), rather than search results to be
160 returned directly to the client.
162 There is an example Perl module `SampleLDAP' in the slapd/back-perl/
163 direcetory in the OpenLDAP source tree.
165 The interface of this backend to the perl module MAY change.
166 Any suggestions would greatly be appreciated.