/usr/share/perl5/Net/LDAP/Control/SortResult.pm is in libnet-ldap-perl 1:0.6500+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 | # Copyright (c) 1999-2004 Graham Barr <gbarr@pobox.com>. All rights reserved.
# This program is free software; you can redistribute it and/or
# modify it under the same terms as Perl itself.
package Net::LDAP::Control::SortResult;
use Net::LDAP::ASN qw(SortResult);
use Net::LDAP::Control;
our @ISA = qw(Net::LDAP::Control);
our $VERSION = '0.03';
sub init {
my($self) = @_;
if (exists $self->{value}) {
$self->{asn} = $SortResult->decode(delete $self->{value});
}
else {
$self->{asn} = { sortResult => delete $self->{result} };
$self->{asn}{attributeType} = delete $self->{attr} if exists $self->{attr};
}
$self;
}
sub value {
my $self = shift;
$self->{value} = $SortResult->encode($self->{asn});
}
sub result {
my $self = shift;
@_ ? ($self->{asn}{sortResult}=shift)
: $self->{asn}{sortResult};
}
sub attr {
my $self = shift;
@_ ? ($self->{asn}{attributeType}=shift)
: $self->{asn}{attributeType};
}
1;
__END__
=head1 NAME
Net::LDAP::Control::SortResult - Server Side Sort (SSS) result control object
=head1 SYNOPSIS
use Net::LDAP::Control::Sort;
use Net::LDAP::Constant qw(LDAP_CONTROL_SORTRESULT);
use Net::LDAP::Util qw(ldap_error_name);
$sort = Net::LDAP::Control::Sort->new(
order => "cn -age"
);
$mesg = $ldap->search( @args, control => [ $sort ]);
($resp) = $mesg->control( LDAP_CONTROL_SORTRESULT );
if ($resp) {
if ($resp->result) {
my $attr = $resp->attr;
print "Problem sorting, ",ldap_error_name($resp->result);
print " ($attr)" if $attr;
print "\n";
}
else {
print "Results are sorted\n";
}
}
else {
print "Server does not support sorting\n";
}
=head1 DESCRIPTION
C<Net::LDAP::Control::SortResult> is a sub-class of
L<Net::LDAP::Control>. It provides a class for
manipulating the LDAP sort request control C<1.2.840.113556.1.4.474>
as defined in RFC-2891
A sort result control will be returned by the server in response to
a search with a Server Side Sort control. If a sort result control is
not returned then the user may assume that the server does not support
sorting and the results are not sorted.
=head1 CONSTRUCTOR ARGUMENTS
=over 4
=item attr
If C<result> indicates that there was a problem with sorting and that problem was
due to one of the attributes specified in the sort control. C<attr> is set to
the name of the attribute causing the problem.
=item result
This is the result code that describes if the sort operation was successful. If will
be one of the result codes describes below.
=back
=head1 METHODS
As with L<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.
=head1 RESULT CODES
Possible results from a sort request are listed below. See L<Net::LDAP::Constant> for
a definition of each.
=over 4
=item LDAP_SUCCESS
=item LDAP_OPERATIONS_ERROR
=item LDAP_TIMELIMIT_EXCEEDED
=item LDAP_STRONG_AUTH_REQUIRED
=item LDAP_ADMIN_LIMIT_EXCEEDED
=item LDAP_NO_SUCH_ATTRIBUTE
=item LDAP_INAPPROPRIATE_MATCHING
=item LDAP_INSUFFICIENT_ACCESS
=item LDAP_BUSY
=item LDAP_UNWILLING_TO_PERFORM
=item LDAP_OTHER
=back
=head1 SEE ALSO
L<Net::LDAP>,
L<Net::LDAP::Control::Sort>,
L<Net::LDAP::Control>,
http://ww.ietf.org/rfc/rfc2891.txt
=head1 AUTHOR
Graham Barr E<lt>gbarr@pobox.comE<gt>
Please report any bugs, or post any suggestions, to the perl-ldap mailing list
E<lt>perl-ldap@perl.orgE<gt>
=head1 COPYRIGHT
Copyright (c) 1999-2004 Graham Barr. All rights reserved. This program is
free software; you can redistribute it and/or modify it under the same
terms as Perl itself.
=cut
|