1Net::LDAP::Control::PerUssiesrteCnotnSterairbcuht(e3d)PNeertl::DLoDcAuPm:e:nCtoanttiroonl::PersistentSearch(3)
2
3
4

NAME

6       Net::LDAP::Control::PersistentSearch - LDAPv3 Persistent Search control
7       object
8

SYNOPSIS

10        use Net::LDAP;
11        use Net::LDAP::Control::PersistentSearch;
12
13        $ldap = Net::LDAP->new( "ldap.mydomain.eg" );
14
15        $persist = Net::LDAP::Control::PersistentSearch->new( changeTypes => 15,
16                                                              changesOnly => 1,
17                                                              returnECs => 1 );
18
19        $srch = $ldap->search( base     => "cn=People,dc=mydomain,dc=eg",
20                               filter   => "(objectClass=person)",
21                               callback => \&process_entry, # call for each entry
22                               control  => [ $persist ] );
23
24        die "error: ",$srch->code(),": ",$srch->error()  if ($srch->code());
25
26        sub process_entry {
27          my $message = shift;
28          my $entry = shift;
29
30          print $entry->dn()."\n";
31        }
32

DESCRIPTION

34       "Net::LDAP::Control::PersistentSearch" provides an interface for the
35       creation and manipulation of objects that represent the "Persis‐
36       tentSearch" control as described by draft-smith-psearch-ldap-01.txt.
37

CONSTRUCTOR ARGUMENTS

39       In addition to the constructor arguments described in Net::LDAP::Con‐
40       trol the following are provided.
41
42       changeTypes
43           An integer value determining the types of changes to look out for.
44           It is the bitwise OR of the following values (which represent the
45           LDAP operations indicated next to them):
46
47           1 = add
48           2 = delete
49           4 = modify
50           8 = modDN
51
52           If it is not given it defaults to 15 meaning all changes.
53
54       changesOnly
55           A boolean value telling whether the server may return entries that
56           match the search criteria.
57
58           If "TRUE" the server must not return return any existing entries
59           that match the search criteria.  Entries are only returned when
60           they are changed (added, modified, deleted, or subject to a modi‐
61           fyDN operation)
62
63       returnECs
64           If "TRUE", the server must return an Entry Change Notification con‐
65           trol with each entry returned as the result of changes.
66
67           See Net::LDAP::Control::EntryChange for details.
68

METHODS

70       As with Net::LDAP::Control each constructor argument described above is
71       also available as a method on the object which will return the current
72       value for the attribute if called without an argument, and set a new
73       value for the attribute if called with an argument.
74

SEE ALSO

76       Net::LDAP, Net::LDAP::Control, Net::LDAP::Control::EntryChange
77

AUTHOR

79       Peter Marschall <peter@adpm.de>, based on Net::LDAP::Control::Page from
80       Graham Barr <gbarr@pobox.com> and the preparatory work of Don Miller
81       <donm@uidaho.edu>.
82
83       Please report any bugs, or post any suggestions, to the perl-ldap mail‐
84       ing list <perl-ldap@perl.org>
85

87       Copyright (c) 2004 Peter Marschall. All rights reserved. This program
88       is free software; you can redistribute it and/or modify it under the
89       same terms as Perl itself.
90
91
92
93perl v5.8.8                       2007-0N2e-t1:0:LDAP::Control::PersistentSearch(3)
Impressum