net.datenwerke.security.service.usermanager

Interface UserManagerService

All Superinterfaces:

TreeDBManager<AbstractUserManagerNode>

All Known Implementing Classes:

UserManagerServiceImpl

public interface UserManagerService
extends TreeDBManager<AbstractUserManagerNode>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MODULE_NAME
static java.lang.String	SECUREE_ID

Method Summary

Modifier and Type	Method and Description
void	changePassword(java.lang.String username, java.lang.String oldPassword, java.lang.String newPassword)
void	changePassword(User user, java.lang.String oldPassword, java.lang.String newPassword)
java.util.Collection<Group>	getAllGroups() Returns a Collection of all existing Groups
java.util.Collection<OrganisationalUnit>	getAllOUs()
java.util.Set<User>	getAllTransitiveUsers(AbstractUserManagerNode node) Returns all users underneath the node.
java.util.Collection<User>	getAllUsers() Returns a Collection of all existing Users
java.util.Collection<Group>	getDirectGroups(User user) Returns groups in which the user is a direct member.
Group	getGroupByName(java.lang.String name) Finds a Group by name
java.util.Set<Group>	getGroups(java.util.Collection<java.lang.Long> groupIds) Returns a Set of Groups defined by the given Collection of IDs
java.util.List<Group>	getGroupsWithMember(Group group)
java.util.List<Group>	getGroupsWithMember(OrganisationalUnit ou)
java.util.Collection<Group>	getIndirectGroups(User user) Returns groups in which the user is an indirect member.
AbstractUserManagerNode	getNodeById(long id) Searches for a AbstractUserManagerNode by its id
long	getNumberOfActiveUsers() Returns the number of active users in the system, that is, not inhibited and not with accounts not expired.
long	getNumberOfExpiredUsers()
long	getNumberOfInhibitedUsers()
java.util.Set<OrganisationalUnit>	getOUs(java.util.Collection<java.lang.Long> ids)
java.util.List<OrganisationalUnit>	getOUsByName(java.lang.String name) Searches for a OrganisationalUnit by its name
java.util.Collection<Group>	getReferencedGroups(User user) Returns all groups in which the user is a direct or indirect member.
User	getUserByMail(java.lang.String mail) Finds a User by email
User	getUserByName(java.lang.String name) Finds a User by name
User	getUserOrNull(java.lang.String username)
java.util.Set<User>	getUsers(java.util.Collection<java.lang.Long> ids) Returns a Set of Users defined by the given Collection of IDs
java.util.Set<User>	getUsers(java.util.Collection<java.lang.Long> ids, boolean dereferenceGroups) Returns User objects for all given IDs (be they user or group)
java.util.Collection<User>	getUsersByMail(java.lang.String email)
AbstractUserManagerNode	merge(AbstractUserManagerNode node) Merge's the submitted AbstractUserManagerNode with the representation in the database
void	persist(AbstractUserManagerNode node) Persists the submitted AbstractUserManagerNode
void	remove(AbstractUserManagerNode node) Removes the submitted AbstractUserManagerNode from the database
void	setPassword(User user, java.lang.String newPassword) Sets the Users password
boolean	userInFolk(User user, AbstractUserManagerNode folk) Tests whether the submitted User is part of the folk.

Methods inherited from interface net.datenwerke.treedb.service.treedb.TreeDBManager

allowsMultipleRoots, copy, forceRemove, getAllNodes, getBaseType, getChildrenWithName, getNodeByKey, getRoots, getVirtualRoots, isFolder, move, move, updateFlags

Field Detail

MODULE_NAME

static final java.lang.String MODULE_NAME

See Also:

Constant Field Values

SECUREE_ID

static final java.lang.String SECUREE_ID

See Also:

Constant Field Values

Method Detail

getUserByName

User getUserByName(java.lang.String name)

Finds a User by name

Parameters:

name - The User's name

Returns:

The corresponding User

getUserOrNull

User getUserOrNull(java.lang.String username)

getUserByMail

User getUserByMail(java.lang.String mail)

Finds a User by email

Returns:

The corresponding User

getGroupByName

Group getGroupByName(java.lang.String name)

Finds a Group by name

Parameters:

name - The Group's name

Returns:

The corresponding Group

getOUsByName

java.util.List<OrganisationalUnit> getOUsByName(java.lang.String name)

Searches for a OrganisationalUnit by its name

Parameters:

name - The name of the OrganisationalUnit

Returns:

