All Known Implementing Classes:: UsersManagerEntry

public interface UsersManager

UsersManager manages users.

Author:: Michal Prochazka, Slavek Licehammer, Zora Sebestianova, Sona Mastrakova

Field Summary

Fields

Modifier and Type

Field

Description

static final String

USERS_QUERY
Method Summary

Modifier and Type

Method

Description

void

addSpecificUserOwner(PerunSession sess, User user, User specificUser)

Add specificUser owner (the user) If not exists, create new ownership.

UserExtSource

addUserExtSource(PerunSession perunSession, User user, UserExtSource userExtSource)

Adds user's external sources.

RichUserExtSource

addUserExtSourceWithAttributes(PerunSession sess, User user, UserExtSource userExtSource, List<Attribute> uesAttributes)

Adds userExternalSource to the user along with the ues attributes.

void

anonymizeUser(PerunSession perunSession, User user, boolean force)

Anonymizes user - according to configuration, each of user's attributes is either anonymized, kept untouched or deleted.

void

blockLogins(PerunSession sess, List<String> logins, String namespace)

Block logins for given namespace or block logins globally (if no namespace is selected)

void

changeEmail(PerunSession sess, User user, String newEmail)

Change user's email to email from user ext source.

void

changeEmailCustom(PerunSession sess, User user, String newEmail, String url, String lang, String path, String idp)

Change user's email to custom email.

void

changeName(PerunSession sess, User user, String newUserName)

Change user's name to user's name from user ext source.

void

changeNameCustom(PerunSession sess, User user, String titleBefore, String firstName, String middleName, String lastName, String titleAfter)

Change user's name to custom name.

void

changeNonAuthzPassword(PerunSession sess, UUID token, String password, String lang)

Changes user password in defined login-namespace based on token parameter.

void

changeOrganization(PerunSession sess, User user, String newOrganizationName)

Change organization from which user came to organization from user ext source.

void

changeOrganizationCustom(PerunSession sess, User user, String newOrganizationName)

Change organization from which user came to custom organization.

void

changePassword(PerunSession sess, User user, String loginNamespace, String oldPassword, String newPassword, boolean checkOldPassword)

Changes user password in defined login-namespace.

void

changePassword(PerunSession sess, String login, String loginNamespace, String oldPassword, String newPassword, boolean checkOldPassword)

Changes user password in defined login-namespace.

String

changePasswordRandom(PerunSession sess, User user, String loginNamespace)

Generates new random password for given user and returns String representing HTML where is the new password.

void

checkPasswordResetRequestIsValid(PerunSession sess, UUID token)

Checks if the password reset request is valid.

void

checkPasswordStrength(PerunSession sess, String password, String namespace, String login)

Check password strength for the given namespace.

void

createAlternativePassword(PerunSession sess, User user, String description, String loginNamespace, String password)

Creates alternative password in external system.

User

createServiceUser(PerunSession sess, Candidate candidate, List<User> specificUserOwners)

From given candidate, creates a service user and assign given owners to him.

User

createUser(PerunSession perunSession, User user)

Deprecated.

void

deleteAlternativePassword(PerunSession sess, User user, String loginNamespace, String passwordId)

Deletes alternative password in external system.

void

deletePassword(PerunSession sess, User user, String loginNamespace)

Deletes password in external system.

void

deletePassword(PerunSession sess, String userLogin, String loginNamespace)

Deletes password in external system.

void

deleteUser(PerunSession perunSession, User user)

Deletes user.

void

deleteUser(PerunSession perunSession, User user, boolean forceDelete)

Deletes user.

List<RichUser>

findRichUsers(PerunSession sess, String searchString)

Returns list of RichUsers with attributes who matches the searchString, searching name, id, uuid, email, logins.

List<RichUser>

findRichUsersWithAttributes(PerunSession sess, String searchString, List<String> attrNames)

Returns list of RichUsers with attributes who matches the searchString, searching name, id, uuid, email, logins.

List<RichUser>

findRichUsersWithAttributesByExactMatch(PerunSession sess, String searchString, List<String> attrNames)

Returns list of RichUsers with attributes who matches the searchString, searching name, id, uuid, email, logins.

List<RichUser>

findRichUsersWithoutSpecificVoWithAttributes(PerunSession sess, Vo vo, String searchString, List<String> attrsName)

Return list of RichUsers who matches the searchString, searching name, email and logins and are not member in specific VO and contain selected attributes.

List<User>

findUsers(PerunSession sess, String searchString)

Returns list of users who matches the searchString, searching name, id, uuid, email, logins.

List<User>

findUsersByExactName(PerunSession sess, String searchString)

Returns list of users who exactly matches the searchString

List<User>

findUsersByName(PerunSession sess, String searchString)

Returns list of users who matches the searchString

List<User>

findUsersByName(PerunSession sess, String titleBefore, String firstName, String middleName, String lastName, String titleAfter)

Returns list of users who matches the fields.

Map<String,String>

generateAccount(PerunSession session, String namespace, Map<String,String> parameters)

Generate user account in a backend system associated with login-namespace in Perun.

List<BlockedLogin>

getAllBlockedLoginsInNamespaces(PerunSession sess)

Returns all blocked logins in namespaces (if namespace is null, then this login is blocked globally)

List<Resource>

getAllowedResources(PerunSession sess, Facility facility, User user)

Get all resources from the facility which have the user access on.

List<Resource>

getAllowedResources(PerunSession sess, User user)

Get all resources which have the user access on.

List<RichUser>

getAllRichUsers(PerunSession sess, boolean includedSpecificUsers)

Get All richUsers with or without specificUsers.

List<RichUser>

getAllRichUsersWithAttributes(PerunSession sess, boolean includedSpecificUsers)

Get All richUsers with or without specificUsers.

List<RichUser>

getAllRichUsersWithAttributes(PerunSession sess, boolean includedSpecificUsers, List<String> attrsNames)

Get All richUsers with or without specificUsers.

List<RichResource>

getAssignedRichResources(PerunSession sess, User user)

Get all rich resources which have the user assigned.

List<Resource>

getAssociatedResources(PerunSession sess, Facility facility, User user)

Return all resources of specified facility with which user is associated through all his members.

Paginated<BlockedLogin>

getBlockedLoginsPage(PerunSession sess, BlockedLoginsPageQuery query)

Get page of blocked logins.

List<Group>

getGroupsWhereUserIsActive(PerunSession sess, Facility facility, User user)

Return all groups where user is active (has VALID status in VO and Group together) for specified user and facility

List<Group>

getGroupsWhereUserIsActive(PerunSession sess, Resource resource, User user)

Return all groups where user is active (has VALID status in VO and Group together) for specified user and resource

List<Group>

getGroupsWhereUserIsAdmin(PerunSession perunSession, User user)

Returns list of Groups in Perun, where the User is a direct Administrator or he is VALID a member of any group which is Administrator of some of these Groups.

List<Group>

getGroupsWhereUserIsAdmin(PerunSession sess, Vo vo, User user)

Returns list of Groups in selected Vo, where the User is a direct Administrator or he is a VALID member of any group which is Administrator of some of these Groups.

List<String>

getPendingPreferredEmailChanges(PerunSession sess, User user)

Return list of email addresses of user, which are awaiting validation and are inside time window for validation.

Integer

getRelatedUserIdByBlockedLoginInNamespace(PerunSession sess, String login, String namespace)

Get user id of the user who was related to the given login in the past

List<RichGroup>

getRichGroupsWhereUserIsActive(PerunSession sess, Facility facility, User user, List<String> attrNames)

Return all groups where user is active (has VALID status in VO and Group together) for specified user and resource

List<RichGroup>

getRichGroupsWhereUserIsActive(PerunSession sess, Resource resource, User user, List<String> attrNames)

Return all RichGroups where user is active (has VALID status in VO and Group together) for specified user and resource with specified group attributes by their names (URNs).

RichUser

getRichUser(PerunSession sess, User user)

Get User to RichUser without attributes.

List<RichUserExtSource>

getRichUserExtSources(PerunSession perunSession, User user)

Gets list of all user's external sources with attributes.

List<RichUserExtSource>

getRichUserExtSources(PerunSession perunSession, User user, List<String> attrsNames)

Gets list of all user's external sources with attributes.

List<RichUser>

getRichUsersByIds(PerunSession sess, List<Integer> ids)

Returns rich users without attributes by their ids.

List<RichUser>

getRichUsersWithAttributesByIds(PerunSession sess, List<Integer> ids)

Returns rich users with attributes by their ids.

List<RichUser>

getRichUsersWithoutVoAssigned(PerunSession sess)

Returns all RichUsers with attributes who are not member of any VO.

List<RichUser>

getRichUsersWithoutVoWithAttributes(PerunSession sess, List<String> attrNames)

Returns list of RichUsers which are not members of any VO and with selected attributes

RichUser

getRichUserWithAttributes(PerunSession sess, User user)

Get User to RichUser with attributes.

List<User>

getSpecificUsers(PerunSession sess)

Return all specific Users (only specific users)

List<User>

getSpecificUsersByUser(PerunSession sess, User user)

Return all specificUsers who are owned by the user

List<RichUser>

getSponsors(PerunSession sess, Member member, List<String> attrNames)

Deprecated.
- use getSponsorsForMember

List<Sponsor>

getSponsorsForMember(PerunSession sess, Member member, List<String> attrNames)

Gets list of users that sponsor the member, with attributes.

List<User>

getUnanonymizedUsersBySpecificUser(PerunSession sess, User specificUser)

Return all users who owns the specific one and are not anonymized

Map<Facility,List<Resource>>

getUserAssignments(PerunSession sess, User user)

Returns all assignments of the user, assignments being Facilities and Resources they are assigned to.

User

getUserByExtSourceNameAndExtLogin(PerunSession sess, String extSourceName, String extLogin)

Get user by extSourceName and extSourceLogin

User

getUserById(PerunSession perunSession, int id)

Returns user by his/her id.

User

getUserByMember(PerunSession perunSession, Member member)

Returns user by VO member.

User

getUserByUserExtSource(PerunSession perunSession, UserExtSource userExtSource)

Returns user by his login in external source and external source.

User

getUserByUserExtSources(PerunSession perunSession, List<UserExtSource> userExtSources)

Returns user based on one of the userExtSource.

UserExtSource

getUserExtSourceByExtLogin(PerunSession perunSession, ExtSource source, String extLogin)

Gets user's external source by the user's external login and external source.

UserExtSource

getUserExtSourceById(PerunSession sess, int id)

Get the user ext source by its id.

UserExtSource

getUserExtSourceByUniqueAttributeValue(PerunSession sess, int attrId, String uniqueValue)

Return userExtSource for specific attribute definition (specified by id) and unique value.

UserExtSource

getUserExtSourceByUniqueAttributeValue(PerunSession sess, String attrName, String uniqueValue)

Return userExtSource for specific attribute definition (specified by name) and unique value.

List<UserExtSource>

getUserExtSources(PerunSession perunSession, User user)

Gets list of all user's external sources of the user.

List<UserExtSource>

