C# Class Novell.Directory.Ldap.LdapConstraints

Defines options controlling Ldap operations on the directory. An LdapConstraints object is always associated with an LdapConnection object; its values can be changed with LdapConnection.setConstraints, or overridden by passing an LdapConstraints object to an operation.

Inheritance: System.ICloneable

显示文件 Open project: EventStore/csharp-ldap Class Usage Examples

Private Properties

Property	Type	Description
LdapConstraints	System
getReferralHandler	LdapReferralHandler

Public Methods

Method	Description
Clone ( ) : Object	Clones an LdapConstraints object.
LdapConstraints ( int msLimit, bool doReferrals, LdapReferralHandler handler, int hop_limit ) : System	Constructs a new LdapConstraints object specifying constraints that control wait time, and referral handling.
getControls ( ) : Novell.Directory.Ldap.LdapControl[]	Returns the controls to be sent to the server.
getProperty ( System name ) : Object	Gets a property of the constraints object which has been assigned with {@link #setProperty(String, Object)}.
setControls ( LdapControl control ) : void	Sets a single control to be sent to the server.
setProperty ( System name, System value_Renamed ) : void	Sets a property of the constraints object. No property names have been defined at this time, but the mechanism is in place in order to support revisional as well as dynamic and proprietary extensions to operation modifiers.
setReferralHandler ( LdapReferralHandler handler ) : void	Specifies the object that will process authentication requests during automatic referral following. The default is null.

Private Methods

Method	Description
LdapConstraints ( ) : System
getReferralHandler ( ) : LdapReferralHandler	Returns an object that can process authentication for automatic referral handling. It may be null.

Method Details

Clone() public method

Clones an LdapConstraints object.

public Clone ( ) : Object
return	System.Object

LdapConstraints() public method

Constructs a new LdapConstraints object specifying constraints that control wait time, and referral handling.

public LdapConstraints ( int msLimit, bool doReferrals, LdapReferralHandler handler, int hop_limit ) : System
msLimit	int	The maximum time in milliseconds to wait for results. /// The default is 0, which means that there is no /// maximum time limit. This limit is enforced for an /// operation by the API, not by the server. /// The operation will be abandoned and terminated by the /// API with a result code of LdapException.Ldap_TIMEOUT /// if the operation exceeds the time limit. /// ///
doReferrals	bool	Determines whether to automatically follow /// referrals or not. Specify true to follow /// referrals automatically, and false to throw /// an LdapReferralException if the server responds /// with a referral. False is the default value. /// The way referrals are followed automatically is /// determined by the setting of the handler parameter. /// It is ignored for asynchronous operations. /// ///
handler	LdapReferralHandler	The custom authentication handler called when /// LdapConnection needs to authenticate, typically on /// following a referral. A null may be specified to /// indicate default authentication processing, i.e. /// referrals are followed with anonymous authentication. /// The handler object may be an implemention of either the /// LdapBindHandler or LdapAuthHandler interface. /// The implementation of these interfaces determines how /// authentication is performed when following referrals. /// It is ignored for asynchronous operations. /// ///
hop_limit	int	The maximum number of referrals to follow in a /// sequence during automatic referral following. /// The default value is 10. A value of 0 means no limit. /// The operation will be abandoned and terminated by the /// API with a result code of /// LdapException.REFERRAL_LIMIT_EXCEEDED if the /// number of referrals in a sequence exceeds the limit. /// It is ignored for asynchronous operations. /// ///
return	System

getControls() public method

Returns the controls to be sent to the server.

public getControls ( ) : Novell.Directory.Ldap.LdapControl[]
return	Novell.Directory.Ldap.LdapControl[]

getProperty() public method

Gets a property of the constraints object which has been assigned with {@link #setProperty(String, Object)}.

public getProperty ( System name ) : Object
name	System	Name of the property to be returned. /// ///
return	System.Object

setControls() public method

Sets a single control to be sent to the server.

public setControls ( LdapControl control ) : void
control	LdapControl	A single control to be sent to the server or /// null if none. ///
return	void

setProperty() public method

Sets a property of the constraints object. No property names have been defined at this time, but the mechanism is in place in order to support revisional as well as dynamic and proprietary extensions to operation modifiers.

public setProperty ( System name, System value_Renamed ) : void
name	System	Name of the property to set. /// ///
value_Renamed	System
return	void

setReferralHandler() public method

Specifies the object that will process authentication requests during automatic referral following. The default is null.

public setReferralHandler ( LdapReferralHandler handler ) : void
handler	LdapReferralHandler	An object that implements LdapBindHandler or /// LdapAuthHandler /// ///
return	void