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.security.Permission;
  13 import java.util.List;
  14 import java.util.UUID;
  15
  16 import org.hibernate.criterion.Criterion;
  17 import org.springframework.dao.DataAccessException;
  18 import org.springframework.security.core.Authentication;
  19 import org.springframework.security.core.GrantedAuthority;
  20 import org.springframework.security.core.userdetails.UsernameNotFoundException;
  21 import org.springframework.security.provisioning.GroupManager;
  22 import org.springframework.security.provisioning.UserDetailsManager;
  23
  24 import eu.etaxonomy.cdm.model.common.Group;
  25 import eu.etaxonomy.cdm.model.common.User;
  26 import eu.etaxonomy.cdm.persistence.dao.BeanInitializer;
  27 import eu.etaxonomy.cdm.persistence.query.MatchMode;
  28 import eu.etaxonomy.cdm.persistence.query.OrderHint;
  29
  30 public interface IUserService extends IService<User>, UserDetailsManager, GroupManager {
  31
  32         public void changePasswordForUser(String username, String password) throws UsernameNotFoundException, DataAccessException;
  33
  34         public UUID saveGrantedAuthority(GrantedAuthority grantedAuthority);
  35
  36         public UUID saveGroup(Group group);
  37
  38         /**
  39          * Return a List of users matching the given query string, optionally filtered by class, optionally with a particular MatchMode
  40          *
  41          * @param queryString the query string to filter by
  42          * @param matchmode use a particular type of matching (can be null - defaults to exact matching)
  43          * @param criteria additional criteria to filter by
  44          * @param pageSize The maximum number of objects returned (can be null for all objects)
  45          * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
  46          * @param propertyPaths properties to initialize - see {@link BeanInitializer#initialize(Object, List)}
  47          * @param orderHints
  48          *            Supports path like <code>orderHints.propertyNames</code> which
  49          *            include *-to-one properties like createdBy.username or
  50          *            authorTeam.persistentTitleCache
  51          * @return a list of instances of type User matching the queryString
  52          *
  53          * @see {@link IIdentifiableEntityService#listByTitle(Class, String, MatchMode, List, Integer, Integer, List, List)}
  54          *
  55          */
  56     public List<User> listByUsername(String queryString, MatchMode matchmode, List<Criterion> criteria, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths);
  57
  58
  59 }