getUserExtSourcesByIds(PerunSession sess, List<Integer> ids)

Get the user ext sources by their ids.

Map<String,List<PerunBean>>

getUserRelations(PerunSession sess, User user)

Gets map with 2 items which are a list of all vos and a list of all groups where given user is member filtered by principal's privileges.

List<User>

getUsers(PerunSession sess)

Returns all users (included specific users).

List<User>

getUsersByAttribute(PerunSession sess, Attribute attribute)

Returns all users who have set the attribute with the value.

List<User>

getUsersByAttribute(PerunSession sess, String attributeName, String attributeValue)

Returns all users who have set the attribute with the value.

List<User>

getUsersByAttributeValue(PerunSession sess, String attributeName, String attributeValue)

Returns all users who have the attribute with the value. attributeValue is not converted to the attribute type, it is always type of String.

List<User>

getUsersByIds(PerunSession perunSession, List<Integer> ids)

Returns existing users by their ids.

List<User>

getUsersBySpecificUser(PerunSession sess, User specificUser)

Return all users who owns the specific one

int

getUsersCount(PerunSession sess)

Get count of all users.

Paginated<RichUser>

getUsersPage(PerunSession sess, UsersPageQuery query, List<String> attrNames)

Get page of users with the given attributes.

List<User>

getUsersWithoutSpecificVo(PerunSession sess, Vo vo, String searchString)

Return list of users who matches the searchString, searching name, email and logins and are not member in specific VO.

List<User>

getUsersWithoutVoAssigned(PerunSession sess)

Returns all users who are not member of any VO.

List<Vo>

getVosWhereUserIsAdmin(PerunSession perunSession, User user)

Returns list of VOs, where the user is an Administrator.

List<Vo>

getVosWhereUserIsMember(PerunSession perunSession, User user)

Returns list of VOs, where the user is a member.

boolean

isLoginAvailable(PerunSession sess, String loginNamespace, String login)

Checks if the login is available in the namespace.

boolean

isLoginBlocked(PerunSession sess, String login, boolean ignoreCase)

Return true if login is blocked (globally - for all namespaces per instance OR for some namespace), false if not.

boolean

isLoginBlockedForNamespace(PerunSession sess, String login, String namespace, boolean ignoreCase)

Return true if login is blocked for given namespace, false if not.

boolean

isLoginBlockedGlobally(PerunSession sess, String login)

Return true if login is blocked globally (for all namespaces per instance - represented by namespace = null), false if not.

boolean

isUserPerunAdmin(PerunSession sess, User user)

Deprecated.

boolean

loginExist(PerunSession sess, User user, String loginNamespace)

Check, if login exists in given login-namespace.

void

moveUserExtSource(PerunSession perunSession, User sourceUser, User targetUser, UserExtSource userExtSource)

Take UserExtSource from sourceUser and move it to the targetUser.

void

removeSpecificUserOwner(PerunSession sess, User user, User specificUser)

Remove specificUser owner (the user) Only disable ownership of user and specificUser

void

removeUserExtSource(PerunSession perunSession, User user, UserExtSource userExtSource)

Removes user's external source.

void

removeUserExtSource(PerunSession perunSession, User user, UserExtSource userExtSource, boolean forceDelete)

Removes user's external source.

void

removeUserExtSources(PerunSession perunSession, User user, List<UserExtSource> userExtSources, boolean forceDelete)

Removes user's external sources.

void

requestPreferredEmailChange(PerunSession sess, String url, User user, String email, String lang, String path, String idp)

Request change of user's preferred email address.

void

reservePassword(PerunSession sess, User user, String loginNamespace, String password)

Reserves the password in external system.

void

reservePassword(PerunSession sess, String userLogin, String loginNamespace, String password)

Reserves the password in external system.

void

reserveRandomPassword(PerunSession sess, User user, String loginNamespace)

Reserves random password in external system.

void

setLogin(PerunSession sess, User user, String loginNamespace, String login)

Allow users to manually add login in supported namespace if same login is not reserved.

User

setSpecificUser(PerunSession sess, User specificUser, SpecificUserType specificUserType, User owner)

Set specific user type for specific user and set ownership of this user for the owner.

void

unblockLogins(PerunSession sess, List<String> logins, String namespace)

Unblock logins for given namespace or unblock logins globally (if no namespace is selected)

void

unblockLoginsById(PerunSession sess, List<Integer> loginIds)

Unblock logins by id globally, or in the namespace they were initially blocked.

User

unsetSpecificUser(PerunSession sess, User specificUser, SpecificUserType specificUserType)

Remove all ownerships of this specific user and unset this specific user type from this specific user.

User

updateNameTitles(PerunSession perunSession, User user)

Updates titles before/after name of user.

User

updateUser(PerunSession perunSession, User user)

Updates users data in DB.

UserExtSource

updateUserExtSource(PerunSession perunSession, UserExtSource userExtSource)

Updates user's userExtSource in DB.

void

updateUserExtSourceLastAccess(PerunSession perunSession, UserExtSource userExtSource)

Updates user's userExtSource last access time in DB.

void

validatePassword(PerunSession sess, User user, String loginNamespace)

Validates the password in external system and sets user extSources and extSource related attributes.

void

validatePassword(PerunSession sess, String userLogin, String loginNamespace)

Validates the password in external system and sets user extSources and extSource related attributes.

String

validatePreferredEmailChange(PerunSession sess, User user, UUID token)

Validate change of user's preferred email address.

void

validateSSHKey(PerunSession sess, String sshKey)

Validate ssh public key, throws exception if validation fails

Field Details
- USERS_QUERY
  
  static final String USERS_QUERY
  See Also:
  
  Constant Field Values
Method Details
- addSpecificUserOwner
  
  void addSpecificUserOwner(PerunSession sess, User user, User specificUser) throws UserNotExistsException, PrivilegeException, NotSpecificUserExpectedException, SpecificUserExpectedException, RelationExistsException
  
  Add specificUser owner (the user) If not exists, create new ownership. If exists, only enable ownership for user and specificUser
  
  Parameters:
  
  sess -
  
  user - the user
  
  specificUser - the specificUser
  
  Throws:
  
  InternalErrorException
  
  UserNotExistsException
  
  PrivilegeException
  
  SpecificUserExpectedException - when the specificUser is not really specific user (is it normal user)
  
  NotSpecificUserExpectedException - when the user is specific User
  
  RelationExistsException - If there is such user (the user) who try to add
- addUserExtSource
  
  UserExtSource addUserExtSource(PerunSession perunSession, User user, UserExtSource userExtSource) throws UserNotExistsException, PrivilegeException, UserExtSourceExistsException
  
  Adds user's external sources.
  
  Parameters:
  
  perunSession -
  
  user -
  
  userExtSource -
  
  Returns:
  
  user external auth object with newly generated ID
  
  Throws:
  
  InternalErrorException
  
  PrivilegeException
  
  UserNotExistsException
  
  UserExtSourceExistsException
- addUserExtSourceWithAttributes
  
  RichUserExtSource addUserExtSourceWithAttributes(PerunSession sess, User user, UserExtSource userExtSource, List<Attribute> uesAttributes) throws UserNotExistsException, UserExtSourceExistsException, PrivilegeException, WrongAttributeAssignmentException, WrongReferenceAttributeValueException, UserExtSourceNotExistsException, AttributeNotExistsException, WrongAttributeValueException
  
  Adds userExternalSource to the user along with the ues attributes.
  
  Parameters:
  
  sess -
  
  user - user to assign the userExtSource to
  
  userExtSource - the UserExtSource to be created
  
  uesAttributes - the Attributes to be set to the userExtSource
  
  Returns:
  
  the newly created ues along with its attributes as RichUserExtSource
  
  Throws:
  
  UserNotExistsException
  
  UserExtSourceExistsException
  
  PrivilegeException
  
  WrongAttributeAssignmentException
  
  WrongReferenceAttributeValueException
  
  UserExtSourceNotExistsException
  
  AttributeNotExistsException
  
  WrongAttributeValueException
- anonymizeUser
  
  void anonymizeUser(PerunSession perunSession, User user, boolean force) throws UserNotExistsException, PrivilegeException, RelationExistsException, AnonymizationNotSupportedException
  
  Anonymizes user - according to configuration, each of user's attributes is either anonymized, kept untouched or deleted. Also deletes other user's related data, e.g. authorships of users publications, mail change and password reset requests, bans... If force is true then also removes associated members.
  
  Parameters:
  
  perunSession -
  
  user -
  
  force -
  
  Throws:
  
  InternalErrorException - if an internal error has occurred
  
  UserNotExistsException - if the user doesn't exist
  
  PrivilegeException - if the method isn't called by perun admin
  
  RelationExistsException - if the user has some members assigned
  
  AnonymizationNotSupportedException - if an attribute should be anonymized but its module doesn't specify the anonymization process or if the anonymization is not supported at this instance
- blockLogins
  
  void blockLogins(PerunSession sess, List<String> logins, String namespace) throws PrivilegeException, LoginIsAlreadyBlockedException, LoginExistsException
  
  Block logins for given namespace or block logins globally (if no namespace is selected)
  
  Parameters:
  
  sess -
  
  logins - list of logins to be blocked
  
  namespace - namespace where the logins should be blocked (null means block the logins globally)
  
  Throws:
  
  LoginIsAlreadyBlockedException
  
  LoginExistsException
  
  PrivilegeException
- changeNonAuthzPassword
  
  void changeNonAuthzPassword(PerunSession sess, UUID token, String password, String lang) throws UserNotExistsException, LoginNotExistsException, PasswordChangeFailedException, PasswordOperationTimeoutException, PasswordStrengthFailedException, InvalidLoginException, PasswordStrengthException, PasswordResetLinkExpiredException, PasswordResetLinkNotValidException
  
  Changes user password in defined login-namespace based on token parameter.
  
  Parameters:
  
  sess -
  
  token - token for the password reset request
  
  password - new password
  
  lang - language to get notification in
  
  Throws:
  
  InternalErrorException
  
  UserNotExistsException - When the user who requested the password reset doesn't exist
  
  LoginNotExistsException - When user doesn't have login in specified namespace
  
  InvalidLoginException - When login of user has invalid syntax (is not allowed)
  
  PasswordStrengthException - When password doesn't match expected strength by namespace configuration
  
  PasswordResetLinkExpiredException - When the password reset request expired
  
  PasswordResetLinkNotValidException - When the password reset request was already used or has never existed
  
  PasswordChangeFailedException - When password change failed
  
  PasswordOperationTimeoutException - When password change timed out
  
  PasswordStrengthFailedException
