object LdapUtils extends Logging

Static utility methods related to LDAP authentication module.

Linear Supertypes
Logging, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LdapUtils
  2. Logging
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. def createCandidatePrincipals(conf: KyuubiConf, user: String): Array[String]

    Creates a list of principals to be used for user authentication.

    Creates a list of principals to be used for user authentication.

    conf

    Kyuubi configuration

    user

    username

    returns

    a list of user's principals

  7. def debug(message: ⇒ Any, t: Throwable): Unit
    Definition Classes
    Logging
  8. def debug(message: ⇒ Any): Unit
    Definition Classes
    Logging
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. def error(message: ⇒ Any): Unit
    Definition Classes
    Logging
  12. def error(message: ⇒ Any, t: Throwable): Unit
    Definition Classes
    Logging
  13. def extractBaseDn(dn: String): String

    Extracts a base DN from the provided distinguished name.

    Extracts a base DN from the provided distinguished name.
    Example:
    "ou=CORP,dc=mycompany,dc=com" is the base DN for "cn=user1,ou=CORP,dc=mycompany,dc=com"

    dn

    distinguished name

    returns

    base DN

  14. def extractFirstRdn(dn: String): String

    Extracts the first Relative Distinguished Name (RDN).

    Extracts the first Relative Distinguished Name (RDN).
    Example:
    For DN "cn=user1,ou=CORP,dc=mycompany,dc=com" this method will return "cn=user1"

    dn

    distinguished name

    returns

    first RDN

  15. def extractUserName(userDn: String): String

    Extracts username from user DN.

    Extracts username from user DN.
    Examples:

    LdapUtils.extractUserName("UserName")                        = "UserName"
    LdapUtils.extractUserName("UserName@mycorp.com")             = "UserName"
    LdapUtils.extractUserName("cn=UserName,dc=mycompany,dc=com") = "UserName"
    

  16. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. def getShortName(rdn: String): String

    Gets value part of the first attribute in the provided RDN.

    Gets value part of the first attribute in the provided RDN.
    Example:
    For RDN "cn=user1,ou=CORP" this method will return "user1"

    rdn

    Relative Distinguished Name

    returns

    value part of the first attribute

  19. def getUserName(user: String): String

    Get the username part in the provided user.

    Get the username part in the provided user.
    Example:
    For user "user1@mycorp.com" this method will return "user1"

    user

    user

    returns

    the username part in the provided user

  20. def hasDomain(userName: String): Boolean

    Check for a domain part in the provided username.

    Check for a domain part in the provided username.
    Example:

    LdapUtils.hasDomain("user1@mycorp.com") = true
    LdapUtils.hasDomain("user1")            = false
    

    userName

    username

    returns

    true if userName contains @<domain> part

  21. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  22. def info(message: ⇒ Any, t: Throwable): Unit
    Definition Classes
    Logging
  23. def info(message: ⇒ Any): Unit
    Definition Classes
    Logging
  24. def initializeLoggerIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  25. def isDn(name: String): Boolean

    Detects DN names.

    Detects DN names.
    Example:

    LdapUtils.isDn("cn=UserName,dc=mycompany,dc=com") = true
    LdapUtils.isDn("user1")                           = false
    

    name

    name to be checked

    returns

    true if the provided name is a distinguished name

  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. def logger: Logger
    Attributes
    protected
    Definition Classes
    Logging
  28. def loggerName: String
    Attributes
    protected
    Definition Classes
    Logging
  29. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  31. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  32. def parseDnPatterns(conf: KyuubiConf, confKey: OptionalConfigEntry[String]): Array[String]

    Reads and parses DN patterns from Kyuubi configuration.

    Reads and parses DN patterns from Kyuubi configuration.
    If no patterns are provided in the configuration, then the base DN will be used.

    conf

    Kyuubi configuration

    confKey

    configuration key to be read

    returns

    a list of DN patterns

    See also

    KyuubiConf.AUTHENTICATION_LDAP_BASE_DN

    KyuubiConf.AUTHENTICATION_LDAP_GUID_KEY

    KyuubiConf.AUTHENTICATION_LDAP_GROUP_DN_PATTERN

    KyuubiConf.AUTHENTICATION_LDAP_USER_DN_PATTERN

  33. def patternsToBaseDns(patterns: Array[String]): Array[String]

    Converts a collection of Distinguished Name patterns to a collection of base DNs.

    Converts a collection of Distinguished Name patterns to a collection of base DNs.

    patterns

    Distinguished Name patterns

    returns

    a list of base DNs

    See also

    KyuubiConf.AUTHENTICATION_LDAP_GROUP_DN_PATTERN

    KyuubiConf.AUTHENTICATION_LDAP_USER_DN_PATTERN

  34. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  35. def toString(): String
    Definition Classes
    AnyRef → Any
  36. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  39. def warn(message: ⇒ Any, t: Throwable): Unit
    Definition Classes
    Logging
  40. def warn(message: ⇒ Any): Unit
    Definition Classes
    Logging

Inherited from Logging

Inherited from AnyRef

Inherited from Any

Ungrouped