Net::LD...:PreRead(3)

🌸 NAME 🌸

okay so this is Net::LD...:PreRead(3) — the Net::LDAP::Control::PreRead page from the User Contributed Perl Documentation, bestie — and it's all about the LDAPv3 Pre-Read control object. ✨

---

✨ SYNOPSIS ✨

This is the exact starter pack, so copy it, run it, live it:

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::PreRead->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");
  }
}

ngl the get_value(givenName") bit is copied exactly as the page has it — we do not edit manpage code in this group chat, periodt. 💅

---

🦋 DESCRIPTION 🦋

Net::LDAP::Control::PreRead provides an interface for the creation and manipulation of objects that represent the Pre-Read Controls as described by RFC 4527. That's the whole vibe. 🫶

In modification operations, the Pre-Read request control tells the server that a copy of the original entry before the update is to be returned. After the successful completion of the operation, the accompanying Pre-Read response control lets you retrieve the original value from the server's response. Iconic behavior, honestly. 👑

One use case of this control may be to obtain replaced or deleted values of modified attributes or a copy of the entry being deleted. Practical queen energy fr fr. 💜

---

🎀 CONSTRUCTOR ARGUMENTS 🎀

On top of 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 explicitly 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 available as a method on the object. Call it with no argument and it returns the current value for the attribute; call it with an argument and it sets a new value for the attribute. Slay. 💅

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 <peter@adpm.de>

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

---

💜 COPYRIGHT 💜

Copyright (c) 2008,2011 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.

okay bye bestie, this page is perl v5.42.0, dated 2024-01-02 — mwah 💋✨