- changePassword
  
  void changePassword(PerunSession sess, String login, String loginNamespace, String oldPassword, String newPassword, boolean checkOldPassword) throws PrivilegeException, LoginNotExistsException, PasswordDoesntMatchException, PasswordChangeFailedException, PasswordOperationTimeoutException, PasswordStrengthFailedException, InvalidLoginException, PasswordStrengthException
  
  Changes user password in defined login-namespace. If checkOldPassword is true, then ask authentication system if old password is correct.
  
  Parameters:
  
  sess - Perun session
  
  login - String representation of the userLogin
  
  loginNamespace - Login-namespace to change password in
  
  oldPassword - Old password
  
  newPassword - New password
  
  checkOldPassword - If true, validates old password
  
  Throws:
  
  InternalErrorException
  
  PrivilegeException
  
  LoginNotExistsException - When user doesn't have login in specified namespace
  
  PasswordDoesntMatchException - When old password does not match
  
  PasswordChangeFailedException
  
  PasswordOperationTimeoutException
  
  PasswordStrengthFailedException
  
  InvalidLoginException
  
  PasswordStrengthException
- changePassword
  
  void changePassword(PerunSession sess, User user, String loginNamespace, String oldPassword, String newPassword, boolean checkOldPassword) throws PrivilegeException, UserNotExistsException, LoginNotExistsException, PasswordDoesntMatchException, PasswordChangeFailedException, PasswordOperationTimeoutException, PasswordStrengthFailedException, InvalidLoginException, PasswordStrengthException
  
  Changes user password in defined login-namespace. If checkOldPassword is true, then ask authentication system if old password is correct.
  
  Parameters:
  
  sess - Perun session
  
  user - User requesting password change
  
  loginNamespace - Login-namespace to change password in
  
  oldPassword - Old password
  
  newPassword - New password
  
  checkOldPassword - If true, validates old password
  
  Throws:
  
  InternalErrorException
  
  PrivilegeException
  
  UserNotExistsException - When the user doesn't exist
  
  LoginNotExistsException - When user doesn't have login in specified namespace
  
  PasswordDoesntMatchException - When old password does not match
  
  PasswordChangeFailedException
  
  PasswordOperationTimeoutException
  
  PasswordStrengthFailedException
  
  InvalidLoginException
  
  PasswordStrengthException
- changePasswordRandom
  
  String changePasswordRandom(PerunSession sess, User user, String loginNamespace) throws PrivilegeException, PasswordOperationTimeoutException, LoginNotExistsException, PasswordChangeFailedException, InvalidLoginException, PasswordStrengthException
  
  Generates new random password for given user and returns String representing HTML where is the new password.
  The HTML template is taken from entityless attribute randomPwdResetTemplate and the loginNamespace is used as a key.
  
  Parameters:
  
  sess - session
  
  user - user
  
  loginNamespace - login namespace
  
  Returns:
  
  String representing HTML with data about new generated password
  
  Throws:
  
  PrivilegeException
  
  PasswordOperationTimeoutException
  
  LoginNotExistsException
  
  PasswordChangeFailedException
  
  InvalidLoginException
  
  PasswordStrengthException
- checkPasswordResetRequestIsValid
  
  void checkPasswordResetRequestIsValid(PerunSession sess, UUID token) throws PasswordResetLinkExpiredException, PasswordResetLinkNotValidException
  
  Checks if the password reset request is valid. The request is valid, if it was created, never used and hasn't expired yet.
  
  Parameters:
  
  sess -
  
  token - token for the request to check
  
  Throws:
  
  PasswordResetLinkExpiredException - when the reset link expired
  
  PasswordResetLinkNotValidException - when the reset link was already used or has never existed
- checkPasswordStrength
  
  void checkPasswordStrength(PerunSession sess, String password, String namespace, String login) throws PasswordStrengthException
  
  Check password strength for the given namespace. If the password is too weak, the PasswordStrengthException is thrown
  
  Parameters:
  
  password - password, that will be checked
  
  namespace - namespace, that will be used to check the strength of the password
  
  login - login, which may be required for correct password strength check
  
  Throws:
  
  PasswordStrengthException - When password doesn't match expected strength by namespace configuration
- createAlternativePassword
  
  void createAlternativePassword(PerunSession sess, User user, String description, String loginNamespace, String password) throws PasswordCreationFailedException, PrivilegeException, UserNotExistsException, LoginNotExistsException, PasswordStrengthException
  
  Creates alternative password in external system.
  
  Parameters:
  
  sess -
  
  user -
  
  description - - description of a password (e.g. 'mobile phone', 'tablet', ...)
  
  loginNamespace -
  
  password - string representation of password
  
  Throws:
  
  InternalErrorException
  
  PasswordCreationFailedException
  
  UserNotExistsException
  
  LoginNotExistsException
  
  PrivilegeException
  
  PasswordStrengthException
- createServiceUser
  
  User createServiceUser(PerunSession sess, Candidate candidate, List<User> specificUserOwners) throws PrivilegeException, WrongAttributeAssignmentException, UserExtSourceExistsException, WrongReferenceAttributeValueException, WrongAttributeValueException, AttributeNotExistsException, UserNotExistsException
  
  From given candidate, creates a service user and assign given owners to him. This method also checks if some of given userExtSources do exist. If so, this method throws a UserExtSourceExistsException. This method can also set only user-def and user-opt attributes for the given candidate.
  
  Parameters:
  
  sess - session
  
  candidate - candidate
  
  specificUserOwners - owners to be set for the new user
  
  Returns:
  
  created service user
  
  Throws:
  
  UserNotExistsException - if some of the given owners does not exist
  
  AttributeNotExistsException - if some of the given attributes dont exist
  
  WrongAttributeAssignmentException - if some of the given attributes have unsupported namespace
  
  UserExtSourceExistsException - if some of the given UES already exist
  
  WrongReferenceAttributeValueException - if some of the given attribute value cannot be set because of some other attribute constraint
  
  WrongAttributeValueException - if some of the given attribute value is invalid
  
  PrivilegeException - insufficient permissions
- createUser
  
  @Deprecated User createUser(PerunSession perunSession, User user) throws PrivilegeException
  
  Deprecated.
  
  Inserts user into DB.
  
  Parameters:
  
  perunSession -
  
  user -
  
  Throws:
  
  InternalErrorException
  
  PrivilegeException
- deleteAlternativePassword
  
  void deleteAlternativePassword(PerunSession sess, User user, String loginNamespace, String passwordId) throws UserNotExistsException, PasswordDeletionFailedException, PrivilegeException, LoginNotExistsException
  
  Deletes alternative password in external system.
  
  Parameters:
  
  sess -
  
  user -
  
  loginNamespace -
  
  passwordId - passwords ID
  
  Throws:
  
  InternalErrorException
  
  UserNotExistsException
  
  PasswordDeletionFailedException
  
  LoginNotExistsException
  
  PrivilegeException
- deletePassword
  
  void deletePassword(PerunSession sess, String userLogin, String loginNamespace) throws PasswordDeletionFailedException, PrivilegeException, LoginNotExistsException, PasswordOperationTimeoutException, InvalidLoginException
  
  Deletes password in external system. User must not exist.
  
  Parameters:
  
  sess - Perun session
  
  userLogin - String representation of the userLogin
  
  loginNamespace - Login-namespace to remove password in
  
  Throws:
  
  PrivilegeException
  
  PasswordDeletionFailedException
  
  LoginNotExistsException - When user doesn't have login in specified namespace
  
  InvalidLoginException - When login of user has invalid syntax (is not allowed)
  
  PasswordOperationTimeoutException - When password change timed out
- deletePassword
  
  void deletePassword(PerunSession sess, User user, String loginNamespace) throws PrivilegeException, UserNotExistsException, LoginNotExistsException, InvalidLoginException, PasswordOperationTimeoutException, PasswordDeletionFailedException
  
  Deletes password in external system. User must exist. User's login for specified namespace must exist in Perun.
  
  Parameters:
  
  sess - Perun session
  
  user - User whose password is being removed
  
  loginNamespace - Login-namespace to remove password in
  
  Throws:
  
  PrivilegeException
  
  UserNotExistsException - When the user doesn't exist
  
  LoginNotExistsException - When user doesn't have login in specified namespace
  
  InvalidLoginException - When login of user has invalid syntax (is not allowed)
  
  PasswordOperationTimeoutException - When password change timed out
  
  PasswordDeletionFailedException
- deleteUser
  
  void deleteUser(PerunSession perunSession, User user) throws UserNotExistsException, PrivilegeException, RelationExistsException, MemberAlreadyRemovedException, UserAlreadyRemovedException, SpecificUserAlreadyRemovedException, DeletionNotSupportedException
  
  Deletes user.
  
  Parameters:
  
  perunSession -
  
  user -
  
  Throws:
  
  InternalErrorException
  
  UserNotExistsException
  
  PrivilegeException
  
  RelationExistsException - if user has some members assigned
  
  MemberAlreadyRemovedException - if there is at least 1 member deleted but not affected by deleting from DB
  
  UserAlreadyRemovedException - if there are no rows affected by deleting user in DB
  
  SpecificUserAlreadyRemovedException - if there are no rows affected by deleting specific user in DB
  
  DeletionNotSupportedException - if the deletion of users is not supported
- deleteUser
  
  void deleteUser(PerunSession perunSession, User user, boolean forceDelete) throws UserNotExistsException, PrivilegeException, RelationExistsException, MemberAlreadyRemovedException, UserAlreadyRemovedException, SpecificUserAlreadyRemovedException, DeletionNotSupportedException
  
  Deletes user. If forceDelete is true, then removes also associeted members.
  
  Parameters:
  
  perunSession -
  
  user -
  
  forceDelete - if true, deletes also all members if they are assigned to the user
  
  Throws:
  
  InternalErrorException
  
  UserNotExistsException
  
  PrivilegeException
  
  RelationExistsException - if forceDelete is false and the user has some members assigned
  
  MemberAlreadyRemovedException - if there is at least 1 member deleted but not affected by deleting from DB
  
  UserAlreadyRemovedException - if there are no rows affected by deleting user in DB
  
  SpecificUserAlreadyRemovedException - if there are no rows affected by deleting specific user in DBn
  
  DeletionNotSupportedException - if the deletion of users is not supported
- findRichUsers
  
  List<RichUser> findRichUsers(PerunSession sess, String searchString) throws UserNotExistsException, PrivilegeException
  
  Returns list of RichUsers with attributes who matches the searchString, searching name, id, uuid, email, logins.
  
  Parameters:
  
  sess -
  
  searchString -
  
  Returns:
  
  list of RichUsers
  
  Throws:
  
  InternalErrorException
  
  UserNotExistsException
  
  PrivilegeException
- findRichUsersWithAttributes
  
  List<RichUser> findRichUsersWithAttributes(PerunSession sess, String searchString, List<String> attrNames) throws UserNotExistsException, PrivilegeException
  
  Returns list of RichUsers with attributes who matches the searchString, searching name, id, uuid, email, logins.
  
  Parameters:
  
  sess -
  
  searchString -
  
  attrNames -
  
  Returns:
  
  list of RichUsers with selected attributes
  
  Throws:
  
  InternalErrorException
  
  UserNotExistsException
  
  PrivilegeException
- findRichUsersWithAttributesByExactMatch
  
  List<RichUser> findRichUsersWithAttributesByExactMatch(PerunSession sess, String searchString, List<String> attrNames) throws UserNotExistsException, PrivilegeException
  
  Returns list of RichUsers with attributes who matches the searchString, searching name, id, uuid, email, logins. Name part is searched for exact match.
  
  Parameters:
  
  sess -
  
  searchString -
  
  attrNames -
  
  Returns:
  
  list of RichUsers with selected attributes
  
  Throws:
  
  InternalErrorException
  
  UserNotExistsException
  
  PrivilegeException
