Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28) Standard preamble: ========================================================================
NAMENet::LDAP::Intermediate - LDAPv3 intermediate response object base class
DESCRIPTION"Net::LDAP::Intermediate" is a base-class for LDAPv3 intermediate response objects.
- new ( ARGS)
ARGSis a list of name/value pairs, valid arguments are:
A dotted-decimal representation of an OBJECT IDENTIFIERwhich uniquely identifies the intermediate response. This prevents conflicts between intermediate response names.
- Optional information associated with the intermediate response. It's format is specific to the particular intermediate response.
- from_asn ( ASN)
ASNis aHASHreference, normally extracted from aPDU.It will contain a "responseName" element and optionally "responseValue" element. On returnASNwill be blessed into a package. If "responseName" is a registeredOID,thenASNwill be blessed into the registered package, if not thenASNwill be blessed into Net::LDAP::Intermediate.
This constructor is used internally by Net::LDAP and assumes thatHASHpassed contains a valid intermediate response. It should be used with caution.
METHODSIn addition to the methods listed below, each of the named parameters to "new" is also available as a method. "responseName" will return the
- error ()
- If there has been an error returns a description of the error, otherwise it will return "undef"
- init ()
- "init" will be called as the last step in both constructors. What it does will depend on the sub-class. It must always return the object.
- register ( OID)
"register" is provided for sub-class implementors. It should be called as a class method
on a sub-class of Net::LDAP::Intermediate with the OIDthat the class will handle. Net::LDAP::Intermediate will remember this class andOIDpair and use it in the following situations.
"new" is called as a class method on the Net::LDAP::Intermediate package and OIDis passed as the responseName. The returned object will be blessed into the package that registered theOID.
"new" is called as a class method on a registered package and the "responseName" is not
specified. The "responseName" will be set to the OIDregistered by that package.
"from_asn" is called to construct an object from ASN.The returned object will be blessed into the package which was registered to handle theOIDin theASN.
- ( to_asn )
Returns a structure suitable for passing to Convert::ASN1 for
encoding. This method will be called by Net::LDAP when the
intermediate response is used.
The base class implementation of this method will call the "responseValue" method without arguments to allow a sub-class to encode it's value. Sub-classes should not need to override this method.
- valid ()
Returns true if the object is valid and can be encoded. The default implementation
for this method is to return TRUEif there is no error, but sub-classes may override that.
SEE ALSONet::LDAP Net::LDAP::Extension Net::LDAP::Search Net::LDAP::Intermediate::SyncInfo
AUTHORMathieu Parent <email@example.com>
Please report any bugs, or post any suggestions, to the perl-ldap mailing list <firstname.lastname@example.org>