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 Summary

Methods

Modifier and Type	Method and Description
void	activateUser(String userName) Aktywuje użytkownika
void	addUserToGroup(String userName, String groupName) Przypisuje użytkownika do wskazanej grupy
void	addUserToGroups(String userName, List<String> groups) Przypisuje użytkownika do wskazanych grup
void	createGroup(UserGroup group) Zapisuje grupę w bazie danych
void	createUser(User user, String groupName) Dodaje użytkownika do systemu
void	deactivateUser(String userName) Dezaktywuje użytkownika.
void	deleteGroup(String groupName) Usuwa grupę z systemu.
void	deleteUser(String userName) Usuwa użytkownika o podanym loginie
UserGroup	getGroup(Long id, String... joins) Pobiera groupę po id.
UserGroup	getGroup(String name, String... joins) Pobiera grupę o podanej nazwie
User	getUser(Long id, boolean onlyActive, String... joins) Pobiera użytkownika po id.
User	getUser(Long id, String... joins) Pobiera użytkownika po id.
User	getUser(String userName, boolean onlyActive, String... joins) Pobiera użytkownika po loginie.
User	getUser(String userName, String... joins) Pobiera użytkownika po loginie.
boolean	isActive(String userName) Sprawdza czy użytkownik jest aktywny
void	removeUserFromGroup(String userName, String groupName) Usuwa użytkownika z podanej grupy
void	removeUserFromGroups(String userName, List<String> groups) Usuwa użytkownika z podanych grup
void	updateGroup(UserGroup userGroup) Zmienia opis grupy
void	updateUser(User user) Modyfikuje informacje o użytkowniku.

Method Detail

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

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

deactivateUser

void deactivateUser(String userName)

Dezaktywuje użytkownika.

Parameters:

userName - Login użytkownika

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. Jeżeli użytkownik o podanym loginie jest nieaktywny funkcja zwraca null.

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

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