Package org.forgerock.am.identity.application.model

Class LdapConnectionParameters.Builder

java.lang.Object

org.forgerock.am.identity.application.model.LdapConnectionParameters.Builder

Enclosing class:

LdapConnectionParameters

public abstract static class LdapConnectionParameters.Builder
extends Object

A builder for LdapConnectionParameters.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
abstract LdapConnectionParameters	build()	Builds the LdapConnectionParameters.
abstract LdapConnectionParameters.Builder	ldapPassword(char[] ldapPassword)	Sets the LDAP password.
abstract LdapConnectionParameters.Builder	ldapServers(Set<org.forgerock.openam.ldap.LDAPURL> ldapServers)	Sets the LDAP servers.
abstract LdapConnectionParameters.Builder	ldapUser(String ldapUser)	Sets the LDAP user.
abstract LdapConnectionParameters.Builder	mtlsEnabled(boolean mtlsEnabled)	Sets whether to use mutual TLS.
abstract LdapConnectionParameters.Builder	mtlsSecretLabel(String mtlsSecretLabel)	Sets the mutual TLS secret label.
abstract LdapConnectionParameters.Builder	realm(Realm realm)	Sets the realm.
abstract LdapConnectionParameters.Builder	startSearchLocation(String startSearchLocation)	Sets the start search location.
abstract LdapConnectionParameters.Builder	useStartTls(boolean useStartTls)	Sets whether to use StartTLS.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

ldapServers

public abstract LdapConnectionParameters.Builder ldapServers(Set<org.forgerock.openam.ldap.LDAPURL> ldapServers)

Sets the LDAP servers.

Parameters:

ldapServers - the LDAP servers

Returns:

this builder

ldapUser

public abstract LdapConnectionParameters.Builder ldapUser(String ldapUser)

Sets the LDAP user.

Parameters:

ldapUser - the LDAP user

Returns:

this builder

ldapPassword

public abstract LdapConnectionParameters.Builder ldapPassword(char[] ldapPassword)

Sets the LDAP password.

Parameters:

ldapPassword - the LDAP password

Returns:

this builder

startSearchLocation

public abstract LdapConnectionParameters.Builder startSearchLocation(String startSearchLocation)

Sets the start search location.

Parameters:

startSearchLocation - the start search location

Returns:

this builder

useStartTls

public abstract LdapConnectionParameters.Builder useStartTls(boolean useStartTls)

Sets whether to use StartTLS.

Parameters:

useStartTls - whether to use StartTLS

Returns:

this builder

mtlsEnabled

public abstract LdapConnectionParameters.Builder mtlsEnabled(boolean mtlsEnabled)

Sets whether to use mutual TLS.

Parameters:

mtlsEnabled - whether to use mutual TLS

Returns:

this builder

mtlsSecretLabel

public abstract LdapConnectionParameters.Builder mtlsSecretLabel(String mtlsSecretLabel)

Sets the mutual TLS secret label.

Parameters:

mtlsSecretLabel - the mutual TLS secret label

Returns:

this builder

realm

public abstract LdapConnectionParameters.Builder realm(Realm realm)

Sets the realm.

Parameters:

realm - the realm

Returns:

this builder

build

public abstract LdapConnectionParameters build()

Builds the LdapConnectionParameters.

Returns:

the LdapConnectionParameters