UserManager (edoras one Java API (2.0.7))

All Known Implementing Classes:

DefaultUserManager, DelegatingUserManager
```
public interface UserManager
```
Manager to retrieve current user information. All APIs are restricted to the current tenant unless specifically noted otherwise.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`createUser(User user)` Persists the given `User` object as an `AnyWorkObject` with type `WorkObjectTypes.USER_TYPE` and the predefined user variables.
`Optional<User>`	`findUser(Predicate predicate)` Finds the `User` that matches the given predicate.
`Optional<User>`	`findUserAcrossAllTenants(Predicate predicate)` Finds the `User` that matches the given predicate across all tenants.
`com.google.common.collect.ImmutableList<User>`	`findUsers(Predicate predicate)` Finds the `User`s that match the given predicate.
`User`	`getCurrentSystemAdminUser()` Returns the current system admin user.
`String`	`getCurrentSystemAdminUserId()` Returns the id of the current system admin user.
`String`	`getCurrentTenantId()` Returns the id of the current tenant.
`User`	`getCurrentUser()` Returns the current user.
`String`	`getCurrentUserId()` Returns the id of the current user.
`User`	`getUser(String userId)` Returns the user with the given id.
`void`	`setActive(String userId, boolean isActive)` Set the state of the user object.
`String`	`updateUser(User user)` Updates an already persisted user.

- Method Detail
  - getCurrentTenantId
```
String getCurrentTenantId()
```
    Returns the id of the current tenant.
    
    Returns:
    
    the id of the current tenant, never null
  - getCurrentUserId
```
String getCurrentUserId()
```
    Returns the id of the current user.
    
    Returns:
    
    the id of the current user, never null
  - getCurrentUser
```
User getCurrentUser()
```
    Returns the current user.
    
    Returns:
    
    the current user, never null
  - getCurrentSystemAdminUserId
```
String getCurrentSystemAdminUserId()
```
    Returns the id of the current system admin user.
    
    Returns:
    
    the id of the current system admin user, never null
  - getCurrentSystemAdminUser
```
User getCurrentSystemAdminUser()
```
    Returns the current system admin user.
    
    Returns:
    
    the current system admin user, never null
  - getUser
```
User getUser(String userId)
```
    Returns the user with the given id.
    
    Parameters:
    
    userId - the user id, not null
    
    Returns:
    
    the user with the given id, never null
    
    Throws:
    
    EntityNotFoundException - if a user with the given id does not exist
  - setActive
```
void setActive(String userId,
               boolean isActive)
```
    Set the state of the user object.
    
    Parameters:
    
    userId - the user id, not null
    
    isActive - true if the user gets activated, false otherwise
  - findUser
```
Optional<User> findUser(Predicate predicate)
```
    Finds the User that matches the given predicate.
    
    Parameters:
    
    predicate - the predicate to apply, never null
    
    Returns:
    
    the matching user if any, never null
    
    Throws:
    
    IllegalStateException - if more than one matching user is found
  - findUsers
```
com.google.common.collect.ImmutableList<User> findUsers(Predicate predicate)
```
    Finds the Users that match the given predicate.
    
    Parameters:
    
    predicate - the predicate to apply, never null
    
    Returns:
    
    the matching users if any, never null
  - findUserAcrossAllTenants
```
Optional<User> findUserAcrossAllTenants(Predicate predicate)
```
    Finds the User that matches the given predicate across all tenants.
    
    Parameters:
    
    predicate - the predicate to apply, never null
    
    Returns:
    
    the matching user if any, never null
    
    Throws:
    
    IllegalStateException - if more than one matching user is found
  - createUser
```
String createUser(User user)
```
    Persists the given User object as an AnyWorkObject with type WorkObjectTypes.USER_TYPE and the predefined user variables.
    
    Parameters:
    
    user - the user to be created, not null
    
    Returns:
    
    the user id of the created user
    
    Throws:
    
    IllegalArgumentException - if the given user is null or the given user email address is not valid
    
    IllegalStateException - if a user is already persisted with the same login as the given user
  - updateUser
```
String updateUser(User user)
```
    Updates an already persisted user. All user properties are updated except the following id’s: <ul> <li>User.id</li> <li>User.externalId</li> <li>User.tenantId</li> </ul>
    
    Parameters:
    
    user - the user to be updated, not null
    
    Returns:
    
    the user id of the updated user
    
    Throws:
    
    IllegalArgumentException - if the given user is null, the id of the user is undefined or the given user email address is not valid
    
    IllegalStateException - if the id of the given user is not already persisted or if a user is already persisted with the same login as the given user

Interface UserManager

Method Summary

Method Detail

getCurrentTenantId

getCurrentUserId

getCurrentUser

getCurrentSystemAdminUserId

getCurrentSystemAdminUser

getUser

setActive

findUser

findUsers

findUserAcrossAllTenants

createUser

updateUser