/usr/share/perl5/Net/LDAP/Schema.pod 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 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 | =head1 NAME
Net::LDAP::Schema - Load and manipulate an LDAP v3 Schema
=head1 SYNOPSIS
use Net::LDAP;
use Net::LDAP::Schema;
#
# Read schema from server
#
$ldap = Net::LDAP->new ( $server );
$ldap->bind ( );
$schema = $ldap->schema ( );
#
# Load from LDIF
#
$schema = Net::LDAP::Schema->new;
$schema->parse ( "schema.ldif" ) or die $schema->error;
=head1 DESCRIPTION
C<Net::LDAP::Schema> provides a means to load an LDAP schema and query it
for information regarding supported objectclasses, attributes and syntaxes.
=head1 METHODS
Where a method is stated as taking the 'name or OID' of a schema item (which
may be an object class, attribute or syntax) then a case-insensitive name
or raw OID (object identifier, in dotted numeric string form, e.g. 2.5.4.0)
may be supplied.
Each returned item of schema (eg an attribute definition) is returned
in a HASH. The keys in the returned HASH are lowercase versions of
the keys read from the server. Here's a partial list (not all HASHes
define all keys) although note that RFC 4512 permits other keys as
well:
name
desc
obsolete
sup
equality
ordering
substr
syntax
single-value
collective
no-user-modification
usage
abstract
structural
auxiliary
must
may
applies
aux
not
oc
form
=over 4
=item all_attributes ( )
=item all_ditcontentrules ( )
=item all_ditstructurerules ( )
=item all_matchingrules ( )
=item all_matchingruleuses ( )
=item all_nameforms ( )
=item all_objectclasses ( )
=item all_syntaxes ( )
Returns a list of all the requested types in the schema.
=item attribute ( NAME )
=item ditcontentrule ( NAME )
=item ditstructurerule ( NAME )
=item matchingrule ( NAME )
=item matchingruleuse ( NAME )
=item nameform ( NAME )
=item objectclass ( NAME )
=item syntax ( NAME )
Returns a reference to a hash, or C<undef> if the schema item does not
exist. C<NAME> can be a name or an OID.
$attr_href = $schema->attribute( "attrname" );
=item dump ( )
Dump the raw schema information to standard out.
=item dump ( FILENAME )
Dump the raw schema information to a file.
$result = $schema->dump ( "./schema.dump" );
If no schema data is returned from directory server, the method will
return undefined. Otherwise a value of 1 is always returned.
=item error ( )
Returns the last error encountered when parsing the schema.
=item may ( OBJECTCLASS )
Given an argument which is the name or OID of a known object class,
returns a list of HASHes describing the attributes which are optional
in the class.
@may = $schema->may ( $oc );
# First optional attr has the name '$may[0]->{name}'
=item must ( OBJECTCLASS )
Given an argument which is the name or OID of a known object class,
returns a list of HASHes describing the attributes which are mandatory
in the class.
@must = $schema->must ( $oc );
=item parse ( MESG )
=item parse ( ENTRY )
=item parse ( FILENAME )
Takes a single argument which can be any of, a message object returned
from an LDAP search, a C<Net::LDAP::Entry> object or the name of a
file containing an LDIF form of the schema.
If the argument is a message result from a search,
C<Net::LDAP::Schema> will parse the schema from the first entry
returned.
Returns true on success and C<undef> on error.
=item superclass ( NAME )
Given an argument which is the name or OID of a known objectclass,
returns the list of names of the immediate superclasses.
=item attribute_syntax ( NAME )
Given an attribute name, return the actual syntax taking into account
attribute supertypes.
=item matchingrule_for_attribute ( NAME, RULE )
Given an attribute name and a matching rule (C<equality>,
C<substr>, etc), return the actual rule taking into account attribute
supertypes.
=back
=head1 SEE ALSO
L<Net::LDAP>,
L<Net::LDAP::RFC>
=head1 AUTHORS
Graham Barr E<lt>gbarr@pobox.comE<gt>
John Berthels E<lt>jjb@nexor.co.ukE<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) 1998-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
|