net.datenwerke.security.service.usermanager

Class UserManagerServiceImpl

java.lang.Object

net.datenwerke.treedb.service.treedb.TreeDBManagerImpl<A>

net.datenwerke.security.service.treedb.LoggedTreeDbManagerImpl<A>

net.datenwerke.security.service.treedb.SecuredTreeDBManagerImpl<AbstractUserManagerNode>

net.datenwerke.security.service.usermanager.UserManagerServiceImpl

All Implemented Interfaces:

UserManagerService, TreeDBManager<AbstractUserManagerNode>

public class UserManagerServiceImpl
extends SecuredTreeDBManagerImpl<AbstractUserManagerNode>
implements UserManagerService

ReportServer's User Management Component

Field Summary

Fields inherited from interface net.datenwerke.security.service.usermanager.UserManagerService

MODULE_NAME, SECUREE_ID

Constructor Summary

Constructors

Constructor and Description
UserManagerServiceImpl(TreeDBService treeDB, <any> entityManagerProvider, PasswordHasher passwordHasher, HookHandlerService hookHandlerService)

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)
void	forceRemove(AbstractUserManagerNode node) Removes the node and takes care of database constraints.
java.util.Collection<Group>	getAllGroups() Returns a Collection of all existing Groups
java.util.List<AbstractUserManagerNode>	getAllNodes()
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> ids) 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
AbstractUserManagerNode	getNodeByKey(java.lang.String key)
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.
java.util.List<AbstractUserManagerNode>	getRoots()
User	getUserByMail(java.lang.String email) 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)
void	remove(AbstractUserManagerNode node) Removes the node and takes care of database constraints.
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.
boolean	userInFolk(User user, AbstractUserManagerNode folk, java.util.Set<Group> seenGroups)

Methods inherited from class net.datenwerke.security.service.treedb.SecuredTreeDBManagerImpl

copy, getVirtualRoots, move, move, move, move, persist

Methods inherited from class net.datenwerke.security.service.treedb.LoggedTreeDbManagerImpl

merge

Methods inherited from class net.datenwerke.treedb.service.treedb.TreeDBManagerImpl

allowsMultipleRoots, copy, getBaseType, getChildrenWithName, isFolder, updateFlags

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.datenwerke.security.service.usermanager.UserManagerService

merge, persist

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

allowsMultipleRoots, copy, getBaseType, getChildrenWithName, getVirtualRoots, isFolder, move, move, updateFlags

Constructor Detail

UserManagerServiceImpl

public UserManagerServiceImpl(TreeDBService treeDB,
                              <any> entityManagerProvider,
                              PasswordHasher passwordHasher,
                              HookHandlerService hookHandlerService)

Method Detail

getUserByName

@QueryByAttribute(where=<error>)
public User getUserByName(java.lang.String name)

Description copied from interface: UserManagerService

Finds a User by name

Specified by:

getUserByName in interface UserManagerService

Parameters:

name - The User's name

Returns:

The corresponding User

getUsersByMail

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

Specified by:

getUsersByMail in interface UserManagerService

getUserByMail

public User getUserByMail(java.lang.String email)

Description copied from interface: UserManagerService

Finds a User by email

Specified by:

getUserByMail in interface UserManagerService

Returns:

The corresponding User

getGroupByName

@QueryByAttribute(where=<error>)
public Group getGroupByName(java.lang.String name)

Description copied from interface: UserManagerService

Finds a Group by name

Specified by:

getGroupByName in interface UserManagerService

Parameters:

name - The Group's name

Returns:

The corresponding Group

getOUsByName

@QueryByAttribute(where=<error>)
public java.util.List<OrganisationalUnit> getOUsByName(java.lang.String name)

Description copied from interface: UserManagerService

Searches for a OrganisationalUnit by its name

Specified by:

getOUsByName in interface UserManagerService

Parameters:

name - The name of the OrganisationalUnit

Returns:

The corresponding OrganisationalUnit

remove

public void remove(AbstractUserManagerNode node)

Removes the node and takes care of database constraints.

Specified by:

remove in interface UserManagerService

Specified by:

remove in interface TreeDBManager<AbstractUserManagerNode>

Overrides:

remove in class SecuredTreeDBManagerImpl<AbstractUserManagerNode>

Parameters:

node - AbstractUserManagerNode

forceRemove

public void forceRemove(AbstractUserManagerNode node)

Removes the node and takes care of database constraints.

Specified by:

forceRemove in interface TreeDBManager<AbstractUserManagerNode>

Overrides:

forceRemove in class SecuredTreeDBManagerImpl<AbstractUserManagerNode>

getGroupsWithMember

@QueryByAttribute(where=<error>,
                  type=IS_MEMBER)
public java.util.List<Group> getGroupsWithMember(Group group)

Specified by:

