312 lines
10 KiB
Groff
Executable File
312 lines
10 KiB
Groff
Executable File
.\" Automatically generated by Pod::Man version 1.15
|
|
.\" Fri Oct 4 06:36:41 2002
|
|
.\"
|
|
.\" Standard preamble:
|
|
.\" ======================================================================
|
|
.de Sh \" Subsection heading
|
|
.br
|
|
.if t .Sp
|
|
.ne 5
|
|
.PP
|
|
\fB\\$1\fR
|
|
.PP
|
|
..
|
|
.de Sp \" Vertical space (when we can't use .PP)
|
|
.if t .sp .5v
|
|
.if n .sp
|
|
..
|
|
.de Ip \" List item
|
|
.br
|
|
.ie \\n(.$>=3 .ne \\$3
|
|
.el .ne 3
|
|
.IP "\\$1" \\$2
|
|
..
|
|
.de Vb \" Begin verbatim text
|
|
.ft CW
|
|
.nf
|
|
.ne \\$1
|
|
..
|
|
.de Ve \" End verbatim text
|
|
.ft R
|
|
|
|
.fi
|
|
..
|
|
.\" Set up some character translations and predefined strings. \*(-- will
|
|
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
|
|
.\" double quote, and \*(R" will give a right double quote. | will give a
|
|
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used
|
|
.\" to do unbreakable dashes and therefore won't be available. \*(C` and
|
|
.\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
|
|
.tr \(*W-|\(bv\*(Tr
|
|
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
|
.ie n \{\
|
|
. ds -- \(*W-
|
|
. ds PI pi
|
|
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
|
|
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
|
|
. ds L" ""
|
|
. ds R" ""
|
|
. ds C` ""
|
|
. ds C' ""
|
|
'br\}
|
|
.el\{\
|
|
. ds -- \|\(em\|
|
|
. ds PI \(*p
|
|
. ds L" ``
|
|
. ds R" ''
|
|
'br\}
|
|
.\"
|
|
.\" If the F register is turned on, we'll generate index entries on stderr
|
|
.\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
|
|
.\" index entries marked with X<> in POD. Of course, you'll have to process
|
|
.\" the output yourself in some meaningful fashion.
|
|
.if \nF \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. nr % 0
|
|
. rr F
|
|
.\}
|
|
.\"
|
|
.\" For nroff, turn off justification. Always turn off hyphenation; it
|
|
.\" makes way too many mistakes in technical documents.
|
|
.hy 0
|
|
.if n .na
|
|
.\"
|
|
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
|
.\" Fear. Run. Save yourself. No user-serviceable parts.
|
|
.bd B 3
|
|
. \" fudge factors for nroff and troff
|
|
.if n \{\
|
|
. ds #H 0
|
|
. ds #V .8m
|
|
. ds #F .3m
|
|
. ds #[ \f1
|
|
. ds #] \fP
|
|
.\}
|
|
.if t \{\
|
|
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
|
. ds #V .6m
|
|
. ds #F 0
|
|
. ds #[ \&
|
|
. ds #] \&
|
|
.\}
|
|
. \" simple accents for nroff and troff
|
|
.if n \{\
|
|
. ds ' \&
|
|
. ds ` \&
|
|
. ds ^ \&
|
|
. ds , \&
|
|
. ds ~ ~
|
|
. ds /
|
|
.\}
|
|
.if t \{\
|
|
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
|
|
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
|
|
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
|
|
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
|
|
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
|
|
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
|
|
.\}
|
|
. \" troff and (daisy-wheel) nroff accents
|
|
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
|
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
|
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
|
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
|
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
|
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
|
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
|
.ds ae a\h'-(\w'a'u*4/10)'e
|
|
.ds Ae A\h'-(\w'A'u*4/10)'E
|
|
. \" corrections for vroff
|
|
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
|
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
|
. \" for low resolution devices (crt and lpr)
|
|
.if \n(.H>23 .if \n(.V>19 \
|
|
\{\
|
|
. ds : e
|
|
. ds 8 ss
|
|
. ds o a
|
|
. ds d- d\h'-1'\(ga
|
|
. ds D- D\h'-1'\(hy
|
|
. ds th \o'bp'
|
|
. ds Th \o'LP'
|
|
. ds ae ae
|
|
. ds Ae AE
|
|
.\}
|
|
.rm #[ #] #H #V #F C
|
|
.\" ======================================================================
|
|
.\"
|
|
.IX Title "Net::LDAP::Control::VLV 3"
|
|
.TH Net::LDAP::Control::VLV 3 "perl v5.6.1" "2001-08-24" "User Contributed Perl Documentation"
|
|
.UC
|
|
.SH "NAME"
|
|
Net::LDAP::Control::VLV \- LDAPv3 Virtual List View control object
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
.Vb 3
|
|
\& use Net::LDAP;
|
|
\& use Net::LDAP::Control::VLV;
|
|
\& use Net::LDAP::Constant qw( LDAP_CONTROL_VLVRESPONSE );
|
|
.Ve
|
|
.Vb 1
|
|
\& $ldap = Net::LDAP->new( "ldap.mydomain.eg" );
|
|
.Ve
|
|
.Vb 8
|
|
\& # Get the first 20 entries
|
|
\& $vlv = Net::LDAP::Control::VLV->new(
|
|
\& before => 0, # No entries from before target entry
|
|
\& after => 19, # 19 entries after target entry
|
|
\& content => 0, # List size unknown
|
|
\& offset => 1, # Target entry is the first
|
|
\& );
|
|
\& $sort = Net::LDAP::Control::Sort->new( sort => 'cn' );
|
|
.Ve
|
|
.Vb 6
|
|
\& @args = ( base => "o=Ace Industry, c=us",
|
|
\& scope => "subtree",
|
|
\& filter => "(objectClass=inetOrgPerson)",
|
|
\& callback => \e&process_entry, # Call this sub for each entry
|
|
\& control => [ $vlv, $sort ],
|
|
\& );
|
|
.Ve
|
|
.Vb 1
|
|
\& $mesg = $ldap->search( @args );
|
|
.Ve
|
|
.Vb 3
|
|
\& # Get VLV response control
|
|
\& ($resp) = $mesg->control( LDAP_CONTROL_VLVRESPONSE ) or die;
|
|
\& $vlv->response( $resp );
|
|
.Ve
|
|
.Vb 2
|
|
\& # Set the control to get the last 20 entries
|
|
\& $vlv->end;
|
|
.Ve
|
|
.Vb 1
|
|
\& $mesg = $ldap->search( @args );
|
|
.Ve
|
|
.Vb 3
|
|
\& # Get VLV response control
|
|
\& ($resp) = $mesg->control( LDAP_CONTROL_VLVRESPONSE ) or die;
|
|
\& $vlv->response( $resp );
|
|
.Ve
|
|
.Vb 2
|
|
\& # Now get the previous page
|
|
\& $vlv->scroll_page( -1 );
|
|
.Ve
|
|
.Vb 1
|
|
\& $mesg = $ldap->search( @args );
|
|
.Ve
|
|
.Vb 3
|
|
\& # Get VLV response control
|
|
\& ($resp) = $mesg->control( LDAP_CONTROL_VLVRESPONSE ) or die;
|
|
\& $vlv->response( $resp );
|
|
.Ve
|
|
.Vb 4
|
|
\& # Now page with first entry starting with "B" in the middle
|
|
\& $vlv->before(9); # Change page to show 9 before
|
|
\& $vlv->after(10); # Change page to show 10 after
|
|
\& $vlv->assert("B"); # assert "B"
|
|
.Ve
|
|
.Vb 1
|
|
\& $mesg = $ldap->search( @args );
|
|
.Ve
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
\&\f(CW\*(C`Net::LDAP::Control::VLV\*(C'\fR provides an interface for the creation and
|
|
manipulation of objects that represent the Virtual List View as described
|
|
by draft-ietf-ldapext-ldapv3\-vlv-03.txt.
|
|
.PP
|
|
When using a Virtual List View control in a search, it must be accompanied by a sort
|
|
control. See the Net::LDAP::Control::Sort manpage
|
|
.SH "CONSTRUCTOR ARGUMENTS"
|
|
.IX Header "CONSTRUCTOR ARGUMENTS"
|
|
In addition to the constructor arguments described in
|
|
the Net::LDAP::Control manpage the following are provided.
|
|
.Ip "after" 4
|
|
.IX Item "after"
|
|
Set the number of entries the server should return from the list after
|
|
the target entry.
|
|
.Ip "assert" 4
|
|
.IX Item "assert"
|
|
Set the assertion value user to locate the target entry. This value should
|
|
be a legal value to compare with the first attribute in the sort control
|
|
that is passed with the \s-1VLV\s0 control. The target entry is the first entry
|
|
in the list which is greater than or equal the assert value.
|
|
.Ip "before" 4
|
|
.IX Item "before"
|
|
Set the number of entries the server should return from the list before
|
|
the target entry.
|
|
.Ip "content" 4
|
|
.IX Item "content"
|
|
Set the number of entries in the list. On the first search this value
|
|
should be set to zero. On subsequent searches it should be set to the
|
|
length of the list, as returned by the server in the VLVResponse control.
|
|
.Ip "context" 4
|
|
.IX Item "context"
|
|
Set the context identifier. On the first search this value should be
|
|
set to zero. On subsequent searches it should be set to the context
|
|
value returned by the server in the VLVResponse control.
|
|
.Ip "offset" 4
|
|
.IX Item "offset"
|
|
Set the offset of the target entry.
|
|
.Sh "\s-1METHODS\s0"
|
|
.IX Subsection "METHODS"
|
|
As with the Net::LDAP::Control manpage each constructor argument
|
|
described above is also avaliable 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
|
|
The \f(CW\*(C`offset\*(C'\fR and \f(CW\*(C`assert\*(C'\fR attributes are mutually exclusive. Setting
|
|
one or the other will cause previous values set by the other to
|
|
be forgotten. The \f(CW\*(C`content\*(C'\fR attribute is also associated with the
|
|
\&\f(CW\*(C`offset\*(C'\fR attribute, so setting \f(CW\*(C`assert\*(C'\fR will cause any \f(CW\*(C`content\*(C'\fR
|
|
value to be forgotten.
|
|
.Ip "end" 4
|
|
.IX Item "end"
|
|
Set the target entry to the end of the list. This method will change the \f(CW\*(C`before\*(C'\fR
|
|
and \f(CW\*(C`after\*(C'\fR attributes so that the target entry is the last in the page.
|
|
.Ip "response \s-1VLV_RESPONSE\s0" 4
|
|
.IX Item "response VLV_RESPONSE"
|
|
Set the attributes in the control as per \s-1VLV_RESPONSE\s0. \s-1VLV_RESPONSE\s0 should be a control
|
|
of type the Net::LDAP::Control::VLVResponse manpage returned
|
|
from the server. \f(CW\*(C`response\*(C'\fR will populate the \f(CW\*(C`context\*(C'\fR, \f(CW\*(C`offset\*(C'\fR and \f(CW\*(C`content\*(C'\fR
|
|
attibutes of the control with the values from \s-1VLV_RESPONSE\s0. Because this sets the
|
|
\&\f(CW\*(C`offset\*(C'\fR attribute, any previous setting of the \f(CW\*(C`assert\*(C'\fR attribute will be forgotten.
|
|
.Ip "scroll \s-1NUM\s0" 4
|
|
.IX Item "scroll NUM"
|
|
Move the target entry by \s-1NUM\s0 entries. A positive \s-1NUM\s0 will move the target entry towards
|
|
the end of the list and a negative \s-1NUM\s0 will move the target entry towards the
|
|
start of the list. Returns the index of the new target entry, or \f(CW\*(C`undef\*(C'\fR if the current target
|
|
is identified by an assertion.
|
|
.Sp
|
|
\&\f(CW\*(C`scroll\*(C'\fR may change the \f(CW\*(C`before\*(C'\fR and \f(CW\*(C`after\*(C'\fR attributes if the scroll value would
|
|
cause the page to go off either end of the list. But the page size will be maintained.
|
|
.Ip "scroll_page \s-1NUM\s0" 4
|
|
.IX Item "scroll_page NUM"
|
|
Scroll by \s-1NUM\s0 pages. This method simple calculates the current page size and calls
|
|
\&\f(CW\*(C`scroll\*(C'\fR with \f(CW\*(C`NUM * $page_size\*(C'\fR
|
|
.Ip "start" 4
|
|
.IX Item "start"
|
|
Set the target entry to the start of the list. This method will change the \f(CW\*(C`before\*(C'\fR and \f(CW\*(C`after\*(C'\fR
|
|
attributes to the the target entry is the first entry in the page.
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
the Net::LDAP manpage,
|
|
the Net::LDAP::Control manpage,
|
|
the Net::LDAP::Control::Sort manpage,
|
|
the Net::LDAP::Control::VLVResponse manpage
|
|
.SH "AUTHOR"
|
|
.IX Header "AUTHOR"
|
|
Graham Barr <gbarr@pobox.com>
|
|
.PP
|
|
Please report any bugs, or post any suggestions, to the perl-ldap mailing list
|
|
<perl-ldap-dev@lists.sourceforge.net>
|
|
.SH "COPYRIGHT"
|
|
.IX Header "COPYRIGHT"
|
|
Copyright (c) 2000 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.
|
|
.PP
|
|
\&\fI$Id: \s-1VLV\s0.pm,v 1.5 2001/08/24 19:31:14 gbarr Exp $\fR
|