- findRichUsersWithoutSpecificVoWithAttributes
  
  List<RichUser> findRichUsersWithoutSpecificVoWithAttributes(PerunSession sess, Vo vo, String searchString, List<String> attrsName) throws UserNotExistsException, PrivilegeException
  
  Return list of RichUsers who matches the searchString, searching name, email and logins and are not member in specific VO and contain selected attributes.
  
  Parameters:
  
  sess -
  
  vo -
  
  searchString -
  
  attrsName -
  
  Returns:
  
  list of RichUsers
  
  Throws:
  
  InternalErrorException
  
  UserNotExistsException
  
  PrivilegeException
- findUsers
  
  List<User> findUsers(PerunSession sess, String searchString) throws PrivilegeException
  
  Returns list of users who matches the searchString, searching name, id, uuid, email, logins.
  
  Parameters:
  
  sess -
  
  searchString -
  
  Returns:
  
  list of users
  
  Throws:
  
  InternalErrorException
  
  PrivilegeException
- findUsersByExactName
  
  List<User> findUsersByExactName(PerunSession sess, String searchString) throws PrivilegeException
  
  Returns list of users who exactly matches the searchString
  
  Parameters:
  
  sess -
  
  searchString -
  
  Returns:
  
  list of users
  
  Throws:
  
  InternalErrorException
  
  PrivilegeException
- findUsersByName
  
  List<User> findUsersByName(PerunSession sess, String searchString) throws PrivilegeException
  
  Returns list of users who matches the searchString
  
  Parameters:
  
  sess -
  
  searchString -
  
  Returns:
  
  list of users
  
  Throws:
  
  InternalErrorException
  
  PrivilegeException
- findUsersByName
  
  List<User> findUsersByName(PerunSession sess, String titleBefore, String firstName, String middleName, String lastName, String titleAfter) throws PrivilegeException
  
  Returns list of users who matches the fields.
  
  Parameters:
  
  sess -
  
  titleBefore -
  
  firstName -
  
  middleName -
  
  lastName -
  
  titleAfter -
  
  Returns:
  
  list of users
  
  Throws:
  
  InternalErrorException
  
  PrivilegeException
- generateAccount
  
  Map<String,String> generateAccount(PerunSession session, String namespace, Map<String,String> parameters) throws PrivilegeException, PasswordStrengthException
  
  Generate user account in a backend system associated with login-namespace in Perun.
  This method consumes optional parameters map. Requirements are implementation-dependant for each login-namespace.
  Returns map with 1: key=login-namespace attribute urn, value=generated login 2: rest of opt response attributes...
  
  Parameters:
  
  session -
  
  namespace - Namespace to generate account in
  
  parameters - Optional parameters
  
  Returns:
  
  Map of data from backed response
  
  Throws:
  
  InternalErrorException
  
  PrivilegeException
  
  PasswordStrengthException
- getAllBlockedLoginsInNamespaces
  
  List<BlockedLogin> getAllBlockedLoginsInNamespaces(PerunSession sess) throws PrivilegeException
  
  Returns all blocked logins in namespaces (if namespace is null, then this login is blocked globally)
  
  Parameters:
  
  sess -
  
  Returns:
  
  list of all blocked logins in namespaces
  
  Throws:
  
  PrivilegeException
- getAllRichUsers
  
  List<RichUser> getAllRichUsers(PerunSession sess, boolean includedSpecificUsers) throws PrivilegeException
  
  Get All richUsers with or without specificUsers. If includedSpecificUsers is true, you got all Users included specificUsers If includedSpecificUsers is false, you get all Users without specificUsers
  !!! This method get all RichUsers without Attributes !!!
  
  Parameters:
  
  sess -
  
  includedSpecificUsers - true or false if you want or dont want get specificUsers too
  
  Returns:
  
  list of RichUsers
  
  Throws:
  
  InternalErrorException
  
  PrivilegeException
- getAllRichUsersWithAttributes
  
  List<RichUser> getAllRichUsersWithAttributes(PerunSession sess, boolean includedSpecificUsers) throws PrivilegeException, UserNotExistsException
  
  Get All richUsers with or without specificUsers. If includedSpecificUsers is true, you got all Users included specificUsers If includedSpecificUsers is false, you get all Users without specificUsers
  This method get all RichUsers included Attributes.
  
  Parameters:
  
  sess -
  
  includedSpecificUsers - true or false if you want or dont want get specificUsers too
  
  Returns:
  
  list of RichUsers
  
  Throws:
  
  InternalErrorException
  
  PrivilegeException
  
  UserNotExistsException
- getAllRichUsersWithAttributes
  
  List<RichUser> getAllRichUsersWithAttributes(PerunSession sess, boolean includedSpecificUsers, List<String> attrsNames) throws PrivilegeException, UserNotExistsException
  
  Get All richUsers with or without specificUsers. If includedSpecificUsers is true, you got all Users included specificUsers If includedSpecificUsers is false, you get all Users without specificUsers
  This method get all RichUsers included selected Attributes.
  
  Parameters:
  
  sess -
  
  includedSpecificUsers - true or false if you want or dont want get specificUsers too
  
  attrsNames -
  
  Returns:
  
  list of RichUsers
  
  Throws:
  
  InternalErrorException
  
  PrivilegeException
  
  UserNotExistsException
- getAllowedResources
  
  List<Resource> getAllowedResources(PerunSession sess, Facility facility, User user) throws FacilityNotExistsException, UserNotExistsException, PrivilegeException
  
  Get all resources from the facility which have the user access on.
  
  Parameters:
  
  sess -
  
  facility -
  
  user -
  
  Returns:
  
  list of resources which have the user acess on
  
  Throws:
  
  InternalErrorException
  
  FacilityNotExistsException
  
  UserNotExistsException
  
  PrivilegeException
- getAllowedResources
  
  List<Resource> getAllowedResources(PerunSession sess, User user) throws UserNotExistsException, PrivilegeException
  
  Get all resources which have the user access on.
  
  Parameters:
  
  sess -
  
  user -
  
  Returns:
  
  list of resources which have the user acess on
  
  Throws:
  
  UserNotExistsException
  
  PrivilegeException
- getUserAssignments
  
  Map<Facility,List<Resource>> getUserAssignments(PerunSession sess, User user) throws UserNotExistsException, PrivilegeException
  
  Returns all assignments of the user, assignments being Facilities and Resources they are assigned to.
  
  Parameters:
  
  sess - session
  
  user - user
  
  Returns:
  
  the assignments
  
  Throws:
  
  UserNotExistsException - user does not exist
  
  PrivilegeException - insufficient rights
- getAssignedRichResources
  
  List<RichResource> getAssignedRichResources(PerunSession sess, User user) throws UserNotExistsException, PrivilegeException
  
  Get all rich resources which have the user assigned.
  
  Parameters:
  
  sess -
  
  user -
  
  Returns:
  
  list of rich resources which have the user assigned
  
  Throws:
  
  UserNotExistsException
  
  PrivilegeException
- getAssociatedResources
  
  List<Resource> getAssociatedResources(PerunSession sess, Facility facility, User user) throws UserNotExistsException, FacilityNotExistsException, PrivilegeException
  
  Return all resources of specified facility with which user is associated through all his members. Does not require ACTIVE group-resource assignment.
  
  Parameters:
  
  sess -
  
  facility -
  
  user -
  
  Returns:
  
  All resources with which user is associated
  
  Throws:
  
  UserNotExistsException
  
  FacilityNotExistsException
  
  PrivilegeException
- getBlockedLoginsPage
  
  Paginated<BlockedLogin> getBlockedLoginsPage(PerunSession sess, BlockedLoginsPageQuery query) throws PrivilegeException
  
  Get page of blocked logins.
  
  Parameters:
  
  sess - session
  
  query - query with page information
  
  Returns:
  
  page of requested blocked logins
  
  Throws:
  
  PrivilegeException
- getGroupsWhereUserIsActive
  
  List<Group> getGroupsWhereUserIsActive(PerunSession sess, Resource resource, User user) throws PrivilegeException
  
  Return all groups where user is active (has VALID status in VO and Group together) for specified user and resource
  
  Parameters:
  
  sess - PerunSession
  
  resource - Only groups assigned to this resource might be returned
  
  user - Only groups where this user is VALID member might be returned
  
  Returns:
  
  List of groups where user is active (is a VALID vo and group member) on specified resource
  
  Throws:
  
  PrivilegeException
- getGroupsWhereUserIsActive
  
  List<Group> getGroupsWhereUserIsActive(PerunSession sess, Facility facility, User user) throws PrivilegeException
  
  Return all groups where user is active (has VALID status in VO and Group together) for specified user and facility
  
  Parameters:
  
  sess - PerunSession
  
  facility - Only groups assigned to this facility (all its resources) might be returned
  
  user - Only groups where this user is VALID member might be returned
  
  Returns:
  
  List of groups where user is active (is a VALID vo and group member) on specified facility
  
  Throws:
  
  PrivilegeException
- getGroupsWhereUserIsAdmin
  
  List<Group> getGroupsWhereUserIsAdmin(PerunSession perunSession, User user) throws UserNotExistsException, PrivilegeException
  
  Returns list of Groups in Perun, where the User is a direct Administrator or he is VALID a member of any group which is Administrator of some of these Groups.
  
  Parameters:
  
  perunSession -
  
  user -
  
  Returns:
  
  list of Groups, where user or some of his groups is an Administrator
  
  Throws:
  
  InternalErrorException
  
  PrivilegeException
  
  UserNotExistsException
- getGroupsWhereUserIsAdmin
  
  List<Group> getGroupsWhereUserIsAdmin(PerunSession sess, Vo vo, User user) throws PrivilegeException, UserNotExistsException, VoNotExistsException
  
  Returns list of Groups in selected Vo, where the User is a direct Administrator or he is a VALID member of any group which is Administrator of some of these Groups.
  
  Parameters:
  
  sess -
  
  vo - selected Vo under which we are looking for groups
  
  user - manager of groups we are looking for
  
  Returns:
  
  list of Groups, where user or some of his groups (in the Vo) is an Administrator
  
  Throws:
  
  InternalErrorException
  
  PrivilegeException - user has no privileges to call this method
  
  UserNotExistsException - the user not exists in Perun
  
  VoNotExistsException - the vo not exists in Perun
- getPendingPreferredEmailChanges
  
  List<String> getPendingPreferredEmailChanges(PerunSession sess, User user) throws PrivilegeException, UserNotExistsException, WrongAttributeAssignmentException, AttributeNotExistsException
  
  Return list of email addresses of user, which are awaiting validation and are inside time window for validation.
  If there is no preferred email change request pending or requests are outside time window for validation, returns empty list.
  
  Parameters:
  
  sess - PerunSession
  
  user - User to check pending request for
  
  Returns:
  
  List user's email addresses pending validation
  
  Throws:
  
  InternalErrorException
  
  PrivilegeException
  
  UserNotExistsException
  
  WrongAttributeAssignmentException
  
  AttributeNotExistsException
