.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Net::LDAP::Control::PreRead 3"
.TH Net::LDAP::Control::PreRead 3 2024-09-01 "perl v5.40.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Net::LDAP::Control::PreRead \- LDAPv3 Pre\-Read control object
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 3
\& 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 \*(Aq" .
\&           join("\*(Aq, \*(Aq", $entry\->get_value(givenName") .
\&           "\*(Aq to \*(AqBabs\*(Aq\en");
\&   }
\& }
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\f(CW\*(C`Net::LDAP::Control::PreRead\*(C'\fR provides an interface for the creation and
manipulation of objects that represent the \f(CW\*(C`Pre\-Read Controls\*(C'\fR as described
by RFC 4527.
.PP
In modification operations, the \f(CW\*(C`Pre\-Read request control\*(C'\fR indicates to 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 \f(CW\*(C`Pre\-Read
response control\*(C'\fR allows one to retrieve the original value from the server's response.
.PP
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.
.SH "CONSTRUCTOR ARGUMENTS"
.IX Header "CONSTRUCTOR ARGUMENTS"
In addition to the constructor arguments described in
Net::LDAP::Control the following are provided.
.IP "attrs => [ ATTR, ... ]" 4
.IX Item "attrs => [ ATTR, ... ]"
A list of attributes to be returned in the entry returned in the response control.
.Sp
If absent, all attributes are returned.
.Sp
Operational attributes may be included in the list by explicitly asking for them
or by using special \f(CW"+"\fR feature (provided the server supports this feature).
.SH METHODS
.IX Header "METHODS"
As with Net::LDAP::Control each constructor argument
described above is also available 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.
.PP
In addition to these methods, the control also supports the following method:
.IP "entry ()" 4
.IX Item "entry ()"
Returns the entry from the response control in the response message
to the LDAP request that contained the request control.
.Sp
The result is either a Net::LDAP::Entry object or undefined.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Net::LDAP,
Net::LDAP::Control,
http://www.ietf.org/rfc/rfc4527.txt
.SH AUTHOR
.IX Header "AUTHOR"
Peter Marschall <peter@adpm.de>
.PP
Please report any bugs, or post any suggestions, to the perl-ldap mailing list
<perl\-ldap@perl.org>
.SH COPYRIGHT
.IX Header "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.