cdmlib-services/src/main/java/eu/etaxonomy/cdm/api/service/IUserService.java

   1 /**
   2 * Copyright (C) 2009 EDIT
   3 * European Distributed Institute of Taxonomy
   4 * http://www.e-taxonomy.eu
   5 *
   6 * The contents of this file are subject to the Mozilla Public License Version 1.1
   7 * See LICENSE.TXT at the top of this package for the full license terms.
   8 */
   9
  10 package eu.etaxonomy.cdm.api.service;
  11
  12 import java.util.List;
  13 import java.util.UUID;
  14
  15 import org.hibernate.criterion.Criterion;
  16 import org.springframework.dao.DataAccessException;
  17 import org.springframework.security.core.GrantedAuthority;
  18 import org.springframework.security.core.userdetails.UsernameNotFoundException;
  19 import org.springframework.security.provisioning.GroupManager;
  20 import org.springframework.security.provisioning.UserDetailsManager;
  21
  22 import eu.etaxonomy.cdm.model.common.User;
  23 import eu.etaxonomy.cdm.persistence.dao.initializer.IBeanInitializer;
  24 import eu.etaxonomy.cdm.persistence.query.MatchMode;
  25 import eu.etaxonomy.cdm.persistence.query.OrderHint;
  26
  27 public interface IUserService extends IService<User>, UserDetailsManager, GroupManager {
  28
  29     public void changePasswordForUser(String username, String password) throws UsernameNotFoundException, DataAccessException;
  30
  31     public UUID saveGrantedAuthority(GrantedAuthority grantedAuthority);
  32
  33
  34
  35     /**
  36      * Return a List of users matching the given query string, optionally filtered by class, optionally with a particular MatchMode
  37      *
  38      * @param queryString the query string to filter by
  39      * @param matchmode use a particular type of matching (can be null - defaults to exact matching)
  40      * @param criteria additional criteria to filter by
  41      * @param pageSize The maximum number of objects returned (can be null for all objects)
  42      * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
  43      * @param propertyPaths properties to initialize - see {@link IBeanInitializer#initialize(Object, List)}
  44      * @param orderHints
  45      *            Supports path like <code>orderHints.propertyNames</code> which
  46      *            include *-to-one properties like createdBy.username or
  47      *            authorTeam.persistentTitleCache
  48      * @return a list of instances of type User matching the queryString
  49      *
  50      * @see {@link IIdentifiableEntityService#listByTitle(Class, String, MatchMode, List, Integer, Integer, List, List)}
  51      *
  52      */
  53     public List<User> listByUsername(String queryString, MatchMode matchmode, List<Criterion> criteria, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths);
  54
  55
  56
  57 }