MAN page from Fedora 4 perl-Net-LDAP-0.3202-1.2.fc4.rf.noarch.rpm

Net::LDAP::Control::PersistentSearch

Section: User Contributed Perl Documentation (3)
Updated: 2004-07-19
Index

NAME

Net::LDAP::Control::PersistentSearch - LDAPv3 Persistent Search control object

SYNOPSIS

 use Net::LDAP; use Net::LDAP::Control::PersistentSearch;

 $ldap = Net::LDAP->new( "ldap.mydomain.eg" );

 $persist = Net::LDAP::Control::PersistentSearch->new( changeTypes => 15,                                                       changesOnly => 1,                                                       returnECs => 1 );

 $srch = $ldap->search( base     => "cn=People,dc=mydomain,dc=eg",                        filter   => "(objectClass=person)",                        callback => \&process_entry, # call for each entry                        control  => [ $persist ] );

 die "error: ",$srch->code(),": ",$srch->error()  if ($srch->code());

 sub process_entry {   my $message = shift;   my $entry = shift;

   print $entry->dn()."\n"; }

DESCRIPTION

"Net::LDAP::Control::PersistentSearch" provides an interface for the creationand manipulation of objects that represent the "PersistentSearch" control asdescribed by draft-smith-psearch-ldap-01.txt.

CONSTRUCTOR ARGUMENTS

In addition to the constructor arguments described inNet::LDAP::Control the following are provided.

changeTypes

An integer value determining the types of changes to look out for.It is the bitwise OR of the following values (which represent the LDAPoperations indicated next to them):

1 = add
2 = delete
4 = modify
8 = modDN

: If it is not given it defaults to 15 meaning all changes.

changesOnly

A boolean value telling whether the server may returnentries that match the search criteria.

If "TRUE" the server must not return return any existingentries that match the search criteria. Entries are onlyreturned when they are changed (added, modified, deleted, orsubject to a modifyDN operation)

returnECs

If "TRUE", the server must return an Entry Change Notificationcontrol with each entry returned as the result of changes.

See Net::LDAP::Control::EntryChange for details.

METHODS

As with Net::LDAP::Control each constructor argumentdescribed above is also available as a method on the object which willreturn the current value for the attribute if called without an argument,and set a new value for the attribute if called with an argument.

AUTHOR

Peter Marschall <peterAATTadpm.de>, based on Net::LDAP::Control::Pagefrom Graham Barr <gbarrAATTpobox.com> and the preparatory workof Don Miller <donmAATTuidaho.edu>.

Please report any bugs, or post any suggestions, to the perl-ldapmailing list <perl-ldapAATTperl.org>

COPYRIGHT

This document was created byman2html,using the manual pages.