1Net::LDAP::IntermediateU(s3e)r Contributed Perl DocumentaNteito:n:LDAP::Intermediate(3)
2
3
4

NAME

6       Net::LDAP::Intermediate - LDAPv3 intermediate response object base
7       class
8

SYNOPSIS

10        use Net::LDAP::Intermediate;
11

DESCRIPTION

13       "Net::LDAP::Intermediate" is a base-class for LDAPv3 intermediate
14       response objects.
15

CONSTRUCTORS

17       new ( ARGS )
18           ARGS is a list of name/value pairs, valid arguments are:
19
20           responseName
21               A dotted-decimal representation of an OBJECT IDENTIFIER which
22               uniquely identifies the intermediate response. This prevents
23               conflicts between intermediate response names.
24
25           responseValue
26               Optional information associated with the intermediate response.
27               It's format is specific to the particular intermediate
28               response.
29
30       from_asn ( ASN )
31           ASN is a HASH reference, normally extracted from a PDU. It will
32           contain a "responseName" element and optionally "responseValue"
33           element. On return ASN will be blessed into a package. If
34           "responseName" is a registered OID, then ASN will be blessed into
35           the registered package, if not then ASN will be blessed into
36           Net::LDAP::Intermediate.
37
38           This constructor is used internally by Net::LDAP and assumes that
39           HASH passed contains a valid intermediate response. It should be
40           used with caution.
41

METHODS

43       In addition to the methods listed below, each of the named parameters
44       to "new" is also avaliable as a method. "responseName" will return the
45       OID of the intermediate response object. "responseValue" is set/get
46       methods and will return the current value for each attribute if called
47       without arguments, but may also be called with arguments to set new
48       values.
49
50       error ()
51           If there has been an error returns a description of the error,
52           otherwise it will return "undef"
53
54       init ()
55           "init" will be called as the last step in both contructors. What it
56           does will depend on the sub-class. It must always return the
57           object.
58
59       register ( OID )
60           "register" is provided for sub-class implementors. It should be
61           called as a class method on a sub-class of Net::LDAP::Intermediate
62           with the OID that the class will handle. Net::LDAP::Intermediate
63           will remember this class and OID pair and use it in the following
64           situations.
65
66           ·   "new" is called as a class method on the
67               Net::LDAP::Intermediate package and OID is passed as the
68               responseName. The returned object will be blessed into the
69               package that registered the OID.
70
71           ·   "new" is called as a class method on a registered package and
72               the "responseName" is not specified. The "responseName" will be
73               set to the OID registered by that package.
74
75           ·   "from_asn" is called to construct an object from ASN. The
76               returned object will be blessed into the package which was
77               registered to handle the OID in the ASN.
78
79       ( to_asn )
80           Returns a structure suitable for passing to Convert::ASN1 for
81           encoding. This method will be called by Net::LDAP when the
82           intermediate response is used.
83
84           The base class implementation of this method will call the
85           "responseValue" method without arguments to allow a sub-class to
86           encode it's value. Sub-classes should not need to override this
87           method.
88
89       valid ()
90           Returns true if the object is valid and can be encoded. The default
91           implementation for this method is to return TRUE if there is no
92           error, but sub-classes may override that.
93

SEE ALSO

95       Net::LDAP Net::LDAP::Extension Net::LDAP::Search
96       Net::LDAP::Intermediate::SyncInfo
97

AUTHOR

99       Mathieu Parent <math.parent@gmail.com>
100
101       Please report any bugs, or post any suggestions, to the perl-ldap
102       mailing list <perl-ldap@perl.org>
103

105       Copyright (c) 2008 Mathieu Parent. All rights reserved. This program is
106       free software; you can redistribute it and/or modify it under the same
107       terms as Perl itself.
108
109
110
111perl v5.10.1                      2010-03-12        Net::LDAP::Intermediate(3)
Impressum