162 lines
4.2 KiB
HTML
162 lines
4.2 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of URI::ldap</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>URI::ldap</H1>
|
|
Section: User Contributed Perl Documentation (3pm)<BR>Updated: 2020-02-08<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
URI::ldap - LDAP Uniform Resource Locators
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
|
|
|
|
|
|
|
|
<PRE>
|
|
use URI;
|
|
|
|
$uri = URI->new("ldap:$uri_string");
|
|
$dn = $uri->dn;
|
|
$filter = $uri->filter;
|
|
@attr = $uri->attributes;
|
|
$scope = $uri->scope;
|
|
%extn = $uri->extensions;
|
|
|
|
$uri = URI->new("ldap:"); # start empty
|
|
$uri->host("ldap.itd.umich.edu");
|
|
$uri->dn("o=University of Michigan,c=US");
|
|
$uri->attributes(qw(postalAddress));
|
|
$uri->scope('sub');
|
|
$uri->filter('(cn=Babs Jensen)');
|
|
print $uri->as_string,"\n";
|
|
|
|
</PRE>
|
|
|
|
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
|
|
|
|
<TT>"URI::ldap"</TT> provides an interface to parse an <FONT SIZE="-1">LDAP URI</FONT> into its
|
|
constituent parts and also to build a <FONT SIZE="-1">URI</FONT> as described in
|
|
<FONT SIZE="-1">RFC 2255.</FONT>
|
|
<A NAME="lbAE"> </A>
|
|
<H2>METHODS</H2>
|
|
|
|
|
|
|
|
<TT>"URI::ldap"</TT> supports all the generic and server methods defined by
|
|
<FONT SIZE="-1">URI</FONT>, plus the following.
|
|
<P>
|
|
|
|
Each of the following methods can be used to set or get the value in
|
|
the <FONT SIZE="-1">URI.</FONT> The values are passed in unescaped form. None of these
|
|
return undefined values, but elements without a default can be empty.
|
|
If arguments are given, then a new value is set for the given part
|
|
of the <FONT SIZE="-1">URI.</FONT>
|
|
<DL COMPACT>
|
|
<DT id="1">$uri->dn( [$new_dn] )<DD>
|
|
|
|
|
|
|
|
|
|
Sets or gets the <I>Distinguished Name</I> part of the <FONT SIZE="-1">URI.</FONT> The <FONT SIZE="-1">DN</FONT>
|
|
identifies the base object of the <FONT SIZE="-1">LDAP</FONT> search.
|
|
<DT id="2">$uri->attributes( [@new_attrs] )<DD>
|
|
|
|
|
|
|
|
|
|
Sets or gets the list of attribute names which are
|
|
returned by the search.
|
|
<DT id="3">$uri->scope( [$new_scope] )<DD>
|
|
|
|
|
|
|
|
|
|
Sets or gets the scope to be used by the search. The value can be one of
|
|
<TT>"base"</TT>, <TT>"one"</TT> or <TT>"sub"</TT>. If none is given in the <FONT SIZE="-1">URI</FONT> then the
|
|
return value defaults to <TT>"base"</TT>.
|
|
<DT id="4">$uri->_scope( [$new_scope] )<DD>
|
|
|
|
|
|
|
|
|
|
Same as <B>scope()</B>, but does not default to anything.
|
|
<DT id="5">$uri->filter( [$new_filter] )<DD>
|
|
|
|
|
|
|
|
|
|
Sets or gets the filter to be used by the search. If none is given in
|
|
the <FONT SIZE="-1">URI</FONT> then the return value defaults to <TT>"(objectClass=*)"</TT>.
|
|
<DT id="6">$uri->_filter( [$new_filter] )<DD>
|
|
|
|
|
|
|
|
|
|
Same as <B>filter()</B>, but does not default to anything.
|
|
<DT id="7">$uri->extensions( [$etype => $evalue,...] )<DD>
|
|
|
|
|
|
|
|
|
|
Sets or gets the extensions used for the search. The list passed should
|
|
be in the form etype1 => evalue1, etype2 => evalue2,... This is also
|
|
the form of list that is returned.
|
|
</DL>
|
|
<A NAME="lbAF"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
|
|
|
|
<<A HREF="http://tools.ietf.org/html/rfc2255">http://tools.ietf.org/html/rfc2255</A>>
|
|
<A NAME="lbAG"> </A>
|
|
<H2>AUTHOR</H2>
|
|
|
|
|
|
|
|
Graham Barr <<I><A HREF="mailto:gbarr@pobox.com">gbarr@pobox.com</A></I>>
|
|
<P>
|
|
|
|
Slightly modified by Gisle Aas to fit into the <FONT SIZE="-1">URI</FONT> distribution.
|
|
<A NAME="lbAH"> </A>
|
|
<H2>COPYRIGHT</H2>
|
|
|
|
|
|
|
|
Copyright (c) 1998 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.
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="8"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="9"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="10"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="11"><A HREF="#lbAE">METHODS</A><DD>
|
|
<DT id="12"><A HREF="#lbAF">SEE ALSO</A><DD>
|
|
<DT id="13"><A HREF="#lbAG">AUTHOR</A><DD>
|
|
<DT id="14"><A HREF="#lbAH">COPYRIGHT</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:59 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|