pro.taskana.common.rest.ldap.LdapCache Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of taskana-rest-spring Show documentation

The taskana rest logic.

There is a newer version: 8.2.0

package pro.taskana.common.rest.ldap;

import java.util.List;

import pro.taskana.common.rest.models.AccessIdRepresentationModel;

/**
 * This interface is used for caching Ldap data.
 *
 * @author bbr
 */
public interface LdapCache {

  /**
   * find access ids for users and groups that match specified search criteria.
   *
   * @param searchFor the search string. The search is performed over names and ids of users and
   *     groups.
   * @param maxNumberOfReturnedAccessIds the maximum number of results to return.
   * @return a List of access ids for users and group where the name or id contains the search
   *     string.
   */
  List findMatchingAccessId(
      String searchFor, int maxNumberOfReturnedAccessIds);

  /**
   * Find the groups belong to a user.
   *
   * @param searchFor the search string. The search is performed over names and ids of group .
   * @param maxNumberOfReturnedAccessIds the maximum number of results to return.
   * @return a List of access ids for groups of users.
   */
  List findGroupsOfUser(
      String searchFor, int maxNumberOfReturnedAccessIds);

  /**
   * Validate a access id.
   *
   * @param accessId the search string.
   * @return the corresponding access ids.
   */
  List validateAccessId(String accessId);
}