- getRelatedUserIdByBlockedLoginInNamespace
  
  Integer getRelatedUserIdByBlockedLoginInNamespace(PerunSession sess, String login, String namespace) throws LoginIsNotBlockedException
  
  Get user id of the user who was related to the given login in the past
  
  Parameters:
  
  sess - session
  
  login - blocked login
  
  namespace - namespace where the login is blocked
  
  Returns:
  
  user id or null if there is no related user id
  
  Throws:
  
  LoginIsNotBlockedException
- getRichGroupsWhereUserIsActive
  
  List<RichGroup> getRichGroupsWhereUserIsActive(PerunSession sess, Resource resource, User user, List<String> attrNames) throws PrivilegeException
  
  Return all RichGroups where user is active (has VALID status in VO and Group together) for specified user and resource with specified group attributes by their names (URNs).
  
  Parameters:
  
  sess - PerunSession
  
  resource - Only groups assigned to this resource might be returned
  
  user - Only groups where this user is VALID member might be returned
  
  attrNames - Names (URNs) of group attributes to get with each returned group
  
  Returns:
  
  List of groups where user is active (is a VALID vo and group member) on specified resource
  
  Throws:
  
  PrivilegeException
- getRichGroupsWhereUserIsActive
  
  List<RichGroup> getRichGroupsWhereUserIsActive(PerunSession sess, Facility facility, User user, List<String> attrNames) throws PrivilegeException
  
  Return all groups where user is active (has VALID status in VO and Group together) for specified user and resource
  
  Parameters:
  
  sess - PerunSession
  
  facility - Only groups assigned to this facility (all its resources) might be returned
  
  user - Only groups where this user is VALID member might be returned
  
  attrNames - Names (URNs) of group attributes to get with each returned group
  
  Returns:
  
  List of groups where user is active (is a VALID vo and group member) on specified facility
  
  Throws:
  
  PrivilegeException
- getRichUser
  
  RichUser getRichUser(PerunSession sess, User user) throws PrivilegeException, UserNotExistsException
  
  Get User to RichUser without attributes.
  
  Parameters:
  
  sess -
  
  user -
  
  Returns:
  
  RichUser
  
  Throws:
  
  InternalErrorException
  
  PrivilegeException
  
  UserNotExistsException
- getRichUserExtSources
  
  List<RichUserExtSource> getRichUserExtSources(PerunSession perunSession, User user) throws UserNotExistsException, PrivilegeException
  
  Gets list of all user's external sources with attributes.
  
  Parameters:
  
  perunSession - session
  
  user - user for which should be returned rich ext sources
  
  Returns:
  
  list of user's external sources with attributes
  
  Throws:
  
  InternalErrorException - internal error
  
  UserNotExistsException - if given user doesn't exist
  
  PrivilegeException - insufficient permissions
- getRichUserExtSources
  
  List<RichUserExtSource> getRichUserExtSources(PerunSession perunSession, User user, List<String> attrsNames) throws UserNotExistsException, PrivilegeException
  
  Gets list of all user's external sources with attributes. If any of the attribute names is incorrect then the value is silently skipped. If the attrsNames is null, then this method returns all ues attributes.
  
  Parameters:
  
  perunSession - session
  
  user - user for which should be returned rich ext sources
  
  attrsNames - list of attribute names that should be found
  
  Returns:
  
  list of user's external sources with attributes
  
  Throws:
  
  InternalErrorException - internal error
  
  UserNotExistsException - if given user doesn't exist
  
  PrivilegeException - insufficient permissions
- getRichUserWithAttributes
  
  RichUser getRichUserWithAttributes(PerunSession sess, User user) throws PrivilegeException, UserNotExistsException
  
  Get User to RichUser with attributes.
  
  Parameters:
  
  sess -
  
  user -
  
  Returns:
  
  RichUser
  
  Throws:
  
  InternalErrorException
  
  PrivilegeException
  
  UserNotExistsException
- getRichUsersByIds
  
  List<RichUser> getRichUsersByIds(PerunSession sess, List<Integer> ids) throws PrivilegeException
  
  Returns rich users without attributes by their ids.
  
  Parameters:
  
  sess -
  
  ids -
  
  Returns:
  
  list of rich users with specified ids
  
  Throws:
  
  InternalErrorException
  
  PrivilegeException
- getRichUsersWithAttributesByIds
  
  List<RichUser> getRichUsersWithAttributesByIds(PerunSession sess, List<Integer> ids) throws PrivilegeException, UserNotExistsException
  
  Returns rich users with attributes by their ids.
  
  Parameters:
  
  sess -
  
  ids -
  
  Returns:
  
  list of rich users with specified ids
  
  Throws:
  
  InternalErrorException
  
  PrivilegeException
  
  UserNotExistsException
- getRichUsersWithoutVoAssigned
  
  List<RichUser> getRichUsersWithoutVoAssigned(PerunSession sess) throws UserNotExistsException, PrivilegeException
  
  Returns all RichUsers with attributes who are not member of any VO.
  
  Parameters:
  
  sess -
  
  Returns:
  
  list of richUsers who are not member of any VO
  
  Throws:
  
  InternalErrorException
  
  PrivilegeException
  
  UserNotExistsException
- getRichUsersWithoutVoWithAttributes
  
  List<RichUser> getRichUsersWithoutVoWithAttributes(PerunSession sess, List<String> attrNames) throws UserNotExistsException, PrivilegeException
  
  Returns list of RichUsers which are not members of any VO and with selected attributes
  
  Parameters:
  
  sess -
  
  attrNames -
  
  Returns:
  
  list of RichUsers with selected attributes
  
  Throws:
  
  InternalErrorException
  
  UserNotExistsException
  
  PrivilegeException
- getSpecificUsers
  
  List<User> getSpecificUsers(PerunSession sess) throws PrivilegeException
  
  Return all specific Users (only specific users)
  
  Parameters:
  
  sess -
  
  Returns:
  
  list of all specific users in perun
  
  Throws:
  
  InternalErrorException
  
  PrivilegeException
- getSpecificUsersByUser
  
  List<User> getSpecificUsersByUser(PerunSession sess, User user) throws UserNotExistsException, PrivilegeException, NotSpecificUserExpectedException
  
  Return all specificUsers who are owned by the user
  
  Parameters:
  
  sess -
  
  user - the user
  
  Returns:
  
  list of specific users who are owned by the user
  
  Throws:
  
  InternalErrorException
  
  UserNotExistsException
  
  PrivilegeException
  
  NotSpecificUserExpectedException - when the user is service User
- getSponsors
  
  @Deprecated List<RichUser> getSponsors(PerunSession sess, Member member, List<String> attrNames) throws PrivilegeException, UserNotExistsException
  
  Deprecated.
  - use getSponsorsForMember
  
  Gets list of users that sponsor the member, with attributes.
  
  Parameters:
  
  sess - Perun session
  
  member - member which is sponsored
  
  attrNames - list of attributes. if null or empty, returns all attributes
  
  Returns:
  
  list of users which sponsor the member
  
  Throws:
  
  InternalErrorException
  
  PrivilegeException
  
  UserNotExistsException
- getSponsorsForMember
  
  List<Sponsor> getSponsorsForMember(PerunSession sess, Member member, List<String> attrNames) throws PrivilegeException
  
  Gets list of users that sponsor the member, with attributes.
  
  Parameters:
  
  sess - Perun session
  
  member - member which is sponsored
  
  attrNames - list of attributes. if null or empty, returns all attributes
  
  Returns:
  
  list of users which sponsor the member
  
  Throws:
  
  PrivilegeException - insufficient permissions
- getUserByExtSourceNameAndExtLogin
  
  User getUserByExtSourceNameAndExtLogin(PerunSession sess, String extSourceName, String extLogin) throws ExtSourceNotExistsException, UserExtSourceNotExistsException, UserNotExistsException, PrivilegeException
  
  Get user by extSourceName and extSourceLogin
  
  Parameters:
  
  sess -
  
  extSourceName -
  
  extLogin -
  
  Returns:
  
  user
  
  Throws:
  
  ExtSourceNotExistsException
  
  UserExtSourceNotExistsException
  
  UserNotExistsException
  
  InternalErrorException
  
  PrivilegeException
- getUserById
  
  User getUserById(PerunSession perunSession, int id) throws UserNotExistsException, PrivilegeException
  
  Returns user by his/her id.
  
  Parameters:
  
  perunSession -
  
  id -
  
  Returns:
  
  user
  
  Throws:
  
  UserNotExistsException
  
  InternalErrorException
  
  PrivilegeException
- getUserByMember
  
  User getUserByMember(PerunSession perunSession, Member member) throws MemberNotExistsException, PrivilegeException
  
  Returns user by VO member.
  
  Parameters:
  
  perunSession -
  
  member -
  
  Returns:
  
  user
  
  Throws:
  
  UserNotExistsException
  
  InternalErrorException
  
  MemberNotExistsException
  
  PrivilegeException
- getUserByUserExtSource
  
  User getUserByUserExtSource(PerunSession perunSession, UserExtSource userExtSource) throws UserNotExistsException, UserExtSourceNotExistsException, PrivilegeException
  
  Returns user by his login in external source and external source.
  
  Parameters:
  
  perunSession -
  
  userExtSource -
  
  Returns:
  
  selected user or throws UserNotExistsException in case the user doesn't exists
  
  Throws:
  
  InternalErrorException
  
  UserNotExistsException
  
  UserExtSourceNotExistsException
  
  PrivilegeException
- getUserByUserExtSources
  
  User getUserByUserExtSources(PerunSession perunSession, List<UserExtSource> userExtSources) throws UserNotExistsException, PrivilegeException
  
  Returns user based on one of the userExtSource.
  
  Parameters:
  
  perunSession -
  
  userExtSources -
  
  Returns:
  
  user
  
  Throws:
  
  InternalErrorException
  
  UserNotExistsException
  
  PrivilegeException
- getUserExtSourceByExtLogin
  
  UserExtSource getUserExtSourceByExtLogin(PerunSession perunSession, ExtSource source, String extLogin) throws PrivilegeException, ExtSourceNotExistsException, UserExtSourceNotExistsException
  
  Gets user's external source by the user's external login and external source.
  
  Parameters:
  
  perunSession -
  
  source -
  
  extLogin -
  
  Returns:
  
  user external source object
  
  Throws:
  
  InternalErrorException
  
  PrivilegeException
  
  ExtSourceNotExistsException
  
  UserExtSourceNotExistsException
- getUserExtSourceById
  
  UserExtSource getUserExtSourceById(PerunSession sess, int id) throws UserExtSourceNotExistsException, PrivilegeException
  
  Get the user ext source by its id.
  
  Parameters:
  
  sess -
  
  id -
  
  Returns:
  
  user external source for the id
  
  Throws:
  
  InternalErrorException
  
  UserExtSourceNotExistsException
  
  PrivilegeException
