UserManager (Clerezza - Reactor build (root) 0.3-SNAPSHOT API)

All Known Implementing Classes:

UserManagerImpl
```
public interface UserManager
```
An implementation of this interface provides methods to manage data about users and their roles. Data managed are needed for authentication and for setting permissions. Those data include user names, email addresses, passwords, roles, permissions, etc. A user is uniquely identified by a user name. Each user has an email address and an email address can only belong to a user.

Author:

hasan, tio

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)` Deprecated.
`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

- Method Detail
  - storeRole
```
void storeRole(String title)
```
    Parameters:
    title - the title of the role, may not be null
  - roleExists
```
boolean roleExists(String title)
```
    Checks if a role with this title exists
    
    Parameters:
    title - specifies the title of the role
    
    Returns:
    true if the role exists otherwise false
  - getRoleByTitle
```
NonLiteral getRoleByTitle(String title)
```
    Parameters:
    title -
    
    Returns:
    NonLiteral which is either a BNode or a UriRef
  - getRoles
```
Iterator<NonLiteral> getRoles()
```
    Returns:
    Iterator defining all roles, except base roles
  - getRolesOfUser
```
Iterator<NonLiteral> getRolesOfUser(NonLiteral user)
```
    Parameters:
    user - the user is either a BNode or a UriRef
    
    Returns:
    Iterator defining all the Roles the specified user owns
  - deleteRole
```
void deleteRole(String title)
```
    Parameters:
    title - the title of the role to be deleted, may not be null
  - assignPermissionsToRole
```
void assignPermissionsToRole(String title,
                           List<String> permissionEntries)
```
    Assigns a permission to a role
    
    Parameters:
    title - specifies the title of the role, may not be null
    permissionEntries - specifies a list of permissions
  - getPermissionsOfRole
```
Iterator<NonLiteral> getPermissionsOfRole(NonLiteral role)
```
    Parameters:
    role - the role is either a BNode or an UriRef
    
    Returns:
    Iterator defining all permissions of a role
  - deletePermissionsOfRole
```
void deletePermissionsOfRole(String title,
                           List<String> permissionEntries)
```
    Deletes the defined permissions of the role
    
    Parameters:
    title - specifies the title of the role, may not be null
    permissionEntries -
  - deleteAllPermissionsOfRole
```
void deleteAllPermissionsOfRole(String title)
```
    Deletes all permission of a role
    
    Parameters:
    title - specifies the title of the role, may not be null
  - storeUser
```
void storeUser(String name,
             String email,
             String password,
             List<String> assignedRoles,
             String pathPrefix)
```
    Parameters:
    name - the username of the user, may not be null
    email -
    password -
    assignedRoles -
    pathPrefix -
    
    Throws:
    
    NoSuchAlgorithmException
    
    UnsupportedEncodingException
  - updateUser
```
void updateUser(String name,
              String email,
              String password,
              Collection<String> assignedRoles,
              String pathPrefix)
```
    Updates the user with the specified userName
    
    Parameters:
    name, - may not be null
    email - the email address (note that this is not the mailto-uri)
    password -
    assignedRoles -
    pathPrefix -
  - nameExists
```
boolean nameExists(String name)
```
    Checks if the username exists
    
    Parameters:
    name - specifies the username, may not be null
    
    Returns:
    true if exists otherwise false
  - emailExists
```
boolean emailExists(String email)
```
    Checks if thereis already an agent with that email address.
    
    Parameters:
    email -
    
    Returns:
    true if exists otherwise false
  - getNameByEmail
```
String getNameByEmail(String email)
                      throws UserHasNoNameException
```
    Parameters:
    email -
    
    Returns:
    null if the email is null or the email does not exist in the storage, otherwise returns the name of the user who owns the email
    
    Throws:
    
    UserHasNoNameException
  - getUserByName
```
@Deprecated
NonLiteral getUserByName(String name)
```
    Deprecated.
    
    Parameters:
    name - specifies the username of the user
    
    Returns:
    NonLiteral representing the user in the system Graph
  - getUserGraphNode
```
GraphNode getUserGraphNode(String name)
```
    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.
    
    Parameters:
    name - The username of the user
    
    Returns:
    GraphNode representing the user (WebID or blank node) with some context in a dedicated MGraph
  - getUserInSystemGraph
```
GraphNode getUserInSystemGraph(String name)
```
    Returns the GraphNode pointing to the user with the specified name in the system graph. Returns null if the user does not exist.
    
    Parameters:
    name - The username of the user
    
    Returns:
    GraphNode representing the user in the system graph
  - getUserInContentGraph
```
GraphNode getUserInContentGraph(String name)
```
    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.
    
    Parameters:
    name - The username of the user
    
    Returns:
    GraphNode representing the user in the content graph
  - getUsers
```
Iterator<NonLiteral> getUsers()
```
    Returns all users.
    
    Returns:
    Iterator of users in the system Graph.
  - deleteUser
```
void deleteUser(String name)
```
    Parameters:
    name - specifies the username of the user, may not be null
  - assignPermissionsToUser
```
void assignPermissionsToUser(String name,
                           List<String> permissionEntries)
```
    Parameters:
    name - specifies the username of the user, may not be null
    permissionEntries -
  - getPermissionsOfUser
```
Iterator<NonLiteral> getPermissionsOfUser(NonLiteral user)
```
    Parameters:
    user - the user is either a BNode or a UriRef
    
    Returns:
    Iterator defining all permissions of the specified user
  - deletePermissionsOfUser
```
void deletePermissionsOfUser(String name,
                           List<String> permissionEntries)
```
    Parameters:
    name - specifies the username of the user, may not be null
    permissionEntries -
  - deleteAllPermissionsOfUser
```
void deleteAllPermissionsOfUser(String name)
```
    Deletes all permission of a user
    
    Parameters:
    name - specifies the username of the user, may not be null

Interface UserManager

Method Summary

Method Detail

storeRole

roleExists

getRoleByTitle

getRoles

getRolesOfUser

deleteRole

assignPermissionsToRole

getPermissionsOfRole

deletePermissionsOfRole

deleteAllPermissionsOfRole

storeUser

updateUser

nameExists

emailExists

getNameByEmail

getUserByName

getUserGraphNode

getUserInSystemGraph

getUserInContentGraph

getUsers

deleteUser

assignPermissionsToUser

getPermissionsOfUser

deletePermissionsOfUser

deleteAllPermissionsOfUser