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

Record Class LdapConnectionParameters

java.lang.Object
java.lang.Record
org.forgerock.am.identity.application.model.LdapConnectionParameters
Record Components:
ldapServers - the LDAP servers
ldapUser - the LDAP user.
ldapPassword - the LDAP password.
startSearchLocation - the start search location.
useStartTls - whether to use StartTLS.
mtlsEnabled - whether to use mutual TLS.
mtlsSecretLabel - the mutual TLS secret label.
realm - the realm.
@Builder public record LdapConnectionParameters(Set<org.forgerock.openam.ldap.LDAPURL> ldapServers, String ldapUser, char[] ldapPassword, String startSearchLocation, boolean useStartTls, boolean mtlsEnabled, String mtlsSecretLabel, Realm realm) extends Record
Record representing the LDAP store connection parameters.

  • Constructor Details

    • LdapConnectionParameters

      public LdapConnectionParameters(Set<org.forgerock.openam.ldap.LDAPURL> ldapServers, String ldapUser, char[] ldapPassword, String startSearchLocation, boolean useStartTls, boolean mtlsEnabled, String mtlsSecretLabel, Realm realm)
      Creates an instance of a LdapConnectionParameters record class.
      Parameters:
      ldapServers - the value for the ldapServers record component
      ldapUser - the value for the ldapUser record component
      ldapPassword - the value for the ldapPassword record component
      startSearchLocation - the value for the startSearchLocation record component
      useStartTls - the value for the useStartTls record component
      mtlsEnabled - the value for the mtlsEnabled record component
      mtlsSecretLabel - the value for the mtlsSecretLabel record component
      realm - the value for the realm record component

  • Method Details

    • builder

      public static org.forgerock.am.identity.application.model.LdapConnectionParametersBuilder builder()
      Creates a new Builder instance for LdapConnectionParameters.

    • equals

      public boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • ldapServers

      public Set<org.forgerock.openam.ldap.LDAPURL> ldapServers()
      Returns the value of the ldapServers record component.
      Returns:
      the value of the ldapServers record component

    • ldapUser

      public String ldapUser()
      Returns the value of the ldapUser record component.
      Returns:
      the value of the ldapUser record component

    • ldapPassword

      public char[] ldapPassword()
      Returns the value of the ldapPassword record component.
      Returns:
      the value of the ldapPassword record component

    • startSearchLocation

      public String startSearchLocation()
      Returns the value of the startSearchLocation record component.
      Returns:
      the value of the startSearchLocation record component

    • useStartTls

      public boolean useStartTls()
      Returns the value of the useStartTls record component.
      Returns:
      the value of the useStartTls record component

    • mtlsEnabled

      public boolean mtlsEnabled()
      Returns the value of the mtlsEnabled record component.
      Returns:
      the value of the mtlsEnabled record component

    • mtlsSecretLabel

      public String mtlsSecretLabel()
      Returns the value of the mtlsSecretLabel record component.
      Returns:
      the value of the mtlsSecretLabel record component

    • realm

      public Realm realm()
      Returns the value of the realm record component.
      Returns:
      the value of the realm record component