org.apache.clerezza.platform.usermanager

Class UserManagerImpl

java.lang.Object

org.apache.clerezza.platform.usermanager.UserManagerImpl

All Implemented Interfaces:

UserManager

@Service(value=UserManager.class)
public class UserManagerImpl
extends Object
implements UserManager

Author:

hasan, tio

Constructor Summary

Constructors

Constructor and Description
UserManagerImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	assignPermissionsToRole(String title, List<String> permissionEntries) Assigns a permission to a role
void	assignPermissionsToUser(String name, List<String> permissionEntries)
void	deleteAllPermissionsOfRole(String title) Deletes all permission of a role
void	deleteAllPermissionsOfUser(String name) Deletes all permission of a user
void	deletePermissionsOfRole(String title, List<String> permissionEntries) Deletes the defined permissions of the role
void	deletePermissionsOfUser(String name, List<String> permissionEntries)
void	deleteRole(String title)
void	deleteUser(String name)
boolean	emailExists(String email) Checks if thereis already an agent with that email address.
String	getNameByEmail(String email)
Iterator<NonLiteral>	getPermissionsOfRole(NonLiteral role)
Iterator<NonLiteral>	getPermissionsOfUser(NonLiteral user)
NonLiteral	getRoleByTitle(String title)
Iterator<NonLiteral>	getRoles()
Iterator<NonLiteral>	getRolesOfUser(NonLiteral user)
NonLiteral	getUserByName(String name)
GraphNode	getUserGraphNode(String name) Returns the user with the specified name in an (editable) MGraph (i.e.
GraphNode	getUserInContentGraph(String name) Returns the GraphNode pointing to the user with the specified name in the content graph.
GraphNode	getUserInSystemGraph(String name) Returns the GraphNode pointing to the user with the specified name in the system graph.
Iterator<NonLiteral>	getUsers() Returns all users.
boolean	nameExists(String name) Checks if the username exists
boolean	roleExists(String title) Checks if a role with this title exists
void	storeRole(String title)
void	storeUser(String name, String email, String password, List<String> assignedRoles, String pathPrefix)
void	updateUser(String name, String email, String password, Collection<String> assignedRoles, String pathPrefix) Updates the user with the specified userName

Methods inherited from class java.lang.Object

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

Constructor Detail

UserManagerImpl

public UserManagerImpl()

Method Detail

storeRole

public void storeRole(String title)

Specified by:

storeRole in interface UserManager

Parameters:

title - the title of the role, may not be null

getRoleByTitle

public NonLiteral getRoleByTitle(String title)

Specified by:

getRoleByTitle in interface UserManager

Returns:

NonLiteral which is either a BNode or a UriRef

roleExists

public boolean roleExists(String title)

Description copied from interface: UserManager

Checks if a role with this title exists

Specified by:

roleExists in interface UserManager

Parameters:

title - specifies the title of the role

Returns:

true if the role exists otherwise false

getRoles

public Iterator<NonLiteral> getRoles()

Specified by:

getRoles in interface UserManager

Returns:

Iterator defining all roles, except base roles

getRolesOfUser

public Iterator<NonLiteral> getRolesOfUser(NonLiteral user)

Specified by:

getRolesOfUser in interface UserManager

Parameters:

user - the user is either a BNode or a UriRef

Returns:

Iterator defining all the Roles the specified user owns

deleteRole

public void deleteRole(String title)

Specified by:

deleteRole in interface UserManager

Parameters:

title - the title of the role to be deleted, may not be null

assignPermissionsToRole

public void assignPermissionsToRole(String title,
                           List<String> permissionEntries)

Description copied from interface: UserManager

Assigns a permission to a role

Specified by:

assignPermissionsToRole in interface UserManager

Parameters:

title - specifies the title of the role, may not be null

permissionEntries - specifies a list of permissions

getPermissionsOfRole

public Iterator<NonLiteral> getPermissionsOfRole(NonLiteral role)

Specified by:

getPermissionsOfRole in interface UserManager

Parameters:

role - the role is either a BNode or an UriRef

Returns:

Iterator defining all permissions of a role

deletePermissionsOfRole

public void deletePermissionsOfRole(String title,
                           List<String> permissionEntries)

Description copied from interface: UserManager

Deletes the defined permissions of the role

Specified by:

deletePermissionsOfRole in interface UserManager

Parameters:

title - specifies the title of the role, may not be null

deleteAllPermissionsOfRole

public void deleteAllPermissionsOfRole(String title)

Description copied from interface: UserManager

Deletes all permission of a role

Specified by:

deleteAllPermissionsOfRole in interface UserManager

Parameters:

title - specifies the title of the role, may not be null

storeUser

public void storeUser(String name,
             String email,
             String password,
             List<String> assignedRoles,
             String pathPrefix)

Specified by:

storeUser in interface UserManager

Parameters:

name - the username of the user, may not be null

getNameByEmail

public String getNameByEmail(String email)
                      throws UserHasNoNameException

Specified by:

getNameByEmail in interface UserManager

Parameters:

graph -

email -

Returns:

null if the email does not exist in the graph, otherwise returns the name of the user who owns the email

Throws:

UserHasNoNameException

updateUser

public void updateUser(String name,
              String email,
              String password,
              Collection<String> assignedRoles,
              String pathPrefix)

Description copied from interface: UserManager

Updates the user with the specified userName

Specified by:

updateUser in interface UserManager

email - the email address (note that this is not the mailto-uri)

nameExists

public boolean nameExists(String name)

Description copied from interface: UserManager

Checks if the username exists

Specified by:

nameExists in interface UserManager

Parameters:

name - specifies the username, may not be null

Returns:

true if exists otherwise false

emailExists

public boolean emailExists(String email)

Description copied from interface: UserManager

Checks if thereis already an agent with that email address.

Specified by:

emailExists in interface UserManager

Returns:

true if exists otherwise false

getUserByName

public NonLiteral getUserByName(String name)

Specified by:

getUserByName in interface UserManager

Parameters:

name - specifies the username of the user

Returns:

NonLiteral representing the user in the system Graph

getUsers

public Iterator<NonLiteral> getUsers()

Description copied from interface: UserManager

Returns all users.

Specified by:

getUsers in interface UserManager

Returns:

Iterator of users in the system Graph.

deleteUser

public void deleteUser(String name)

Specified by:

deleteUser in interface UserManager

Parameters:

name - specifies the username of the user, may not be null

assignPermissionsToUser

public void assignPermissionsToUser(String name,
                           List<String> permissionEntries)

Specified by:

assignPermissionsToUser in interface UserManager

Parameters:

name - specifies the username of the user, may not be null

getPermissionsOfUser

public Iterator<NonLiteral> getPermissionsOfUser(NonLiteral user)

Specified by:

getPermissionsOfUser in interface UserManager

Parameters:

user - the user is either a BNode or a UriRef

Returns:

Iterator defining all permissions of the specified user

deletePermissionsOfUser

public void deletePermissionsOfUser(String name,
                           List<String> permissionEntries)

Specified by:

deletePermissionsOfUser in interface UserManager

Parameters:

name - specifies the username of the user, may not be null

deleteAllPermissionsOfUser

public void deleteAllPermissionsOfUser(String name)

Description copied from interface: UserManager

Deletes all permission of a user

Specified by:

deleteAllPermissionsOfUser in interface UserManager

Parameters:

name - specifies the username of the user, may not be null

getUserInSystemGraph

public GraphNode getUserInSystemGraph(String name)

Description copied from interface: UserManager

Returns the GraphNode pointing to the user with the specified name in the system graph. Returns null if the user does not exist.

Specified by:

getUserInSystemGraph in interface UserManager

Parameters:

name - The username of the user

Returns:

GraphNode representing the user in the system graph

getUserInContentGraph

public GraphNode getUserInContentGraph(String name)

Description copied from interface: UserManager

Returns the GraphNode pointing to the user with the specified name in the content graph. If the user does not exist in the content graph, but in the system graph, then the it is created with the PLATFORM.userName property copied from the system graph. Returns null if the user does not exist.

Specified by:

getUserInContentGraph in interface UserManager

Parameters:

name - The username of the user

Returns:

GraphNode representing the user in the content graph

getUserGraphNode

public GraphNode getUserGraphNode(String name)

Description copied from interface: UserManager

Returns the user with the specified name in an (editable) MGraph (i.e. a SimpleGraph but this is implementation specific) with the context of the user node, editing the graphnode('s Mgraph) doesn't cause any changes elsewhere. Returns null if the user does not exist. The caller of this method needs the permission to read the system graph, otherwise a AccessControlException will be thrown.

Specified by:

getUserGraphNode in interface UserManager

Parameters:

name - The username of the user

Returns:

GraphNode representing the user (WebID or blank node) with some context in a dedicated MGraph