- getUserExtSourceByUniqueAttributeValue
  
  UserExtSource getUserExtSourceByUniqueAttributeValue(PerunSession sess, int attrId, String uniqueValue) throws AttributeNotExistsException, UserExtSourceNotExistsException, PrivilegeException
  
  Return userExtSource for specific attribute definition (specified by id) and unique value. If not found, throw and exception.
  It looks for exactly one value of the specific attribute type: - Integer -> exactly match - String -> exactly match - Map -> exactly match of "key=value" - ArrayList -> exactly match of one of the value
  
  Parameters:
  
  sess - Perun session
  
  attrId - attribute id used for founding attribute definition which has to exists, be unique and in userExtSource namespace
  
  uniqueValue - value used for searching
  
  Returns:
  
  userExtSource found by attribute id and it's unique value
  
  Throws:
  
  UserExtSourceNotExistsException - if userExtSource can't be found
  
  AttributeNotExistsException - if attribute can't be found by it's id
  
  PrivilegeException - if the principal does not have sufficient rights to call this method
- getUserExtSourceByUniqueAttributeValue
  
  UserExtSource getUserExtSourceByUniqueAttributeValue(PerunSession sess, String attrName, String uniqueValue) throws AttributeNotExistsException, UserExtSourceNotExistsException, PrivilegeException
  
  Return userExtSource for specific attribute definition (specified by name) and unique value. If not found, throw and exception.
  It looks for exactly one value of the specific attribute type: - Integer -> exactly match - String -> exactly match - Map -> exactly match of "key=value" - ArrayList -> exactly match of one of the value
  
  Parameters:
  
  sess - Perun session
  
  attrName - attribute name used for founding attribute definition which has to exists, be unique and in userExtSource namespace
  
  uniqueValue - value used for searching
  
  Returns:
  
  userExtSource found by attribute name and it's unique value
  
  Throws:
  
  UserExtSourceNotExistsException - if userExtSource can't be found
  
  AttributeNotExistsException - if attribute can't be found by it's name
  
  PrivilegeException - if the principal does not have sufficient rights to call this method
- getUserExtSources
  
  List<UserExtSource> getUserExtSources(PerunSession perunSession, User user) throws UserNotExistsException, PrivilegeException
  
  Gets list of all user's external sources of the user.
  
  Parameters:
  
  perunSession -
  
  user -
  
  Returns:
  
  list of user's external sources
  
  Throws:
  
  InternalErrorException
  
  PrivilegeException
  
  UserNotExistsException
- getUserExtSourcesByIds
  
  List<UserExtSource> getUserExtSourcesByIds(PerunSession sess, List<Integer> ids) throws PrivilegeException
  
  Get the user ext sources by their ids.
  
  Parameters:
  
  sess -
  
  ids -
  
  Returns:
  
  list of user external sources with specified ids
  
  Throws:
  
  InternalErrorException
  
  PrivilegeException
- getUsers
  
  List<User> getUsers(PerunSession sess) throws PrivilegeException
  
  Returns all users (included specific users).
  
  Parameters:
  
  sess -
  
  Returns:
  
  list of all users
  
  Throws:
  
  InternalErrorException
  
  PrivilegeException
- getUsersByAttribute
  
  List<User> getUsersByAttribute(PerunSession sess, Attribute attribute) throws PrivilegeException
  
  Returns all users who have set the attribute with the value. Searching only def and opt attributes.
  
  Parameters:
  
  sess -
  
  attribute -
  
  Returns:
  
  list of users
  
  Throws:
  
  InternalErrorException
  
  PrivilegeException
- getUsersByAttribute
  
  List<User> getUsersByAttribute(PerunSession sess, String attributeName, String attributeValue) throws PrivilegeException, AttributeNotExistsException
  
  Returns all users who have set the attribute with the value. Searching by attributeName. Searching only def and opt attributes. Can find only attributes with String Value by this way! (not Integer, Map or List)
  
  Parameters:
  
  sess -
  
  attributeName -
  
  attributeValue -
  
  Returns:
  
  list of users
  
  Throws:
  
  InternalErrorException
  
  PrivilegeException
  
  AttributeNotExistsException
- getUsersByAttributeValue
  
  List<User> getUsersByAttributeValue(PerunSession sess, String attributeName, String attributeValue) throws PrivilegeException, AttributeNotExistsException
  
  Returns all users who have the attribute with the value. attributeValue is not converted to the attribute type, it is always type of String.
  
  Parameters:
  
  sess -
  
  attributeName -
  
  attributeValue -
  
  Returns:
  
  list of users
  
  Throws:
  
  InternalErrorException
  
  PrivilegeException
  
  AttributeNotExistsException
- getUsersByIds
  
  List<User> getUsersByIds(PerunSession perunSession, List<Integer> ids) throws PrivilegeException
  
  Returns existing users by their ids.
  
  Parameters:
  
  perunSession -
  
  ids -
  
  Returns:
  
  list of users with specified ids
  
  Throws:
  
  InternalErrorException
  
  PrivilegeException
- getUsersBySpecificUser
  
  List<User> getUsersBySpecificUser(PerunSession sess, User specificUser) throws UserNotExistsException, PrivilegeException, SpecificUserExpectedException
  
  Return all users who owns the specific one
  
  Parameters:
  
  sess -
  
  specificUser - the specific user
  
  Returns:
  
  list of user who owns the specificUser
  
  Throws:
  
  InternalErrorException
  
  UserNotExistsException
  
  PrivilegeException
  
  SpecificUserExpectedException - when the serviceUser is not really service user (is it normal user)
- getUnanonymizedUsersBySpecificUser
  
  List<User> getUnanonymizedUsersBySpecificUser(PerunSession sess, User specificUser) throws UserNotExistsException, PrivilegeException, SpecificUserExpectedException
  
  Return all users who owns the specific one and are not anonymized
  
  Parameters:
  
  sess -
  
  specificUser - the specific user
  
  Returns:
  
  list of user who owns the specificUser
  
  Throws:
  
  InternalErrorException
  
  UserNotExistsException
  
  PrivilegeException
  
  SpecificUserExpectedException - when the serviceUser is not really service user (is it normal user)
- getUsersCount
  
  int getUsersCount(PerunSession sess)
  
  Get count of all users.
  
  Parameters:
  
  sess - PerunSession
  
  Returns:
  
  count of all users
  
  Throws:
  
  InternalErrorException
- getUsersPage
  
  Paginated<RichUser> getUsersPage(PerunSession sess, UsersPageQuery query, List<String> attrNames) throws PrivilegeException, ResourceNotExistsException, VoNotExistsException, FacilityNotExistsException, ServiceNotExistsException
  
  Get page of users with the given attributes.
  
  Parameters:
  
  sess - session
  
  query - query with page information
  
  attrNames - list of attribute names
  
  Returns:
  
  page of requested rich users
  
  Throws:
  
  ResourceNotExistsException - if resource with id from query does not exist
  
  VoNotExistsException - if vo with id from query does not exist
  
  FacilityNotExistsException - if facility with id from query does not exist
  
  ServiceNotExistsException - if service with id from query does not exist
  
  PrivilegeException
- getUsersWithoutSpecificVo
  
  List<User> getUsersWithoutSpecificVo(PerunSession sess, Vo vo, String searchString) throws VoNotExistsException, PrivilegeException
  
  Return list of users who matches the searchString, searching name, email and logins and are not member in specific VO.
  
  Parameters:
  
  sess -
  
  vo -
  
  searchString -
  
  Returns:
  
  Throws:
  
  InternalErrorException
  
  VoNotExistsException
  
  PrivilegeException
- getUsersWithoutVoAssigned
  
  List<User> getUsersWithoutVoAssigned(PerunSession sess) throws PrivilegeException
  
  Returns all users who are not member of any VO.
  
  Parameters:
  
  sess -
  
  Returns:
  
  list of users who are not member of any VO
  
  Throws:
  
  InternalErrorException
  
  PrivilegeException
- getVosWhereUserIsAdmin
  
  List<Vo> getVosWhereUserIsAdmin(PerunSession perunSession, User user) throws UserNotExistsException, PrivilegeException
  
  Returns list of VOs, where the user is an Administrator. Including VOs, where the user is a VALID member of authorized group.
  
  Parameters:
  
  perunSession -
  
  user -
  
  Returns:
  
  list of VOs, where the user is an Administrator.
  
  Throws:
  
  InternalErrorException
  
  PrivilegeException
  
  UserNotExistsException
- getVosWhereUserIsMember
  
  List<Vo> getVosWhereUserIsMember(PerunSession perunSession, User user) throws UserNotExistsException, PrivilegeException
  
  Returns list of VOs, where the user is a member.
  
  Parameters:
  
  perunSession -
  
  user -
  
  Returns:
  
  list of VOs, where the user is a member.
  
  Throws:
  
  InternalErrorException
  
  UserNotExistsException
  
  PrivilegeException
- isLoginAvailable
  
  boolean isLoginAvailable(PerunSession sess, String loginNamespace, String login) throws InvalidLoginException
  
  Checks if the login is available in the namespace. Returns FALSE is is already occupied, throws exception if value is not allowed.
  
  Parameters:
  
  sess -
  
  loginNamespace - in which the login will be checked (provide only the name of the namespace, not the whole attribute name)
  
  login - to be checked
  
  Returns:
  
  true if login is available, false otherwise
  
  Throws:
  
  InvalidLoginException - When login to check has invalid syntax.
- isLoginBlocked
  
  boolean isLoginBlocked(PerunSession sess, String login, boolean ignoreCase) throws PrivilegeException
  
  Return true if login is blocked (globally - for all namespaces per instance OR for some namespace), false if not. Globally banned logins are ALWAYS case-insensitive (ignoreCase value is not taken into account for them).
  
  Parameters:
  
  sess - session
  
  login - login to check
  
  ignoreCase - ignore case
  
  Returns:
  
  true if login is blocked
  
  Throws:
  
  PrivilegeException
- isLoginBlockedForNamespace
  
  boolean isLoginBlockedForNamespace(PerunSession sess, String login, String namespace, boolean ignoreCase) throws PrivilegeException
  
  Return true if login is blocked for given namespace, false if not. When the namespace is null, then the method behaves like isLoginBlockedGlobally(), so it checks if the login is blocked globally. Globally banned logins are ALWAYS case-insensitive.
  
  Parameters:
  
  sess - session
  
  login - login to check
  
  namespace - namespace for login
  
  ignoreCase - ignore case
  
  Returns:
  
  true if login is blocked for given namespace (or globally for null namespace)
  
  Throws:
  
  PrivilegeException
- isLoginBlockedGlobally
  
  boolean isLoginBlockedGlobally(PerunSession sess, String login) throws PrivilegeException
  
  Return true if login is blocked globally (for all namespaces per instance - represented by namespace = null), false if not. Globally banned logins are ALWAYS case-insensitive.
  
  Parameters:
  
  sess - session
  
  login - login to check
  
  Returns:
  
  true if login is blocked globally
  
  Throws:
  
  PrivilegeException
