LdapConnectionConfig (formcycle: bom 8.5.6 API)

java.lang.Object
- de.xima.fc.ldap.LdapConnectionConfig

All Implemented Interfaces:

Serializable
```
public final class LdapConnectionConfig
extends Object
implements Serializable
```
Model representing the configuration for an LDAP connection.

Since:

8.5.0

Author:

Norman Lorenz

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class LdapConnectionConfig.Builder

static class LdapConnectionConfig.TlsScope

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static LdapConnectionConfig.Builder`	`builder()`
`boolean`	`equals(Object o)`
`String`	`getBindDN()`	(Optional) Returns the bind DN (Distinguished Name).
`String`	`getBindPassword()`	(Optional) Returns the bind password.
`Integer`	`getHopCount()`	Returns the referral hop count for the connection.
`String`	`getHost()`	Returns the LDAP server host.
`int`	`getPort()`	Returns the LDAP server port.
`LdapConnectionConfig.TlsScope`	`getTlsScope()`	Returns the TLS scope for the connection.
`int`	`hashCode()`
`boolean`	`isUseTls()`	Indicates whether TLS/SSL is used for the connection.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - isUseTls
```
public boolean isUseTls()
```
    Indicates whether TLS/SSL is used for the connection. If true, the connection will be established using TLS/SSL. In this case getTlsScope() must not return null.
    
    Returns:
    
    True if TLS/SSL is used, false otherwise.
    
    See Also:
    
    getTlsScope()
  - builder
```
public static LdapConnectionConfig.Builder builder()
```
  - getHost
```
public String getHost()
```
    Returns the LDAP server host.
  - getPort
```
public int getPort()
```
    Returns the LDAP server port.
  - getBindDN
```
@Nullable
public String getBindDN()
```
    (Optional) Returns the bind DN (Distinguished Name).
  - getBindPassword
```
@Nullable
public String getBindPassword()
```
    (Optional) Returns the bind password.
  - getHopCount
```
@Nullable
public Integer getHopCount()
```
    Returns the referral hop count for the connection.
  - getTlsScope
```
@Nullable
public LdapConnectionConfig.TlsScope getTlsScope()
```
    Returns the TLS scope for the connection. This is only relevant if isUseTls() returns true.
    
    See Also:
    
    isUseTls()
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object