public class LDAPConnectionOptions extends Object
Constructor and Description |
---|
LDAPConnectionOptions()
Creates a the connection options instance.
|
Modifier and Type | Method and Description |
---|---|
boolean |
addSASLProperty(String property)
Add a property to the list of SASL properties.
|
boolean |
getReportAuthzID()
Indicates whether to request that the server return the authorization ID in
the bind response.
|
String |
getSASLMechanism()
Get the SASL mechanism used for authentication.
|
Map<String,List<String>> |
getSASLProperties()
Get the SASL options used for authentication.
|
SSLConnectionFactory |
getSSLConnectionFactory()
Return the SSLConnectionFactory instance.
|
int |
getVersionNumber()
Get the LDAP version number.
|
boolean |
isVerbose()
Indicates whether verbose tracing is enabled.
|
void |
setReportAuthzID(boolean reportAuthzID)
Specifies whether to request that the server return the authorization ID in
the bind response.
|
void |
setSASLExternal(boolean saslExternal)
Set whether to use SASL EXTERNAL for the connection or not.
|
boolean |
setSASLMechanism(String mechanism)
Set the SASL mechanism used for authentication.
|
void |
setSSLConnectionFactory(SSLConnectionFactory sslConnectionFactory)
Set the SSL connection factory to use to create SSL connections.
|
void |
setStartTLS(boolean startTLS)
Set whether to use startTLS for the connection or not.
|
void |
setUsePasswordPolicyControl(boolean usePasswordPolicyControl)
Specifies whether to use the password policy control in the bind request.
|
void |
setUseSSL(boolean useSSL)
Set whether to use SSL for the connection or not.
|
void |
setVerbose(boolean verbose)
Specifies whether verbose tracing should be enabled.
|
void |
setVersionNumber(int version)
Set the LDAP version number.
|
boolean |
usePasswordPolicyControl()
Indicates whether to use the password policy control in the bind request.
|
boolean |
useSASLExternal()
Return the saslExternal flag value.
|
boolean |
useSSL()
Return the useSSL flag value.
|
boolean |
useStartTLS()
Return the startTLS flag value.
|
public LDAPConnectionOptions()
public void setUseSSL(boolean useSSL)
useSSL
- True if SSL should be used, false otherwise.public boolean useSSL()
true
if SSL should be used, or false
if not.public void setStartTLS(boolean startTLS)
startTLS
- True if startTLS should be used, false otherwise.public boolean useStartTLS()
true
if StartTLS should be used, or
false
if not.public void setSASLExternal(boolean saslExternal)
saslExternal
- True if SASL EXTERNAL should be used,
false otherwise.public boolean useSASLExternal()
true
if SASL EXTERNAL should be used, or
false
if not.public void setSSLConnectionFactory(SSLConnectionFactory sslConnectionFactory)
sslConnectionFactory
- The SSL connection factory.public SSLConnectionFactory getSSLConnectionFactory()
public boolean setSASLMechanism(String mechanism)
mechanism
- The SASL mechanism string, in "name=value" form.true
if the SASL mechanism was set, or
false
if not.public String getSASLMechanism()
public Map<String,List<String>> getSASLProperties()
public boolean addSASLProperty(String property)
property
- The property (in name=value form) to add to the set of
SASL properties.true
if the property was set properly, or
false
if not.public void setVersionNumber(int version)
version
- The LDAP version number.public int getVersionNumber()
public boolean getReportAuthzID()
true
if the server should include the authorization
ID in the bind response, or false
if not.public void setReportAuthzID(boolean reportAuthzID)
reportAuthzID
- Specifies whether to request that the server return
the authorization ID in the bind response.public boolean usePasswordPolicyControl()
true
if the password policy control should be
included in the bind request, or false
if not.public void setUsePasswordPolicyControl(boolean usePasswordPolicyControl)
usePasswordPolicyControl
- Specifies whether to use the password
policy control in the bind request.public boolean isVerbose()
true
if verbose tracing is enabled.public void setVerbose(boolean verbose)
verbose
- Specifies whether verbose tracing should be enabled.Copyright © 2010-2017 ForgeRock AS. All Rights Reserved.