- isUserPerunAdmin
  
  @Deprecated boolean isUserPerunAdmin(PerunSession sess, User user) throws PrivilegeException, UserNotExistsException
  
  Deprecated.
  
  Returns true if the user is PERUNADMIN.
  
  Parameters:
  
  sess -
  
  user -
  
  Returns:
  
  true if the user is PERUNADMIN, false otherwise.
  
  Throws:
  
  InternalErrorException
  
  PrivilegeException
  
  UserNotExistsException
- loginExist
  
  boolean loginExist(PerunSession sess, User user, String loginNamespace) throws PrivilegeException, UserNotExistsException
  
  Check, if login exists in given login-namespace. Not implemented for all namespaces.
  
  Parameters:
  
  sess - Perun session
  
  user - User to check existence of login for
  
  loginNamespace - Login-namespace to check it for
  
  Returns:
  
  True if login exists, false otherwise
  
  Throws:
  
  PrivilegeException
  
  UserNotExistsException - When the user doesn't exist
- moveUserExtSource
  
  void moveUserExtSource(PerunSession perunSession, User sourceUser, User targetUser, UserExtSource userExtSource) throws UserExtSourceNotExistsException, UserNotExistsException, PrivilegeException
  
  Take UserExtSource from sourceUser and move it to the targetUser.
  It removes old UserExtSource with all it's attributes from sourceUser and creates and assigns the new one with the same settings to target user.
  
  Parameters:
  
  perunSession -
  
  sourceUser - user with UserExtSource to move
  
  targetUser - user for who will be UserExtSource moved
  
  userExtSource - the UserExtSource which will be moved from sourceUser to targetUser
  
  Throws:
  
  InternalErrorException
  
  UserExtSourceNotExistsException - UserExtSourceNotExists or is not assigned to sourceUser
  
  UserNotExistsException - one of the users not exists
  
  PrivilegeException
- removeSpecificUserOwner
  
  void removeSpecificUserOwner(PerunSession sess, User user, User specificUser) throws UserNotExistsException, PrivilegeException, NotSpecificUserExpectedException, SpecificUserExpectedException, RelationNotExistsException, SpecificUserOwnerAlreadyRemovedException
  
  Remove specificUser owner (the user) Only disable ownership of user and specificUser
  
  Parameters:
  
  sess -
  
  user - the user
  
  specificUser - the specificUser
  
  Throws:
  
  InternalErrorException
  
  UserNotExistsException
  
  PrivilegeException
  
  SpecificUserExpectedException - when the specific user is not really specific user (is it normal user)
  
  NotSpecificUserExpectedException - when the user is specific User
  
  RelationNotExistsException - if there is no such user (the user) to remove
  
  SpecificUserOwnerAlreadyRemovedException - if there are 0 rows affected by removing from DB
- removeUserExtSource
  
  void removeUserExtSource(PerunSession perunSession, User user, UserExtSource userExtSource) throws UserNotExistsException, UserExtSourceNotExistsException, PrivilegeException, UserExtSourceAlreadyRemovedException
  
  Removes user's external source.
  
  Parameters:
  
  perunSession -
  
  user -
  
  userExtSource -
  
  Throws:
  
  InternalErrorException
  
  PrivilegeException
  
  UserExtSourceNotExistsException
  
  UserNotExistsException
  
  UserExtSourceAlreadyRemovedException - if there are 0 rows affected by deleting from DB
- removeUserExtSource
  
  void removeUserExtSource(PerunSession perunSession, User user, UserExtSource userExtSource, boolean forceDelete) throws UserNotExistsException, UserExtSourceNotExistsException, PrivilegeException, UserExtSourceAlreadyRemovedException
  
  Removes user's external source.
  
  Parameters:
  
  perunSession -
  
  user -
  
  userExtSource -
  
  forceDelete - if true, persistent ExtSource is deleted too
  
  Throws:
  
  InternalErrorException
  
  PrivilegeException
  
  UserExtSourceNotExistsException
  
  UserNotExistsException
  
  UserExtSourceAlreadyRemovedException - if there are 0 rows affected by deleting from DB
- removeUserExtSources
  
  void removeUserExtSources(PerunSession perunSession, User user, List<UserExtSource> userExtSources, boolean forceDelete) throws UserNotExistsException, UserExtSourceNotExistsException, PrivilegeException, UserExtSourceAlreadyRemovedException
  
  Removes user's external sources.
  
  Parameters:
  
  perunSession -
  
  user -
  
  userExtSources -
  
  forceDelete - if true, persistent ExtSource is deleted too
  
  Throws:
  
  InternalErrorException
  
  PrivilegeException
  
  UserExtSourceNotExistsException
  
  UserNotExistsException
  
  UserExtSourceAlreadyRemovedException - if there are 0 rows affected by deleting from DB
- requestPreferredEmailChange
  
  void requestPreferredEmailChange(PerunSession sess, String url, User user, String email, String lang, String path, String idp) throws PrivilegeException, UserNotExistsException
  
  Request change of user's preferred email address. Change in attribute value is not done, until email address is verified by link in email notice. (urn:perun:user:attribute-def:def:preferredMail)
  
  Parameters:
  
  sess - PerunSession
  
  url - base URL of running perun instance passed from RPC.
  
  user - User to request preferred email change for
  
  email - new email address
  
  lang - Language to get confirmation mail in (optional)
  
  path - path that is appended to the url of the verification link (optional)
  
  idp - authentication method appended to query parameters of verification link (optional)
  
  Throws:
  
  InternalErrorException
  
  PrivilegeException
  
  UserNotExistsException
- reservePassword
  
  void reservePassword(PerunSession sess, String userLogin, String loginNamespace, String password) throws PasswordCreationFailedException, PrivilegeException, PasswordOperationTimeoutException, PasswordStrengthFailedException, InvalidLoginException, PasswordStrengthException
  
  Reserves the password in external system. User must not exist.
  
  Parameters:
  
  sess - Perun session
  
  userLogin - String representation of the userLogin
  
  loginNamespace - Login-namespace to reserve password in
  
  password - Password to be reserved
  
  Throws:
  
  InternalErrorException
  
  PasswordCreationFailedException
  
  InvalidLoginException - When login of user has invalid syntax (is not allowed)
  
  PrivilegeException
  
  PasswordOperationTimeoutException
  
  PasswordStrengthFailedException
  
  PasswordStrengthException
- reservePassword
  
  void reservePassword(PerunSession sess, User user, String loginNamespace, String password) throws PasswordCreationFailedException, PrivilegeException, UserNotExistsException, LoginNotExistsException, PasswordOperationTimeoutException, PasswordStrengthFailedException, InvalidLoginException, PasswordStrengthException
  
  Reserves the password in external system. User must exist. User's login for specified namespace must exist in Perun.
  
  Parameters:
  
  sess - Perun session
  
  user - User to reserve password for
  
  loginNamespace - Login-namespace to reserve password in
  
  password - Password to be reserved
  
  Throws:
  
  InternalErrorException
  
  PasswordCreationFailedException
  
  UserNotExistsException - When the user doesn't exist
  
  LoginNotExistsException - When user doesn't have login in specified namespace
  
  PrivilegeException
  
  PasswordOperationTimeoutException
  
  PasswordStrengthFailedException
  
  InvalidLoginException
  
  PasswordStrengthException
- reserveRandomPassword
  
  void reserveRandomPassword(PerunSession sess, User user, String loginNamespace) throws PasswordCreationFailedException, PrivilegeException, UserNotExistsException, LoginNotExistsException, PasswordOperationTimeoutException, PasswordStrengthFailedException, InvalidLoginException
  
  Reserves random password in external system. User must exist. User's login for specified namespace must exist in Perun.
  
  Parameters:
  
  sess - Perun session
  
  user - User to reserve password for
  
  loginNamespace - Login-namespace to reserve password in
  
  Throws:
  
  InternalErrorException
  
  PasswordCreationFailedException
  
  UserNotExistsException - When the user doesn't exist
  
  LoginNotExistsException - When user doesn't have login in specified namespace
  
  PrivilegeException
  
  PasswordOperationTimeoutException
  
  PasswordStrengthFailedException
  
  InvalidLoginException
- setLogin
  
  void setLogin(PerunSession sess, User user, String loginNamespace, String login) throws PrivilegeException, UserNotExistsException, LoginExistsException, InvalidLoginException
  
  Allow users to manually add login in supported namespace if same login is not reserved. Can be set only to own service or guest users => specific users.
  
  Parameters:
  
  sess -
  
  user -
  
  loginNamespace -
  
  login -
  
  Throws:
  
  InternalErrorException
  
  PrivilegeException
  
  UserNotExistsException
  
  LoginExistsException
  
  InvalidLoginException
- setSpecificUser
  
  User setSpecificUser(PerunSession sess, User specificUser, SpecificUserType specificUserType, User owner) throws RelationExistsException, UserNotExistsException, PrivilegeException
  
  Set specific user type for specific user and set ownership of this user for the owner.
  
  Parameters:
  
  sess - perun session
  
  specificUser - specific user
  
  specificUserType - specific type of user
  
  owner - user, who will be owner of the specific user
  
  Returns:
  
  specific user with specific user type set
  
  Throws:
  
  InternalErrorException
  
  RelationExistsException
  
  UserNotExistsException
  
  PrivilegeException
- unblockLogins
  
  void unblockLogins(PerunSession sess, List<String> logins, String namespace) throws PrivilegeException, LoginIsNotBlockedException
  
  Unblock logins for given namespace or unblock logins globally (if no namespace is selected)
  
  Parameters:
  
  sess -
  
  logins - list of logins to be unblocked
  
  namespace - namespace where the logins should be unblocked (null means unblock the logins globally)
  
  Throws:
  
  LoginIsNotBlockedException
  
  PrivilegeException
- unblockLoginsById
  
  void unblockLoginsById(PerunSession sess, List<Integer> loginIds) throws PrivilegeException, LoginIsNotBlockedException
  
  Unblock logins by id globally, or in the namespace they were initially blocked.
  
  Parameters:
  
  sess - session
  
  loginIds - list of login ids
  
  Throws:
  
  PrivilegeException - insufficient permissions
  
  LoginIsNotBlockedException - when login is not blocked
- unsetSpecificUser
  
  User unsetSpecificUser(PerunSession sess, User specificUser, SpecificUserType specificUserType) throws UserNotExistsException, PrivilegeException, ServiceOnlyRoleAssignedException
  
  Remove all ownerships of this specific user and unset this specific user type from this specific user.
  
  Parameters:
  
  sess - perun session
  
  specificUser - specific user
  
  specificUserType - specific type of user
  
  Returns:
  
  user who is no more specific
  
  Throws:
  
  InternalErrorException
  
  UserNotExistsException
  
  PrivilegeException
  
  ServiceOnlyRoleAssignedException - when trying to unset service flag from a user with service only role
- updateNameTitles
  
  User updateNameTitles(PerunSession perunSession, User user) throws UserNotExistsException, PrivilegeException
  
  Updates titles before/after name of user.
  New titles must be set inside User object. Setting any title to null will remove title from name. Other user's properties are ignored.
  
  Parameters:
  
  perunSession -
  
  user -
  
  Returns:
  
  updated user with new titles before/after name
  
  Throws:
  
  InternalErrorException
  
  UserNotExistsException
  
  PrivilegeException
- updateUser
  
  User updateUser(PerunSession perunSession, User user) throws UserNotExistsException, PrivilegeException
  
  Updates users data in DB.
  
  Parameters:
  
  perunSession -
  
  user -
  
  Returns:
  
  updated user
  
  Throws:
  
  InternalErrorException
  
  UserNotExistsException
  
  PrivilegeException
- updateUserExtSource
  
  UserExtSource updateUserExtSource(PerunSession perunSession, UserExtSource userExtSource) throws UserExtSourceNotExistsException, UserExtSourceExistsException, PrivilegeException
  
  Updates user's userExtSource in DB. Login and LoA can be updated this way.
  
  Parameters:
  
  perunSession -
  
  userExtSource -
  
  Returns:
  
  updated userExtSource
  
  Throws:
  
  InternalErrorException
  
  PrivilegeException
  
  UserExtSourceExistsException - When UES with same login/extSource already exists.
  
  UserExtSourceNotExistsException - When UES by its ID doesn't exists
- updateUserExtSourceLastAccess
  
  void updateUserExtSourceLastAccess(PerunSession perunSession, UserExtSource userExtSource) throws PrivilegeException, UserExtSourceNotExistsException
  
  Updates user's userExtSource last access time in DB. We can get information which userExtSource has been used as a last one.
  
  Parameters:
  
  perunSession -
  
  userExtSource -
  
  Throws:
  
  InternalErrorException
  
  PrivilegeException
  
  UserExtSourceNotExistsException
- validatePassword
  
  void validatePassword(PerunSession sess, String userLogin, String loginNamespace) throws PasswordCreationFailedException, PrivilegeException, InvalidLoginException
  
  Validates the password in external system and sets user extSources and extSource related attributes. User must not exist.
  
  Parameters:
  
  sess - Perun session
  
  userLogin - String representation of the userLogin
  
  loginNamespace - Login-namespace to validate password in
  
  Throws:
  
  InternalErrorException
  
  PasswordCreationFailedException
  
  InvalidLoginException - When login of user has invalid syntax (is not allowed)
  
  PrivilegeException
- validatePassword
  
  void validatePassword(PerunSession sess, User user, String loginNamespace) throws PasswordCreationFailedException, PrivilegeException, UserNotExistsException, LoginNotExistsException, InvalidLoginException
  
  Validates the password in external system and sets user extSources and extSource related attributes. User must exist. User's login for specified namespace must exist in Perun.
  
  Parameters:
  
  sess - Perun session
  
  user - User whose password should being validated
  
  loginNamespace - Login-namespace to validate password in
  
  Throws:
  
  InternalErrorException
  
  PasswordCreationFailedException
  
  UserNotExistsException - When the user doesn't exist
  
  LoginNotExistsException - When user doesn't have login in specified namespace
  
  PrivilegeException
  
  InvalidLoginException
- validatePreferredEmailChange
  
  String validatePreferredEmailChange(PerunSession sess, User user, UUID token) throws PrivilegeException, UserNotExistsException, WrongAttributeAssignmentException, AttributeNotExistsException, WrongReferenceAttributeValueException, WrongAttributeValueException
  
  Validate change of user's preferred email address. New email address is set as value of urn:perun:user:attribute-def:def:preferredMail attribute.
  
  Parameters:
  
  sess - PerunSession
  
  user - User to validate email address for
  
  token - token for the email change request to validate
  
  Returns:
  
  String return new preferred email
  
  Throws:
  
  InternalErrorException
  
  PrivilegeException
  
  UserNotExistsException
  
  WrongAttributeAssignmentException
  
  AttributeNotExistsException
  
  WrongReferenceAttributeValueException
  
  WrongAttributeValueException
- validateSSHKey
  
  void validateSSHKey(PerunSession sess, String sshKey) throws SSHKeyNotValidException
  
  Validate ssh public key, throws exception if validation fails
  
  Parameters:
  
  sess - sess
  
  sshKey - ssh public key to verify
  
  Throws:
  
  SSHKeyNotValidException - when validation fails
- changeOrganization
  
  void changeOrganization(PerunSession sess, User user, String newOrganizationName) throws UserNotExistsException, PrivilegeException, UserExtSourceNotExistsException, PersonalDataChangeNotEnabledException
  
  Change organization from which user came to organization from user ext source.
  
  Parameters:
  
  sess - session
  
  user - user
  
  newOrganizationName - new organization name
  
  Throws:
  
  UserNotExistsException - If user does not exist.
  
  PrivilegeException - if privileges are not given.
  
  PersonalDataChangeNotEnabledException - If change of organization to organization from ues is not enabled.
  
  UserExtSourceNotExistsException - If user ext source with given organization name and required loa does not exist.
- changeOrganizationCustom
  
  void changeOrganizationCustom(PerunSession sess, User user, String newOrganizationName) throws UserNotExistsException, PrivilegeException, PersonalDataChangeNotEnabledException
  
  Change organization from which user came to custom organization. If check from admin is required, then UserOrganizationChangeRequested audit log will be created. Otherwise, it will be set immediately.
  
  Parameters:
  
  sess - session
  
  user - user
  
  newOrganizationName - new organization name
  
  Throws:
  
  UserNotExistsException - If user does not exist.
  
  PrivilegeException - if privileges are not given.
  
  PersonalDataChangeNotEnabledException - If change of organization to custom organization is not enabled.
- changeName
  
  void changeName(PerunSession sess, User user, String newUserName) throws UserNotExistsException, PrivilegeException, UserExtSourceNotExistsException, PersonalDataChangeNotEnabledException
  
  Change user's name to user's name from user ext source.
  
  Parameters:
  
  sess - session
  
  user - user
  
  newUserName - new user's name
  
  Throws:
  
  UserNotExistsException - If user does not exist.
  
  PrivilegeException - if privileges are not given.
  
  PersonalDataChangeNotEnabledException - If change of user's name to user's name from ues is not enabled.
  
  UserExtSourceNotExistsException - If user ext source with given user's name and required loa does not exist.
- changeNameCustom
  
  void changeNameCustom(PerunSession sess, User user, String titleBefore, String firstName, String middleName, String lastName, String titleAfter) throws UserNotExistsException, PrivilegeException, PersonalDataChangeNotEnabledException
  
  Change user's name to custom name. If check from admin is required, then UserNameChangeRequest audit log will be created. Otherwise, it will be set immediately.
  
  Parameters:
  
  sess - session
  
  user - user
  
  titleBefore - new title before
  
  firstName - new first name
  
  middleName - new middle name
  
  lastName - new last name
  
  titleAfter - new title after
  
  Throws:
  
  UserNotExistsException - If user does not exist.
  
  PrivilegeException - if privileges are not given.
  
  PersonalDataChangeNotEnabledException - If change of user's name to custom name is not enabled.
- changeEmail
  
  void changeEmail(PerunSession sess, User user, String newEmail) throws UserNotExistsException, PrivilegeException, UserExtSourceNotExistsException, PersonalDataChangeNotEnabledException
  
  Change user's email to email from user ext source.
  
  Parameters:
  
  sess - session
  
  user - user
  
  newEmail - new email
  
  Throws:
  
  UserNotExistsException - If user does not exist.
  
  PrivilegeException - if privileges are not given.
  
  PersonalDataChangeNotEnabledException - If change of user's email to email from ues is not enabled.
  
  UserExtSourceNotExistsException - If user ext source with given email and required loa does not exist.
- changeEmailCustom
  
  void changeEmailCustom(PerunSession sess, User user, String newEmail, String url, String lang, String path, String idp) throws UserNotExistsException, PrivilegeException, PersonalDataChangeNotEnabledException
  
  Change user's email to custom email. If verification is required, then verification email will be sent. Otherwise, it will be set immediately.
  
  Parameters:
  
  sess - session
  
  user - user
  
  newEmail - new email
  
  url - base URL of running perun instance passed from RPC.
  
  lang - Language to get confirmation mail in (optional)
  
  path - path that is appended to the url of the verification link (optional)
  
  idp - authentication method appended to query parameters of verification link (optional)
  
  Throws:
  
  UserNotExistsException - If user does not exist.
  
  PrivilegeException - if privileges are not given.
  
  PersonalDataChangeNotEnabledException - If change of user's email to custom email is not enabled.
- getUserRelations
  
  Map<String,List<PerunBean>> getUserRelations(PerunSession sess, User user) throws UserNotExistsException
  
  Gets map with 2 items which are a list of all vos and a list of all groups where given user is member filtered by principal's privileges.
  
  Parameters:
  
  sess - perun session
  
  user - user
  
  Returns:
  
  Result map with lists of vos and groups where given user is member
  
  Throws:
  
  UserNotExistsException - If user does not exist.

Interface UsersManager

Field Summary

Method Summary

Field Details

USERS_QUERY

Method Details

addSpecificUserOwner

addUserExtSource

addUserExtSourceWithAttributes

anonymizeUser

blockLogins

changeNonAuthzPassword

changePassword

changePassword

changePasswordRandom

checkPasswordResetRequestIsValid

checkPasswordStrength

createAlternativePassword

createServiceUser

createUser

deleteAlternativePassword

deletePassword

deletePassword

deleteUser

deleteUser

findRichUsers

findRichUsersWithAttributes

findRichUsersWithAttributesByExactMatch

findRichUsersWithoutSpecificVoWithAttributes

findUsers

findUsersByExactName

findUsersByName

findUsersByName

generateAccount

getAllBlockedLoginsInNamespaces

getAllRichUsers

getAllRichUsersWithAttributes

getAllRichUsersWithAttributes

getAllowedResources

getAllowedResources

getUserAssignments

getAssignedRichResources

getAssociatedResources

getBlockedLoginsPage

getGroupsWhereUserIsActive

getGroupsWhereUserIsActive

getGroupsWhereUserIsAdmin

getGroupsWhereUserIsAdmin

getPendingPreferredEmailChanges

getRelatedUserIdByBlockedLoginInNamespace

getRichGroupsWhereUserIsActive

getRichGroupsWhereUserIsActive

getRichUser

getRichUserExtSources

getRichUserExtSources

getRichUserWithAttributes

getRichUsersByIds

getRichUsersWithAttributesByIds

getRichUsersWithoutVoAssigned

getRichUsersWithoutVoWithAttributes

getSpecificUsers

getSpecificUsersByUser

getSponsors

getSponsorsForMember

getUserByExtSourceNameAndExtLogin

getUserById

getUserByMember

getUserByUserExtSource

getUserByUserExtSources

getUserExtSourceByExtLogin

getUserExtSourceById

getUserExtSourceByUniqueAttributeValue

getUserExtSourceByUniqueAttributeValue

getUserExtSources

getUserExtSourcesByIds

getUsers

getUsersByAttribute

getUsersByAttribute

getUsersByAttributeValue

getUsersByIds