unixdev.net


Switch to SpeakEasy.net DSL

The Modular Manual Browser

Home Page
Manual: (Debian-5.0)
Page:
Section:
Apropos / Subsearch:
optional field

Net::LDAP::Control::PrUserdContributed Perl DoNet::LDAP::Control::PreRead(3pm)



NAME
       Net::LDAP::Control::PreRead - LDAPv3 Pre-Read control object

SYNOPSIS
        use Net::LDAP;
        use Net::LDAP::Control::PreRead;
        use Net::LDAP::Constant qw( LDAP_CONTROL_PREREAD LDAP_SUCCESS );

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

        $preread = Net::LDAP::Control::Paged->new( attrs => [ qw/givenName/ ] );

        my $mesg = $ldap->modify( "cn=Barbara Jensen, o=University of Michigan, c=US",
                                  replace => { givenName => "Babs" },
                                  control => $preread );

        if ($mesg->code eq LDAP_SUCCESS) {
          my ($previous) = $mesg->control( LDAP_CONTROL_PREREAD );
          my $entry = $previous ? $previous->entry() : undef;

          if ($entry) {
            print "givenName changed from '" .
                  join("', '", $entry->get_value(givenName") .
                  "' to 'Babs'\n");
          }
        }

DESCRIPTION
       "Net::LDAP::Control::PreRead" provides an interface for the creation
       and manipulation of objects that represent the "Pre-Read Control" as
       described by RFC 4527.

CONSTRUCTOR ARGUMENTS
       In addition to the constructor arguments described in
       Net::LDAP::Control the following are provided.

       attrs => [ ATTR, ... ]
           A list of attributes to be returned in the entry returned in the
           response control.

           If absent, all attributes are returned.

           Operational attributes may be included in the list by explicitely
           asking for them or by using special "+" feature (provided the
           server supports this feature).

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

       In addition to these methods, the control also supports the following
       method:

       entry ()
           Returns the entry from the response control in the response message
           to the LDAP request that contained the request control.

           The result is either a Net::LDAP::Entry object or undefined.

SEE ALSO
       Net::LDAP, Net::LDAP::Control, http://www.ietf.org/rfc/rfc4527.txt

AUTHOR
       Peter Marschall <peterATadpm.de>

       Please report any bugs, or post any suggestions, to the perl-ldap
       mailing list <perl-ldapATperl.org>

COPYRIGHT
       Copyright (c) 2008 Peter Marschall. All rights reserved. This program
       is free software; you can redistribute it and/or modify it under the
       same terms as Perl itself.



perl v5.10.0                      2008-04-21  Net::LDAP::Control::PreRead(3pm)