Package com.suncode.pwfl.administration.user

Interface UserService

public interface UserService
Umożliwia zarządzanie użytkownikami i grupami użytkowników.
Author:
Paweł Rosolak 05-10-2012

  • Method Details

    • createUser

      void createUser(User user, String groupName) throws UserAlreadyExistException, GroupNotFoundException
      Dodaje użytkownika do systemu
      Parameters:
      user - Obiekt użytkownika
      groupName - Nazwa grupy do której zostanie przypisany użytkownik
      Throws:
      UserAlreadyExistException - Jeżeli użytkownik o podanym loginie już istnieje
      GroupNotFoundException - Jeżeli grupa, do której jest przypisany użytkownik nie istnieje

    • createUser

      void createUser(User user, List<Long> groupIds, List<Long> positionIds) throws UserAlreadyExistException, GroupNotFoundException
      Dodaje użytkownika do systemu
      Parameters:
      user - Obiekt użytkownika
      groupIds - Lista id grup, do których zostanie przypisany użytkownik
      positionIds - Lista id stanowisk, do których zostanie przypisane użytkownik
      Throws:
      UserAlreadyExistException - Jeżeli użytkownik o podanym loginie już istnieje
      GroupNotFoundException - Jeżeli grupa, do której ma zostać przypisany użytkownik nie istnieje

    • deactivateUser

      void deactivateUser(String userName)
      Dezaktywuje użytkownika. Wszystkie widoki, zastępstwa, powiadomienia, raporty i otwarte zadania oraz możliwe przyszłe zadania użytkownika zostaną przepisane do admina.
      Parameters:
      userName - Login użytkownika

    • deactivateUser

      void deactivateUser(String userName, String targetUserName)
      Dezaktywuje użytkowników.
      Parameters:
      userName - Login użytkownika
      targetUserName - Login użytkownika docelowego na którego przepisane zostaną powiązania dezaktywowanego użytkownika. Zadania zostaną przepisane na użytkownika domyślnego.

    • deactivateUser

      void deactivateUser(String userName, String targetUserName, boolean transferActivities)
      Dezaktywuje użytkowników.
      Parameters:
      userName - Login użytkownika
      targetUserName - Login użytkownika docelowego na którego przepisane zostaną powiązania dezaktywowanego użytkownika
      transferActivities - Określa czy zadania użytkownika mają być przepisane na użytkownika z parametru targetUserName. Jeżeli false to zadania zostaną przepisane na użytkownika domyślnego

    • deactivateUser

      void deactivateUser(Deactivation deactivation)
      Dezaktywuje użytkownika.
      Parameters:
      deactivation - Obiekt zawierający wszystkie informacje niezbędne do dezaktywacji użytkownika.

    • deleteUser

      void deleteUser(String userName) throws UserNotFoundException
      Usuwa użytkownika o podanym loginie
      Parameters:
      userName - Login użytkownika
      Throws:
      UserNotFoundException - Jeżeli użytkownik o podanym loginie nie istnieje

    • updateUser

      void updateUser(User user) throws UserNotFoundException
      Modyfikuje informacje o użytkowniku.
      Parameters:
      user - Obiekt użytkownika
      Throws:
      UserNotFoundException - Jeżeli użytkownik o podanym loginie nie istnieje

    • addUserToGroups

      void addUserToGroups(String userName, List<String> groups) throws UserNotFoundException, GroupNotFoundException
      Przypisuje użytkownika do wskazanych grup
      Parameters:
      userName - Login użytkownika
      groups - Lista nazw grup
      Throws:
      UserNotFoundException - Jeżeli użytkownik o podanym loginie nie istnieje
      GroupNotFoundException - Jeżeli, któraś z podanych grup nie istnieje

    • addUserToGroup

      void addUserToGroup(String userName, String groupName) throws UserNotFoundException, GroupNotFoundException
      Przypisuje użytkownika do wskazanej grupy
      Parameters:
      userName - Login użytkownika
      groupName - Nazwa grupy do której chcemy dodać użytkownika
      Throws:
      UserNotFoundException - Jeżeli użytkownik o podanym loginie nie istnieje
      GroupNotFoundException - Jeżeli grupa nie istnieje

    • removeUserFromGroup

      void removeUserFromGroup(String userName, String groupName) throws UserNotFoundException
      Usuwa użytkownika z podanej grupy
      Parameters:
      userName - Login użytkownika
      groupName - Nazwa grupy
      Throws:
      UserNotFoundException - Jeżeli użytkownik o podanym loginie nie istnieje

    • removeUserFromGroups

      void removeUserFromGroups(String userName, List<String> groups) throws UserNotFoundException
      Usuwa użytkownika z podanych grup
      Parameters:
      userName - Login użytkownika
      groups - Lista nazw grup
      Throws:
      UserNotFoundException - Jeżeli użytkownik o podanym loginie nie istnieje

    • activateUser

      void activateUser(String userName)
      Aktywuje użytkownika
      Parameters:
      userName - Login użytkownika

    • isActive

      boolean isActive(String userName)
      Sprawdza czy użytkownik jest aktywny
      Parameters:
      userName - Login użytkownika
      Returns:
      True jeżeli użytkownik jest aktywny

    • getUser

      User getUser(String userName, String... joins)
      Pobiera użytkownika po loginie.
      Parameters:
      userName - Login użytkownika
      joins - Określa, które elementy mamy dołączyć do obiektu User.
      Returns:
      Obiekt użytkownika.

    • getUser

      User getUser(Long id, String... joins)
      Pobiera użytkownika po id.
      Parameters:
      id - Id użytkownika
      joins - Określa, które elementy mamy dołączyć do obiektu User.
      Returns:
      Obiekt użytkownika. Jeżeli użytkownik o podanym loginie jest nieaktywny funkcja zwraca null.

    • getUser

      User getUser(String userName, boolean onlyActive, String... joins)
      Pobiera użytkownika po loginie.
      Parameters:
      userName - Login użytkownika
      onlyActive - Określa, czy brać pod uwagę użytkwoników nieaktywnych. Wartość false pozwoli uwzględnić użytkowników nieaktywnych.
      joins - Określa, które elementy mamy dołączyć do obiektu User.
      Returns:
      Obiekt użytkownika

    • getUser

      User getUser(Long id, boolean onlyActive, String... joins)
      Pobiera użytkownika po id.
      Parameters:
      id - Id użytkownika
      onlyActive - Określa, czy brać pod uwagę użytkwoników nieaktywnych. Wartość false pozwoli uwzględnić użytkowników nieaktywnych.
      joins - Określa, które elementy mamy dołączyć do obiektu User.
      Returns:
      Obiekt użytkownika

    • changeUserPassword

      void changeUserPassword(String userName, String password) throws UserNotFoundException
      Metoda zmienia hasło użytkownikowi za pomocą szyfrowania sharkowego.
      Parameters:
      userName - Login użytkownika, któremu hasło ma zostać zmienione
      password - Hasło, jakie ma zostać ustawione użytkownikowi.
      Throws:
      UserNotFoundException - Jeżeli użytkownik o podanym loginie nie istnieje

    • getGroup

      UserGroup getGroup(Long id, String... joins)
      Pobiera groupę po id.
      Parameters:
      id - Id grupy
      joins - Określa, które elementy mamy dołączyć do obiektu UserGroup.
      Returns:
      Obiekt użytkownika

    • getGroup

      UserGroup getGroup(String name, String... joins)
      Pobiera grupę o podanej nazwie
      Parameters:
      name - Nazwa grupy
      joins - Określa, które elementy mamy dołączyć do obiektu grupy.
      Returns:
      Obiekt grupy

    • createGroup

      void createGroup(UserGroup group) throws GroupAlreadyExistException
      Zapisuje grupę w bazie danych
      Parameters:
      group - Obiekt grupy. Musi posiadać nazwę.
      Throws:
      GroupAlreadyExistException - Jeżeli grupa o podanej nazwie już istnieje

    • deleteGroup

      void deleteGroup(String groupName) throws GroupNotFoundException
      Usuwa grupę z systemu.
      Parameters:
      groupName - Nazwa grupy, którą chcemy usunąć.
      Throws:
      GroupNotFoundException - Jeżeli nie znaleziono grupy o podanej nazwie

    • updateGroup

      void updateGroup(UserGroup userGroup) throws GroupNotFoundException
      Zmienia opis grupy
      Parameters:
      groupName - Nazwa grupy
      description - Nowy opis grupy
      Throws:
      GroupNotFoundException - Jeżeli nie znaleziono grupy o podanej nazwie

    • hashPassword

      String hashPassword(String rawPassword)