com.landoop.lenses.security.ldap.LdapUserGroupsPlugin Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lenses-ldap-plugin Show documentation

Lenses library providing the interface a customer will have to implement in order to provide LDAP user roles/groups for the authenticated user

The newest version!

package com.landoop.lenses.security.ldap;

import com.typesafe.config.Config;
import org.springframework.ldap.core.LdapEntryIdentification;

import javax.naming.directory.DirContext;

public interface LdapUserGroupsPlugin {
  /**
   * Initializes the plugin by providing the instance of configuration containing all the entries it requires
   *
   * @param config An instance of {@code com.typesafe.config.Config}. This entry will contain the value setup in Lenses
   *               under the key 'lenses.security.ldap.plugin'
   */
  void initialize(Config config);

  /***
   * Returns all the groups for the person entry represented by {@code ldapEntryIdentification}
   * @param ctx  The DirContext instance to perform an operation on.
   * @param ldapEntryIdentification The identification of the LDAP entry used to authenticate the supplied DirContext.
   * @return An instance of {@link UserInfo}
   */
  UserInfo getUserInfo(DirContext ctx,
                       LdapEntryIdentification ldapEntryIdentification);
}