getGroupsWithMember in interface UserManagerService

getGroupsWithMember

@QueryByAttribute(where=<error>,
                  type=IS_MEMBER)
public java.util.List<Group> getGroupsWithMember(OrganisationalUnit ou)

Specified by:

getGroupsWithMember in interface UserManagerService

userInFolk

public boolean userInFolk(User user,
                          AbstractUserManagerNode folk)

Description copied from interface: UserManagerService

Tests whether the submitted User is part of the folk.

Specified by:

userInFolk in interface UserManagerService

Parameters:

user - The User to test

folk - The AbstractUserManagerNode (the folk)

Returns:

true if the User is part of folk; false otherwise

userInFolk

public boolean userInFolk(User user,
                          AbstractUserManagerNode folk,
                          java.util.Set<Group> seenGroups)

getReferencedGroups

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

Description copied from interface: UserManagerService

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

Specified by:

getReferencedGroups in interface UserManagerService

Parameters:

user - the user to fetch all groups from

getAllGroups

@SimpleQuery
public java.util.Collection<Group> getAllGroups()

Description copied from interface: UserManagerService

Returns a Collection of all existing Groups

Specified by:

getAllGroups in interface UserManagerService

Returns:

A Collection of Groups

getAllOUs

@SimpleQuery
public java.util.Collection<OrganisationalUnit> getAllOUs()

Specified by:

getAllOUs in interface UserManagerService

getAllUsers

@SimpleQuery
public java.util.Collection<User> getAllUsers()

Description copied from interface: UserManagerService

Returns a Collection of all existing Users

Specified by:

getAllUsers in interface UserManagerService

Returns:

A Collection of Users

getUsers

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

Description copied from interface: UserManagerService

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

Specified by:

getUsers in interface UserManagerService

Parameters:

ids - A Collection of Longs

Returns:

A Set of Users

getUsers

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

Description copied from interface: UserManagerService

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

Specified by:

getUsers in interface UserManagerService

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

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

Description copied from interface: UserManagerService

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

Specified by:

getGroups in interface UserManagerService

Parameters:

ids - A Collection of Longs

Returns:

A Set of Groups

setPassword

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

Description copied from interface: UserManagerService

Sets the Users password

Specified by:

setPassword in interface UserManagerService

Parameters:

user - The User

newPassword - The new password

changePassword

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

Specified by:

changePassword in interface UserManagerService

Throws:

ExpectedException

changePassword

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

Specified by:

changePassword in interface UserManagerService

Throws:

ExpectedException

getRoots

@QueryByAttribute(where=<error>,
                  type=IS_NULL)
public java.util.List<AbstractUserManagerNode> getRoots()

Specified by:

getRoots in interface TreeDBManager<AbstractUserManagerNode>

getAllNodes

@SimpleQuery
public java.util.List<AbstractUserManagerNode> getAllNodes()

Specified by:

getAllNodes in interface TreeDBManager<AbstractUserManagerNode>

getNodeById

@QueryById
public AbstractUserManagerNode getNodeById(long id)

Description copied from interface: UserManagerService

Searches for a AbstractUserManagerNode by its id

Specified by:

getNodeById in interface UserManagerService

Specified by:

getNodeById in interface TreeDBManager<AbstractUserManagerNode>

Parameters:

id - The ID

Returns:

The AbstractUserManagerNode identified by the given ID

getAllTransitiveUsers

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

Description copied from interface: UserManagerService

Returns all users underneath the node.

Specified by:

getAllTransitiveUsers in interface UserManagerService

getOUs

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

Specified by:

getOUs in interface UserManagerService

getDirectGroups

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

Description copied from interface: UserManagerService

Returns groups in which the user is a direct member.

Specified by:

getDirectGroups in interface UserManagerService

Parameters:

user - the user to fetch direct groups from

getIndirectGroups

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

Description copied from interface: UserManagerService

Returns groups in which the user is an indirect member.

Specified by:

getIndirectGroups in interface UserManagerService

Parameters:

user - the user to fetch indirect groups from

getUserOrNull

public User getUserOrNull(java.lang.String username)

Specified by:

getUserOrNull in interface UserManagerService

getNumberOfActiveUsers

public long getNumberOfActiveUsers()

Description copied from interface: UserManagerService

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

Specified by:

getNumberOfActiveUsers in interface UserManagerService

Returns:

getNumberOfInhibitedUsers

public long getNumberOfInhibitedUsers()

Specified by:

getNumberOfInhibitedUsers in interface UserManagerService

getNumberOfExpiredUsers

public long getNumberOfExpiredUsers()

Specified by:

getNumberOfExpiredUsers in interface UserManagerService

getNodeByKey

public AbstractUserManagerNode getNodeByKey(java.lang.String key)

Specified by:

getNodeByKey in interface TreeDBManager<AbstractUserManagerNode>