org.ietf.ldap
Class LDAPConstraints

java.lang.Object
  |
  +--org.ietf.ldap.LDAPConstraints

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

LDAPSearchConstraints

public class LDAPConstraints

extends java.lang.Object

implements java.lang.Cloneable

Represents a set of options to control an LDAP operation.

See Also:

com.novell.ldap.Constraints

Constructor Summary

LDAPConstraints()
Constructs an LDAPConstraints object, using the default option values.

LDAPConstraints(int msLimit, boolean doReferrals, LDAPReferralHandler handler, int hop_limit)
Constructs a new LDAPConstraints object, using the specified operational constraints for waiting, referrals, LDAPBindHandler object, and hop limit.

Method Summary

java.lang.Object	clone() Creates a clone of this object
LDAPControl[]	getControls() Returns the controls to be sent to the server.
int	getHopLimit() Returns the maximum number of hops to follow during automatic referral following.
java.lang.Object	getProperty(java.lang.String name) Returns a properties constraints objects which has been assigned with set property.
boolean	getReferralFollowing() Returns true if referrals are to be followed automatically.
int	getTimeLimit() Returns the maximum number of milliseconds to wait for any operation under these constraints.
void	setControls(LDAPControl control) Sets a control to be sent to the server.
void	setControls(LDAPControl[] controls) Sets an array of controls to be sent to the server.
void	setHopLimit(int hop_limit) Sets the maximum number of hops to follow in sequence during automatic referral following.
void	setProperty(java.lang.String name, java.lang.Object value) Sets a property of the constraints object.
void	setReferralFollowing(boolean doReferrals) Specifies whether referrals are followed automatically or whether referrals throw an LDAPReferralException.
void	setReferralHandler(LDAPReferralHandler handler) Specifies the object that will process authentication requests.
void	setTimeLimit(int msLimit) Sets the maximum number of milliseconds the client waits for any operation under these search constraints to complete.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LDAPConstraints

public LDAPConstraints()

Constructs an LDAPConstraints object, using the default option values.

See Also:

com.novell.ldap.LDAPConstraints.LDAPConstraints()

LDAPConstraints

public LDAPConstraints(int msLimit,
                       boolean doReferrals,
                       LDAPReferralHandler handler,
                       int hop_limit)

Constructs a new LDAPConstraints object, using the specified operational constraints for waiting, referrals, LDAPBindHandler object, and hop limit.

See Also:

LDAPConstraints.LDAPConstraints( int,boolean,LDAPReferralHandler,int), com.novell.ldap.LDAPConstraints.LDAPConstraints(int, boolean, LDAPReferralHandler, int)

Method Detail

clone

public java.lang.Object clone()

Creates a clone of this object

Overrides:

clone in class java.lang.Object

Returns:

a clone of this object

See Also:

com.novell.ldap.LDAPConstraints.clone()

getHopLimit

public int getHopLimit()

Returns the maximum number of hops to follow during automatic referral following.

See Also:

com.novell.ldap.LDAPConstraints.getHopLimit()

getProperty

public java.lang.Object getProperty(java.lang.String name)

Returns a properties constraints objects which has been assigned with set property.

See Also:

com.novell.ldap.LDAPConstraints.getProperty(String)

getReferralFollowing

public boolean getReferralFollowing()

Returns true if referrals are to be followed automatically.

See Also:

com.novell.ldap.LDAPConstraints.getReferralFollowing()

getTimeLimit

public int getTimeLimit()

Returns the maximum number of milliseconds to wait for any operation under these constraints.

See Also:

com.novell.ldap.LDAPConstraints.getTimeLimit()

setHopLimit

public void setHopLimit(int hop_limit)

Sets the maximum number of hops to follow in sequence during automatic referral following.

See Also:

com.novell.ldap.LDAPConstraints.setHopLimit(int)

setReferralHandler

public void setReferralHandler(LDAPReferralHandler handler)

Specifies the object that will process authentication requests.

See Also:

com.novell.ldap.LDAPConstraints.setReferralHandler( LDAPReferralHandler)

setReferralFollowing

public void setReferralFollowing(boolean doReferrals)

Specifies whether referrals are followed automatically or whether referrals throw an LDAPReferralException.

See Also:

com.novell.ldap.LDAPConstraints.setReferralFollowing(boolean)

setTimeLimit

public void setTimeLimit(int msLimit)

Sets the maximum number of milliseconds the client waits for any operation under these search constraints to complete.

See Also:

com.novell.ldap.LDAPConstraints.setTimeLimit(int)

getControls

public LDAPControl[] getControls()

Returns the controls to be sent to the server.

See Also:

com.novell.ldap.LDAPConstraints.getControls()

setControls

public void setControls(LDAPControl control)

Sets a control to be sent to the server.

See Also:

com.novell.ldap.LDAPConstraints.setControls(LDAPControl)

setControls

public void setControls(LDAPControl[] controls)

Sets an array of controls to be sent to the server.

See Also:

com.novell.ldap.LDAPConstraints.setControls(LDAPControl[])

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)
                 throws LDAPException

Sets a property of the constraints object.

LDAPException

See Also:

com.novell.ldap.LDAPConstraints.setProperty(String, Object)