The corresponding OrganisationalUnit

getNodeById

AbstractUserManagerNode getNodeById(long id)

Searches for a AbstractUserManagerNode by its id

Specified by:

getNodeById in interface TreeDBManager<AbstractUserManagerNode>

Parameters:

id - The ID

Returns:

The AbstractUserManagerNode identified by the given ID

getAllUsers

java.util.Collection<User> getAllUsers()

Returns a Collection of all existing Users

Returns:

A Collection of Users

getAllGroups

java.util.Collection<Group> getAllGroups()

Returns a Collection of all existing Groups

Returns:

A Collection of Groups

getAllOUs

java.util.Collection<OrganisationalUnit> getAllOUs()

setPassword

void setPassword(User user,
                 java.lang.String newPassword)

Sets the Users password

Parameters:

user - The User

newPassword - The new password

changePassword

void changePassword(User user,
                    java.lang.String oldPassword,
                    java.lang.String newPassword)
             throws ExpectedException

Throws:

ExpectedException

changePassword

void changePassword(java.lang.String username,
                    java.lang.String oldPassword,
                    java.lang.String newPassword)
             throws ExpectedException

Throws:

ExpectedException

persist

void persist(AbstractUserManagerNode node)

Persists the submitted AbstractUserManagerNode

Specified by:

persist in interface TreeDBManager<AbstractUserManagerNode>

Parameters:

node - The AbstractUserManagerNode

merge

AbstractUserManagerNode merge(AbstractUserManagerNode node)

Merge's the submitted AbstractUserManagerNode with the representation in the database

Specified by:

merge in interface TreeDBManager<AbstractUserManagerNode>

Parameters:

node - The AbstractUserManagerNode

remove

void remove(AbstractUserManagerNode node)

Removes the submitted AbstractUserManagerNode from the database

Specified by:

remove in interface TreeDBManager<AbstractUserManagerNode>

Parameters:

node - AbstractUserManagerNode

userInFolk

boolean userInFolk(User user,
                   AbstractUserManagerNode folk)

Tests whether the submitted User is part of the folk.

Parameters:

user - The User to test

folk - The AbstractUserManagerNode (the folk)

Returns:

true if the User is part of folk; false otherwise

getUsers

java.util.Set<User> getUsers(java.util.Collection<java.lang.Long> ids)

Returns a Set of Users defined by the given Collection of IDs

Parameters:

ids - A Collection of Longs

Returns:

A Set of Users

getOUs

java.util.Set<OrganisationalUnit> getOUs(java.util.Collection<java.lang.Long> ids)

getUsers

java.util.Set<User> getUsers(java.util.Collection<java.lang.Long> ids,
                             boolean dereferenceGroups)

Returns User objects for all given IDs (be they user or group)

Parameters:

ids - A Collection of Longs containing the IDs

dereferenceGroups - Set to true if the result should contain groups

Returns:

A Set of Users

getGroups

java.util.Set<Group> getGroups(java.util.Collection<java.lang.Long> groupIds)

Returns a Set of Groups defined by the given Collection of IDs

Parameters:

groupIds - A Collection of Longs

Returns:

A Set of Groups

getUsersByMail

java.util.Collection<User> getUsersByMail(java.lang.String email)

getGroupsWithMember

java.util.List<Group> getGroupsWithMember(Group group)

getGroupsWithMember

java.util.List<Group> getGroupsWithMember(OrganisationalUnit ou)

getReferencedGroups

java.util.Collection<Group> getReferencedGroups(User user)

Returns all groups in which the user is a direct or indirect member.

Parameters:

user - the user to fetch all groups from

getAllTransitiveUsers

java.util.Set<User> getAllTransitiveUsers(AbstractUserManagerNode node)

Returns all users underneath the node.

Parameters:

node -

getDirectGroups

java.util.Collection<Group> getDirectGroups(User user)

Returns groups in which the user is a direct member.

Parameters:

user - the user to fetch direct groups from

getIndirectGroups

java.util.Collection<Group> getIndirectGroups(User user)

Returns groups in which the user is an indirect member.

Parameters:

user - the user to fetch indirect groups from

getNumberOfActiveUsers

long getNumberOfActiveUsers()

Returns the number of active users in the system, that is, not inhibited and not with accounts not expired.

Returns:

getNumberOfInhibitedUsers

long getNumberOfInhibitedUsers()

getNumberOfExpiredUsers

long getNumberOfExpiredUsers()