|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.migrate.ldapjdk.LDAPConstraints
@NotExtensible @Mutable @ThreadSafety(level=NOT_THREADSAFE) public class LDAPConstraints
This class provides a data structure which may be used to define a set of
constraints that may be used when processing operations.
This class is primarily intended to be used in the process of updating
applications which use the Netscape Directory SDK for Java to switch to or
coexist with the UnboundID LDAP SDK for Java. For applications not written
using the Netscape Directory SDK for Java, the
LDAPConnectionOptions
class should be used
instead.
Constructor Summary | |
---|---|
LDAPConstraints()
Creates a new default set of constraints. |
|
LDAPConstraints(int msLimit,
boolean doReferrals,
LDAPBind bindProc,
int hopLimit)
Creates a set of LDAP constraints with the provided information. |
|
LDAPConstraints(int msLimit,
boolean doReferrals,
LDAPRebind rebindProc,
int hopLimit)
Creates a set of LDAP constraints with the provided information. |
Method Summary | |
---|---|
LDAPConstraints |
duplicate()
Retrieves a duplicate of this LDAP constraints object. |
LDAPBind |
getBindProc()
Retrieves the object that should be used to authenticate connections when following referrals. |
LDAPControl[] |
getClientControls()
Retrieves the controls that should be applied by the clients. |
int |
getHopLimit()
Retrieves the maximum number of hops to take when attempting to follow a referral. |
LDAPRebind |
getRebindProc()
Retrieves the object that should be used to obtain authentication information for use when following referrals. |
boolean |
getReferrals()
Indicates whether the client should automatically attempt to follow referrals. |
LDAPControl[] |
getServerControls()
Retrieves the controls that should be applied by the server. |
int |
getTimeLimit()
Retrieves the maximum length of time in milliseconds to wait for a response from the server. |
void |
setBindProc(LDAPBind bindProc)
Specifies the object that should be used to authenticate connections when following referrals. |
void |
setClientControls(LDAPControl control)
Specifies the controls that should be applied by the client. |
void |
setClientControls(LDAPControl[] controls)
Specifies the controls that should be applied by the client. |
void |
setHopLimit(int hopLimit)
Retrieves the maximum number of hops to take when attempting to follow a referral. |
void |
setRebindProc(LDAPRebind rebindProc)
Specifies the object that should be used to obtain authentication information for use when following referrals. |
void |
setReferrals(boolean doReferrals)
Specifies whether the client should automatically attempt to follow referrals. |
void |
setServerControls(LDAPControl control)
Specifies the controls that should be applied by the server. |
void |
setServerControls(LDAPControl[] controls)
Specifies the controls that should be applied by the server. |
void |
setTimeLimit(int timeLimit)
Specifies the maximum length of time in milliseconds to wait for a response from the server. |
java.lang.String |
toString()
Retrieves a string representation of this LDAP constraints object. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public LDAPConstraints()
public LDAPConstraints(int msLimit, boolean doReferrals, LDAPBind bindProc, int hopLimit)
msLimit
- The maximum length of time in milliseconds to wait for
a response from the server.doReferrals
- Indicates whether to attempt to follow referrals.bindProc
- The object to use to authenticate a connection when
following referrals.hopLimit
- The maximum number of hops to take when following a
referral.public LDAPConstraints(int msLimit, boolean doReferrals, LDAPRebind rebindProc, int hopLimit)
msLimit
- The maximum length of time in milliseconds to wait for
a response from the server.doReferrals
- Indicates whether to attempt to follow referrals.rebindProc
- The object to use to provide the information needed to
authenticate a connection created for following a
referral.hopLimit
- The maximum number of hops to take when following a
referral.Method Detail |
---|
public int getTimeLimit()
public void setTimeLimit(int timeLimit)
timeLimit
- The maximum length of time in milliseconds to wait for a
response from the server.public boolean getReferrals()
true
if the client should attempt to follow referrals, or
false
if not.public void setReferrals(boolean doReferrals)
doReferrals
- Indicates whether the client should automatically
attempt to follow referrals.public LDAPBind getBindProc()
null
if none has been defined.public void setBindProc(LDAPBind bindProc)
bindProc
- The object that should be used to authenticate
connections when following referrals.public LDAPRebind getRebindProc()
null
if
none has been defined.public void setRebindProc(LDAPRebind rebindProc)
rebindProc
- The object that should be used to obtain authentication
information for use when following referrals.public int getHopLimit()
public void setHopLimit(int hopLimit)
hopLimit
- The maximum number of hops to take when attempting to
follow a referral.public LDAPControl[] getClientControls()
public void setClientControls(LDAPControl control)
control
- The control that should be applied by client.public void setClientControls(LDAPControl[] controls)
controls
- The controls that should be applied by client.public LDAPControl[] getServerControls()
public void setServerControls(LDAPControl control)
control
- The control that should be applied by server.public void setServerControls(LDAPControl[] controls)
controls
- The controls that should be applied by server.public LDAPConstraints duplicate()
public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |