Interface LdapUserDefinitionKeyProvider

  • All Known Implementing Classes:
    DefaultLdapUserDefinitionKeyProvider

    public interface LdapUserDefinitionKeyProvider
    A provider for a user definition key based on LDAP user Attributes.
    Author:
    Filip Hrisafov
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.Optional<org.springframework.ldap.filter.Filter> createUserDefinitionKeyFilter​(java.lang.String queryUserDefinitionKey)
      Method for providing the optional Filter for the user definition key being queried.
      java.lang.String determineUserDefinitionKey​(javax.naming.directory.Attributes attributes)
      Method for extracting the user definition key from the provided Attributes
    • Method Detail

      • determineUserDefinitionKey

        java.lang.String determineUserDefinitionKey​(javax.naming.directory.Attributes attributes)
        Method for extracting the user definition key from the provided Attributes
        Parameters:
        attributes - the attributes that can be used to determine the user definition key
        Returns:
        the user definition key for the user
      • createUserDefinitionKeyFilter

        java.util.Optional<org.springframework.ldap.filter.Filter> createUserDefinitionKeyFilter​(java.lang.String queryUserDefinitionKey)
        Method for providing the optional Filter for the user definition key being queried. If no filter is provided, then querying on user definition key would be ignored.
        Parameters:
        queryUserDefinitionKey - the query user definition key, never null
        Returns:
        the optional LDAP filter