Permalink
Browse files

extend documentation for Pre-Read & Post-Read controls

  • Loading branch information...
1 parent 71e8ff5 commit f32c19adab090e4b171f04de6aa71888ba22b641 @marschap marschap committed Sep 7, 2011
Showing with 25 additions and 4 deletions.
  1. +13 −2 lib/Net/LDAP/Control/PostRead.pm
  2. +12 −2 lib/Net/LDAP/Control/PreRead.pm
@@ -48,9 +48,19 @@ Net::LDAP::Control::PostRead - LDAPv3 Post-Read control object
=head1 DESCRIPTION
C<Net::LDAP::Control::PostRead> provides an interface for the creation and
-manipulation of objects that represent the C<Post-Read Control> as described
+manipulation of objects that represent the C<Post-Read Controls> as described
by RFC 4527.
+In modification operations, the C<Post-Read request control> indicates to the
+server that a copy of the modified entry after the update is to be returned.
+After the successful completion of the operation, the accompanying C<Post-Read
+response control> allows to retrieve the updated value from the servers's response.
+
+One use case of this control may be to obtain values of operational attributes,
+such as the C<entryUUID> and C<modifyTimestamp> attributes, updated by the server
+as part of the update operation.
+
+
=head1 CONSTRUCTOR ARGUMENTS
In addition to the constructor arguments described in
@@ -69,6 +79,7 @@ or by using special C<"+"> feature (provided the server supports this feature).
=back
+
=head1 METHODS
As with L<Net::LDAP::Control> each constructor argument
@@ -105,7 +116,7 @@ E<lt>perl-ldap@perl.orgE<gt>
=head1 COPYRIGHT
-Copyright (c) 2008 Peter Marschall. All rights reserved. This program is
+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.
@@ -102,9 +102,18 @@ Net::LDAP::Control::PreRead - LDAPv3 Pre-Read control object
=head1 DESCRIPTION
C<Net::LDAP::Control::PreRead> provides an interface for the creation and
-manipulation of objects that represent the C<Pre-Read Control> as described
+manipulation of objects that represent the C<Pre-Read Controls> as described
by RFC 4527.
+In modification operations, the C<Pre-Read request control> 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 C<Pre-Read
+response control> allows to retrieve the original value from the servers's response.
+
+One use case of this control control may be to obtain replaced or deleted
+values of modified attributes or a copy of the entry being deleted.
+
+
=head1 CONSTRUCTOR ARGUMENTS
In addition to the constructor arguments described in
@@ -123,6 +132,7 @@ or by using special C<"+"> feature (provided the server supports this feature).
=back
+
=head1 METHODS
As with L<Net::LDAP::Control> each constructor argument
@@ -159,7 +169,7 @@ E<lt>perl-ldap@perl.orgE<gt>
=head1 COPYRIGHT
-Copyright (c) 2008 Peter Marschall. All rights reserved. This program is
+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.

0 comments on commit f32c19a

Please sign in to comment.