Package cz.metacentrum.perun.core.bl

Interface UsersManagerBl

All Known Implementing Classes:

UsersManagerBlImpl

public interface UsersManagerBl

UsersManager manages users.

Author:

Michal Prochazka, Slavek Licehammer, Zora Sebestianova, Sona Mastrakova

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADDITIONAL_IDENTIFIERS_ATTRIBUTE_NAME
static final String	ADDITIONAL_IDENTIFIERS_PERUN_ATTRIBUTE_NAME
static final String	MULTIVALUE_ATTRIBUTE_SEPARATOR_REGEX
static final String	ORIGIN_IDENTITY_PROVIDER_KEY

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.
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, Integer relatedUserId)	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 of the password reset request.
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.
String	changePasswordRandom(PerunSession session, User user, String loginNamespace)	Generates new random password for given user and returns String representing HTML where is the new password.
void	checkBlockedLogins(PerunSession sess, String namespace, String userLogin, boolean ignoreCase)	Check if login is blocked.
void	checkPasswordResetRequestIsValid(PerunSession sess, UUID token)	Checks if the password reset request link is valid.
void	checkPasswordStrength(PerunSession sess, String password, String namespace, String login)	Check password strength for the given namespace.
void	checkReservedLogins(PerunSession sess, String namespace, String login, boolean ignoreCase)	Check if login exists in specified namespace or in any namespace (if namespace is null).
void	checkUserExists(PerunSession sess, User user)
void	checkUserExtSourceExists(PerunSession sess, UserExtSource userExtSource)
void	checkUserExtSourceExistsById(PerunSession sess, int id)
List<RichUser>	convertRichUsersToRichUsersWithAttributes(PerunSession sess, List<RichUser> richUsers)	From List of Rich Users without attribute make list of Rich Users with attributes
User	convertUserEmptyStringsInObjectAttributesIntoNull(User user)	Get user and convert values of his object attributes: - firstName - lastName - middleName - titleBefore - titleAfter from emptyString (like "") to null.
List<RichUser>	convertUsersToRichUsers(PerunSession sess, List<User> users)	From List of Users make list of RichUsers (without attributes)
List<RichUser>	convertUsersToRichUsersWithAttributes(PerunSession sess, List<RichUser> richUsers, List<AttributeDefinition> attrsDef)	Convert RichUsers without attribute to RichUsers with specific attributes.
List<RichUser>	convertUsersToRichUsersWithAttributesByNames(PerunSession sess, List<User> users, List<String> attrNames)	From List of Users make list of RichUsers (with attributes by names)
RichUser	convertUserToRichUserWithAttributesByNames(PerunSession sess, User user, List<String> attrNames)	From User make Rich user (with attributes by names)
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> owners)	From given candidate, creates a service user and assign given owners to him.
User	createUser(PerunSession sess, Candidate candidate)	From given candidate, creates a user.
User	createUser(PerunSession perunSession, User user)	Inserts user into DB.
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 for existing user.
void	deletePassword(PerunSession sess, String userLogin, String loginNamespace)	Deletes password in external system.
void	deleteReservedLoginsForNamespace(PerunSession sess, String namespace)	Deletes all reserved logins in given namespace
void	deleteReservedLoginsOnlyByGivenApp(PerunSession sess, int appId)	Deletes reserved logins which can be deleted - they are used only in the given application.
void	deleteUser(PerunSession perunSession, User user)	Deletes user.
void	deleteUser(PerunSession perunSession, User user, boolean forceDelete)	Deletes user.
RichUser	filterOnlyAllowedAttributes(PerunSession sess, RichUser richUser)	For richUser filter all his user attributes and remove all which principal has no access to.
List<RichUser>	filterOnlyAllowedAttributes(PerunSession sess, List<RichUser> richUsers)	For list of richUser filter all their user attributes and remove all which principal has no access to.
List<RichUserExtSource>	filterOnlyAllowedAttributesForRichUserExtSources(PerunSession sess, List<RichUserExtSource> richUserExtSources)	From given list of RichUserExtSource removes the attributes which are not allowed for the current principal.
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>	findRichUsersByExactMatch(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 selected 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 selected 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 and 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.
List<User>	findUsersWithExtSourceAttributeValueEnding(PerunSessionImpl sess, String attributeName, String valueEnd, List<String> excludeValueEnds)	Finds users with UserExtSource with attribute value that ends with specified string but not with specified exclude strings.
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<UserExtSource>	getActiveUserExtSources(PerunSession sess, User user)	Get all users userExtSources with last_access not older than (now - m), where 'm' is number of months defined in CONSTANT in UsersManagerImpl.
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 User to RichUser with attributes.
List<UserExtSource>	getAllUserExtSourcesByTypeAndLogin(PerunSession sess, String extType, String extLogin)	Gets list of all users external sources by specific type and extLogin.
List<Resource>	getAssignedResources(PerunSession sess, Facility facility, User user)	Get all resources from the facility where the user is assigned.
List<Resource>	getAssignedResources(PerunSession sess, User user)	Get all resources where the user is assigned.
List<RichResource>	getAssignedRichResources(PerunSession sess, User user)	Get all rich resources where the user is 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.
List<Resource>	getAssociatedResources(PerunSession sess, User user)	Get all resources with which user can be associated (similar to assigned resources, but does not require ACTIVE group-resource assignment).
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 a VALID 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.
int	getIdOfBlockedLogin(PerunSession sess, String login, String namespace)	Return ID of blocked login
PasswordManagerModule	getPasswordManagerModule(PerunSession session, String namespace)	Returns password manager module for specified login-namespace or falls back on generic password manager module.
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<Pair<String,String>>	getReservedLoginsByApp(PerunSession sess, int appId)	Gets reserved logins which are used in the given application.
List<Pair<String,String>>	getReservedLoginsOnlyByGivenApp(PerunSession sess, int appId)	Gets reserved logins which can be deleted - they are used only in the given application.
RichUser	getRichUser(PerunSession sess, User user)	Get User to RichUser without attributes.
List<RichUserExtSource>	getRichUserExtSources(PerunSession sess, 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>	getRichUsersFromListOfUsers(PerunSession sess, List<User> users)	From Users makes RichUsers without attributes.
List<RichUser>	getRichUsersWithAttributesByIds(PerunSession sess, List<Integer> ids)	Returns rich users with attributes by their ids.
List<RichUser>	getRichUsersWithAttributesFromListOfUsers(PerunSession sess, List<User> users)	From Users makes RichUsers with attributes.
List<RichUser>	getRichUsersWithoutVoAssigned(PerunSession sess)	Returns all RichUsers with attributes who are not member of any VO.
List<RichUser>	getRichUsersWithoutVoWithAttributes(PerunSession sess, List<String> attrsName)	Return list of RichUsers which are not members of any VO and contain 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 and their ownership is not in status disabled
List<User>	getSponsors(PerunSession sess, Member sponsoredMember)	Gets list of users that sponsor the member.
Map<Integer,List<Pair<User,Sponsorship>>>	getSponsorsForSponsoredMembersInVo(PerunSession sess, int voId)	Retrieves a map, that maps the ids of the sponsored members in the given VO to a list of their Sponsors with the corresponding Sponsorship objects.
List<User>	getUnanonymizedUsersBySpecificUser(PerunSession sess, User specificUser)	Return all users who owns the specificUser, their ownership is not in status disabled and are not anonymized
User	getUserByExtSourceInformation(PerunSession sess, PerunPrincipal principal)	Get user by principal's additional identifiers or extSourceName and extSourceLogin.
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 sess, List<UserExtSource> userExtSources)	Get the 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 id) and unique value.
UserExtSource	getUserExtSourceFromMultipleIdentifiers(PerunSession sess, PerunPrincipal principal)	Iteratively searches through additional identifiers trying to find userExtSource with the same identifier.
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 user ext sources by their ids.
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, Attribute attribute, boolean ignoreCase)	Returns all users who have set the attribute with the value IGNORING CASE in the comparison.
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.
List<User>	getUsersByExtSourceTypeAndLogin(PerunSession perunSession, String extSourceType, String login)	Get all the users who have given type of the ExtSource and login.
List<User>	getUsersByIds(PerunSession sess, List<Integer> usersIds)	Batch method which returns users by theirs ids.
List<User>	getUsersByPerunBean(PerunSession sess, Facility facility)	Returns list of users connected with a facility
List<User>	getUsersByPerunBean(PerunSession sess, Group group)	Returns list of users connected with a group
List<User>	getUsersByPerunBean(PerunSession sess, Host host)	Returns list of users connected with a host
List<User>	getUsersByPerunBean(PerunSession sess, Member member)	Returns list of users connected with a member
List<User>	getUsersByPerunBean(PerunSession sess, Resource resource)	Returns list of users connected with a resource
List<User>	getUsersByPerunBean(PerunSession sess, Vo vo)	Returns list of users connected with a vo
List<User>	getUsersBySpecificUser(PerunSession sess, User specificUser)	Return all users who owns the specificUser and their ownership is not in status disabled
int	getUsersCount(PerunSession perunSession)	Get count of all users.
Paginated<RichUser>	getUsersPage(PerunSession sess, UsersPageQuery query, List<String> attrNames)	Get page of users with the given attributes.
List<Pair<String,String>>	getUsersReservedLogins(PerunSession sess, User user)	Return list of all reserved logins for specific user (pair is namespace and login)
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 When the namespace is null, then the method behaves like isLoginBlockedGlobally(), so it checks if the login is blocked globally.
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 Globally banned logins are ALWAYS case-insensitive.
boolean	isUserAnonymized(PerunSession sess, User user)	Checks whether user has been anonymized or not.
boolean	isUserPerunAdmin(PerunSession sess, User user)	Deprecated.
boolean	loginExist(PerunSession sess, User user, String loginNamespace)	Checks 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	removeAllUserExtSources(PerunSession sess, User user)	Removes all user's external sources.
void	removeSpecificUserOwner(PerunSession sess, User user, User specificUser)	Remove specificUser owner (the user) Only disable ownership of user and specificUser
void	removeSpecificUserOwner(PerunSession sess, User user, User specificUser, boolean forceDelete)	Remove specificUser owner (the user).
void	removeUserExtSource(PerunSession perunSession, User user, UserExtSource userExtSource)	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.
boolean	specificUserOwnershipExists(PerunSession sess, User user, User specificUser)	Return true if ownership of user and specificUser already exists.
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.
void	unblockLoginsForNamespace(PerunSession sess, String namespace)	Unblock all logins for given namespace
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 users name.
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.
boolean	userExtSourceExists(PerunSession sess, UserExtSource userExtSource)
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

ORIGIN_IDENTITY_PROVIDER_KEY

static final String ORIGIN_IDENTITY_PROVIDER_KEY

See Also:

• Constant Field Values

MULTIVALUE_ATTRIBUTE_SEPARATOR_REGEX

static final String MULTIVALUE_ATTRIBUTE_SEPARATOR_REGEX

See Also:

• Constant Field Values

ADDITIONAL_IDENTIFIERS_ATTRIBUTE_NAME

static final String ADDITIONAL_IDENTIFIERS_ATTRIBUTE_NAME

See Also:

• Constant Field Values

ADDITIONAL_IDENTIFIERS_PERUN_ATTRIBUTE_NAME

static final String ADDITIONAL_IDENTIFIERS_PERUN_ATTRIBUTE_NAME

See Also:

• Constant Field Values

Method Details

addSpecificUserOwner

void addSpecificUserOwner(PerunSession sess,
 User user,
 User specificUser)
                   throws 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

RelationExistsException - If there is such user (the user) who try to add

addUserExtSource

UserExtSource addUserExtSource(PerunSession perunSession,
 User user,
 UserExtSource userExtSource)
                        throws UserExtSourceExistsException

Adds user's external sources.

Parameters:

perunSession -

user -

userExtSource -

Returns:

user external auth object with newly generated ID

Throws:

InternalErrorException

UserExtSourceExistsException

anonymizeUser

void anonymizeUser(PerunSession perunSession,
 User user,
 boolean force)
            throws 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

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,
 Integer relatedUserId)
          throws 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)

relatedUserId - id of the user related to the login or null if the relatedUserId should not be stored

Throws:

LoginIsAlreadyBlockedException

LoginExistsException

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 of the password reset request.

Parameters:

sess - PerunSession

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,
 User user,
 String loginNamespace,
 String oldPassword,
 String newPassword,
 boolean checkOldPassword)
             throws 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. user must exists.

Parameters:

sess -

user - user object which is used to get userLogin from the loginNamespace

loginNamespace -

oldPassword -

newPassword -

checkOldPassword -

Throws:

InternalErrorException

PasswordDoesntMatchException - When old password does not match

PasswordChangeFailedException

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

PasswordOperationTimeoutException

PasswordStrengthFailedException

changePasswordRandom

String changePasswordRandom(PerunSession session,
 User user,
 String loginNamespace)
                     throws 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:

session - session

user - user

loginNamespace - login namespace

Returns:

String representing HTML with data about new generated password

Throws:

PasswordOperationTimeoutException - password change timed out

InternalErrorException - internal error

PasswordChangeFailedException - password change failed

LoginNotExistsException - When user doesn't have login in specified namespace

InvalidLoginException - When When login of user has invalid syntax (is not allowed)

PasswordStrengthException - When password doesn't match expected strength by namespace configuration

checkBlockedLogins

void checkBlockedLogins(PerunSession sess,
 String namespace,
 String userLogin,
 boolean ignoreCase)
                 throws LoginIsAlreadyBlockedException

Check if login is blocked. Login can be blocked by default (used by internal components), globally or in namespace.

Parameters:

sess - session

namespace - attribute

userLogin - login

ignoreCase - ignore case (work as case-insensitive)

Throws:

LoginIsAlreadyBlockedException - when login is blocked

checkPasswordResetRequestIsValid

void checkPasswordResetRequestIsValid(PerunSession sess,
 UUID token)
                               throws PasswordResetLinkExpiredException,
PasswordResetLinkNotValidException

Checks if the password reset request link is valid. The request is valid, if it was created, never used and hasn't expired yet.

Parameters:

sess - PerunSession

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

checkReservedLogins

void checkReservedLogins(PerunSession sess,
 String namespace,
 String login,
 boolean ignoreCase)
                  throws AlreadyReservedLoginException

Check if login exists in specified namespace or in any namespace (if namespace is null).

Parameters:

sess -

namespace - namespace for login, null for all namespace

login - login to check

ignoreCase - TRUE to perform case-insensitive check

Throws:

InternalErrorException

AlreadyReservedLoginException - throw this exception if login already exist in table of reserved logins

checkUserExists

void checkUserExists(PerunSession sess,
 User user)
              throws UserNotExistsException

Throws:

UserNotExistsException

checkUserExtSourceExists

void checkUserExtSourceExists(PerunSession sess,
 UserExtSource userExtSource)
                       throws UserExtSourceNotExistsException

Throws:

UserExtSourceNotExistsException

checkUserExtSourceExistsById

void checkUserExtSourceExistsById(PerunSession sess,
 int id)
                           throws UserExtSourceNotExistsException

Throws:

UserExtSourceNotExistsException

convertRichUsersToRichUsersWithAttributes

List<RichUser> convertRichUsersToRichUsersWithAttributes(PerunSession sess,
 List<RichUser> richUsers)
                                                  throws UserNotExistsException

From List of Rich Users without attribute make list of Rich Users with attributes

Parameters:

sess -

richUsers -

Returns:

list of Rich Users with attributes

Throws:

InternalErrorException

UserNotExistsException

convertUserEmptyStringsInObjectAttributesIntoNull

User convertUserEmptyStringsInObjectAttributesIntoNull(User user)

Get user and convert values of his object attributes: - firstName - lastName - middleName - titleBefore - titleAfter from emptyString (like "") to null.

If these values are not empty strings, do not change them. If user is null, return null.

Parameters:

user - user to converting

Returns:

converted user

convertUserToRichUserWithAttributesByNames

RichUser convertUserToRichUserWithAttributesByNames(PerunSession sess,
 User user,
 List<String> attrNames)

From User make Rich user (with attributes by names)

Parameters:

sess - session

user - user to be converted

attrNames - list of Strings with attribute names

Returns:

RichUser with attributes

Throws:

InternalErrorException - internal error

convertUsersToRichUsers

List<RichUser> convertUsersToRichUsers(PerunSession sess,
 List<User> users)

From List of Users make list of RichUsers (without attributes)

Parameters:

sess -

users -

Returns:

list of RIch Users without attributes

Throws:

InternalErrorException

convertUsersToRichUsersWithAttributes

List<RichUser> convertUsersToRichUsersWithAttributes(PerunSession sess,
 List<RichUser> richUsers,
 List<AttributeDefinition> attrsDef)

Convert RichUsers without attribute to RichUsers with specific attributes. Specific by list of Attributes. If in list of Attributes is some notUser attribute, it is skipped.

Parameters:

sess -

richUsers -

attrsDef -

Returns:

list of RichUsers with specific attributes

Throws:

InternalErrorException

convertUsersToRichUsersWithAttributesByNames

List<RichUser> convertUsersToRichUsersWithAttributesByNames(PerunSession sess,
 List<User> users,
 List<String> attrNames)

From List of Users make list of RichUsers (with attributes by names)

Parameters:

sess -

users -

Returns:

list of RIch Users without attributes

Throws:

InternalErrorException

createAlternativePassword

void createAlternativePassword(PerunSession sess,
 User user,
 String description,
 String loginNamespace,
 String password)
                        throws PasswordCreationFailedException,
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

LoginNotExistsException - When user doesn't have login in specified namespace

PasswordStrengthException - When password doesn't match expected strength by namespace configuration

createServiceUser

User createServiceUser(PerunSession sess,
 Candidate candidate,
 List<User> owners)
                throws WrongAttributeAssignmentException,
UserExtSourceExistsException,
WrongReferenceAttributeValueException,
WrongAttributeValueException,
AttributeNotExistsException

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

owners - owners to be set for the new user

Returns:

created service user

Throws:

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

createUser

User createUser(PerunSession perunSession,
 User user)

Inserts user into DB.

Parameters:

perunSession -

user -

Throws:

InternalErrorException

createUser

User createUser(PerunSession sess,
 Candidate candidate)
         throws UserExtSourceExistsException,
AttributeNotExistsException,
WrongAttributeAssignmentException,
WrongAttributeValueException,
WrongReferenceAttributeValueException

From given candidate, creates a user. 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

Returns:

created user

Throws:

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

deleteAlternativePassword

void deleteAlternativePassword(PerunSession sess,
 User user,
 String loginNamespace,
 String passwordId)
                        throws PasswordDeletionFailedException,
LoginNotExistsException

Deletes alternative password in external system.

Parameters:

sess -

loginNamespace -

passwordId - passwords ID

Throws:

InternalErrorException

UserNotExistsException

PasswordDeletionFailedException

LoginNotExistsException - When user doesn't have login in specified namespace

deletePassword

void deletePassword(PerunSession sess,
 String userLogin,
 String loginNamespace)
             throws PasswordDeletionFailedException,
LoginNotExistsException,
PasswordOperationTimeoutException,
InvalidLoginException

Deletes password in external system. User must not exists.

Parameters:

sess -

userLogin - string representation of the userLogin

loginNamespace -

Throws:

InternalErrorException

PasswordDeletionFailedException

LoginNotExistsException - When user doesn't have login in specified namespace

InvalidLoginException - When login of user has invalid syntax (is not allowed)

PasswordOperationTimeoutException

deletePassword

void deletePassword(PerunSession sess,
 User user,
 String loginNamespace)
             throws PasswordDeletionFailedException,
LoginNotExistsException,
PasswordOperationTimeoutException,
InvalidLoginException

Deletes password in external system for existing user. User's login for specified namespace must exist in Perun.

Parameters:

sess - perunSession

user - for which the password will be deleted

loginNamespace - from which the password will be deleted

Throws:

PasswordDeletionFailedException

LoginNotExistsException - When user doesn't have login in specified namespace

PasswordOperationTimeoutException

InvalidLoginException - When login of user has invalid syntax (is not allowed)

deleteReservedLoginsForNamespace

void deleteReservedLoginsForNamespace(PerunSession sess,
 String namespace)

Deletes all reserved logins in given namespace

Parameters:

sess - PerunSession

namespace - Namespace

deleteReservedLoginsOnlyByGivenApp

void deleteReservedLoginsOnlyByGivenApp(PerunSession sess,
 int appId)
                                 throws PasswordOperationTimeoutException,
InvalidLoginException,
PasswordDeletionFailedException

Deletes reserved logins which can be deleted - they are used only in the given application. Deletes them from both KDC and DB.

Parameters:

sess -

appId -

Throws:

PasswordOperationTimeoutException

InvalidLoginException

PasswordDeletionFailedException

deleteUser

void deleteUser(PerunSession perunSession,
 User user)
         throws RelationExistsException,
MemberAlreadyRemovedException,
UserAlreadyRemovedException,
SpecificUserAlreadyRemovedException,
DeletionNotSupportedException

Deletes user.

Parameters:

perunSession -

user -

Throws:

InternalErrorException

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 at this instance

deleteUser

void deleteUser(PerunSession perunSession,
 User user,
 boolean forceDelete)
         throws RelationExistsException,
MemberAlreadyRemovedException,
UserAlreadyRemovedException,
SpecificUserAlreadyRemovedException,
DeletionNotSupportedException

Deletes user. If forceDelete is true, then removes also associated members.

Parameters:

perunSession -

user -

forceDelete - if true, deletes also all members if they are assigned to the user

Throws:

InternalErrorException

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 at this instance

filterOnlyAllowedAttributes

RichUser filterOnlyAllowedAttributes(PerunSession sess,
 RichUser richUser)

For richUser filter all his user attributes and remove all which principal has no access to.

Parameters:

sess -

richUser -

Returns:

richUser with only allowed attributes

Throws:

InternalErrorException

filterOnlyAllowedAttributes

List<RichUser> filterOnlyAllowedAttributes(PerunSession sess,
 List<RichUser> richUsers)

For list of richUser filter all their user attributes and remove all which principal has no access to.

Parameters:

sess -

richUsers -

Returns:

list of RichUsers with only allowed attributes

Throws:

InternalErrorException

filterOnlyAllowedAttributesForRichUserExtSources

List<RichUserExtSource> filterOnlyAllowedAttributesForRichUserExtSources(PerunSession sess,
 List<RichUserExtSource> richUserExtSources)

From given list of RichUserExtSource removes the attributes which are not allowed for the current principal. The attributes are removed from the given list and the list is also returned.

Parameters:

sess - session

richUserExtSources - richUserExtSources to be filtered

Returns:

list of filtered richUserExtSources

findRichUsers

List<RichUser> findRichUsers(PerunSession sess,
 String searchString)
                      throws UserNotExistsException

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

findRichUsersByExactMatch

List<RichUser> findRichUsersByExactMatch(PerunSession sess,
 String searchString)
                                  throws UserNotExistsException

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 -

Returns:

list of richusers

Throws:

InternalErrorException

UserNotExistsException

findRichUsersWithAttributes

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

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

Parameters:

sess -

searchString -

attrNames -

Returns:

list of RichUsers

Throws:

InternalErrorException

UserNotExistsException

findRichUsersWithAttributesByExactMatch

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

Returns list of RichUsers with selected 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

Throws:

InternalErrorException

UserNotExistsException

findRichUsersWithoutSpecificVoWithAttributes

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

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 RichUser

Throws:

InternalErrorException

UserNotExistsException

findUsers

List<User> findUsers(PerunSession sess,
 String searchString)

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

Parameters:

sess -

searchString -

Returns:

list of users

Throws:

InternalErrorException

findUsersByExactName

List<User> findUsersByExactName(PerunSession sess,
 String searchString)

Returns list of users who exactly matches the searchString

Parameters:

sess -

searchString -

Returns:

list of users

Throws:

InternalErrorException

findUsersByName

List<User> findUsersByName(PerunSession sess,
 String searchString)

Returns list of users who matches the searchString

Parameters:

sess -

searchString -

Returns:

list of users

Throws:

InternalErrorException

findUsersByName

List<User> findUsersByName(PerunSession sess,
 String titleBefore,
 String firstName,
 String middleName,
 String lastName,
 String titleAfter)

Returns list of users who matches the fields.

Parameters:

sess -

titleBefore -

firstName -

middleName -

lastName -

titleAfter -

Returns:

list of users

Throws:

InternalErrorException

findUsersWithExtSourceAttributeValueEnding

List<User> findUsersWithExtSourceAttributeValueEnding(PerunSessionImpl sess,
 String attributeName,
 String valueEnd,
 List<String> excludeValueEnds)
                                               throws AttributeNotExistsException

Finds users with UserExtSource with attribute value that ends with specified string but not with specified exclude strings. This method is written to find all users with schacHomeOrganization domains ending with valueEnd, but not with exludeValueEnds.

Parameters:

sess - session

attributeName - UserExtSource attribute name

valueEnd - required attribute value ending

excludeValueEnds - exclude these attribute value endings

Returns:

list of users

Throws:

AttributeNotExistsException

generateAccount

Map<String,String> generateAccount(PerunSession session,
 String namespace,
 Map<String,String> parameters)
                            throws 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

PasswordStrengthException - When password doesn't match expected strength by namespace configuration

getActiveUserExtSources

List<UserExtSource> getActiveUserExtSources(PerunSession sess,
 User user)

Get all users userExtSources with last_access not older than (now - m), where 'm' is number of months defined in CONSTANT in UsersManagerImpl.

Parameters:

sess -

user - user to get extSources for

Returns:

list of active user extSources (not older than now - m)

Throws:

InternalErrorException

getAllBlockedLoginsInNamespaces

List<BlockedLogin> getAllBlockedLoginsInNamespaces(PerunSession sess)

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

getAllRichUsers

List<RichUser> getAllRichUsers(PerunSession sess,
 boolean includedSpecificUsers)

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

Parameters:

sess -

includedSpecificUsers - true or false if you want or dont want get specificUsers too

Returns:

list of RichUsers

Throws:

InternalErrorException

getAllRichUsersWithAttributes

List<RichUser> getAllRichUsersWithAttributes(PerunSession sess,
 boolean includedSpecificUsers)
                                      throws 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

UserNotExistsException

getAllRichUsersWithAttributes

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

Get User to RichUser with attributes.

Parameters:

sess -

includedSpecificUsers -

attrsNames -

Returns:

Throws:

InternalErrorException

UserNotExistsException

getAllUserExtSourcesByTypeAndLogin

List<UserExtSource> getAllUserExtSourcesByTypeAndLogin(PerunSession sess,
 String extType,
 String extLogin)

Gets list of all users external sources by specific type and extLogin.

Parameters:

sess -

extType - - type of extSource (ex. 'IDP')

extLogin - - extLogin of userExtSource

Returns:

list of userExtSources with type and login, empty list if no such userExtSource exists

Throws:

InternalErrorException

getAllowedResources

List<Resource> getAllowedResources(PerunSession sess,
 Facility facility,
 User user)

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

Parameters:

sess -

facility -

user -

Returns:

list of resources which have the user access on

Throws:

InternalErrorException

getAllowedResources

List<Resource> getAllowedResources(PerunSession sess,
 User user)

Get all resources which have the user access on.

Parameters:

sess -

user -

Returns:

list of resources which have the user access on

getAssignedResources

List<Resource> getAssignedResources(PerunSession sess,
 Facility facility,
 User user)

Get all resources from the facility where the user is assigned.

Parameters:

sess -

facility -

user -

Returns:

list of resources which have the user access on

getAssignedResources

List<Resource> getAssignedResources(PerunSession sess,
 User user)

Get all resources where the user is assigned.

Parameters:

sess -

user -

Returns:

list of resources which have the user access on

getAssignedRichResources

List<RichResource> getAssignedRichResources(PerunSession sess,
 User user)

Get all rich resources where the user is assigned.

Parameters:

sess -

user -

Returns:

list of rich resources which have the user access on

getAssociatedResources

List<Resource> getAssociatedResources(PerunSession sess,
 Facility facility,
 User user)

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

getAssociatedResources

List<Resource> getAssociatedResources(PerunSession sess,
 User user)

Get all resources with which user can be associated (similar to assigned resources, but does not require ACTIVE group-resource assignment).

Parameters:

sess -

user -

Returns:

list of resources with which the user is associated

getBlockedLoginsPage

Paginated<BlockedLogin> getBlockedLoginsPage(PerunSession sess,
 BlockedLoginsPageQuery query)

Get page of blocked logins.

Parameters:

sess - session

query - query with page information

Returns:

page of requested blocked logins

getGroupsWhereUserIsActive

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

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

getGroupsWhereUserIsActive

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

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

getGroupsWhereUserIsAdmin

List<Group> getGroupsWhereUserIsAdmin(PerunSession perunSession,
 User user)

Returns list of Groups in Perun, 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:

perunSession -

user -

Returns:

list of Groups, where user or some of his groups is an Administrator

Throws:

InternalErrorException

getGroupsWhereUserIsAdmin

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.

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

getIdOfBlockedLogin

int getIdOfBlockedLogin(PerunSession sess,
 String login,
 String namespace)

Return ID of blocked login

Parameters:

sess - session

login - login

namespace - namespace

Returns:

id of login blocked in specified namespace

getPasswordManagerModule

PasswordManagerModule getPasswordManagerModule(PerunSession session,
 String namespace)

Returns password manager module for specified login-namespace or falls back on generic password manager module. Throws exception if no module implementation is found or it can't be instantiated.

Parameters:

session - session with authz

namespace - specific namespace

Returns:

Password manager module for namespace or 'generic' module.

Throws:

InternalErrorException - When module instantiation fails or no module implementation is found by class loader.

getPendingPreferredEmailChanges

List<String> getPendingPreferredEmailChanges(PerunSession sess,
 User user)
                                      throws 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

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

getReservedLoginsByApp

List<Pair<String,String>> getReservedLoginsByApp(PerunSession sess,
 int appId)

Gets reserved logins which are used in the given application.

Parameters:

sess -

appId -

Returns:

list of logins (Pair: left - namespace, right - login)

getReservedLoginsOnlyByGivenApp

List<Pair<String,String>> getReservedLoginsOnlyByGivenApp(PerunSession sess,
 int appId)

Gets reserved logins which can be deleted - they are used only in the given application.

Parameters:

sess -

appId -

Returns:

list of logins (Pair: left - namespace, right - login)

getRichUser

RichUser getRichUser(PerunSession sess,
 User user)

Get User to RichUser without attributes.

Parameters:

sess -

user -

Returns:

Throws:

InternalErrorException

getRichUserExtSources

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

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:

sess - session

user - user for who should be the data returned

attrsNames - list of attribute names that should be found, if null or empty return all

Returns:

list of user's external sources with attributes

Throws:

InternalErrorException - internal error

getRichUserWithAttributes

RichUser getRichUserWithAttributes(PerunSession sess,
 User user)
                            throws UserNotExistsException

Get User to RichUser with attributes.

Parameters:

sess -

user -

Returns:

Throws:

InternalErrorException

UserNotExistsException

getRichUsersByIds

List<RichUser> getRichUsersByIds(PerunSession sess,
 List<Integer> ids)

Returns rich users without attributes by their ids.

Parameters:

sess -

ids -

Returns:

list of rich users with specified ids

Throws:

InternalErrorException

getRichUsersFromListOfUsers

List<RichUser> getRichUsersFromListOfUsers(PerunSession sess,
 List<User> users)

From Users makes RichUsers without attributes.

Parameters:

sess -

users - users to convert

Returns:

list of richUsers

Throws:

InternalErrorException

getRichUsersWithAttributesByIds

List<RichUser> getRichUsersWithAttributesByIds(PerunSession sess,
 List<Integer> ids)
                                        throws UserNotExistsException

Returns rich users with attributes by their ids.

Parameters:

sess -

ids -

Returns:

list of rich users with specified ids

Throws:

InternalErrorException

UserNotExistsException

getRichUsersWithAttributesFromListOfUsers

List<RichUser> getRichUsersWithAttributesFromListOfUsers(PerunSession sess,
 List<User> users)
                                                  throws UserNotExistsException

From Users makes RichUsers with attributes.

Parameters:

sess -

users - users to convert

Returns:

list of richUsers

Throws:

InternalErrorException

UserNotExistsException

getRichUsersWithoutVoAssigned

List<RichUser> getRichUsersWithoutVoAssigned(PerunSession sess)
                                      throws UserNotExistsException

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

UserNotExistsException

getRichUsersWithoutVoWithAttributes

List<RichUser> getRichUsersWithoutVoWithAttributes(PerunSession sess,
 List<String> attrsName)
                                            throws UserNotExistsException

Return list of RichUsers which are not members of any VO and contain selected attributes.

Parameters:

sess -

attrsName -

Returns:

list of RichUsers

Throws:

InternalErrorException

UserNotExistsException

getSpecificUsers

List<User> getSpecificUsers(PerunSession sess)

Return all specific Users (only specific users)

Parameters:

sess -

Returns:

list of all specific users in perun

Throws:

InternalErrorException

getSpecificUsersByUser

List<User> getSpecificUsersByUser(PerunSession sess,
 User user)

Return all specificUsers who are owned by the user and their ownership is not in status disabled

Parameters:

sess -

user - the user

Returns:

list of specific users who are owned by the user

Throws:

InternalErrorException

getSponsors

List<User> getSponsors(PerunSession sess,
 Member sponsoredMember)

Gets list of users that sponsor the member.

Parameters:

sess - perun session

sponsoredMember - member which is sponsored

Returns:

list of users that sponsor the member.

Throws:

InternalErrorException

getSponsorsForSponsoredMembersInVo

Map<Integer,List<Pair<User,Sponsorship>>> getSponsorsForSponsoredMembersInVo(PerunSession sess,
 int voId)

Retrieves a map, that maps the ids of the sponsored members in the given VO to a list of their Sponsors with the corresponding Sponsorship objects.

Parameters:

sess - perun session

voId - id of a vo for whose members to retrieve the sponsors

Returns:

Map of memberIds in the Vo with Lists of Pairs of their Sponsor and Sponsorship objects

getUserByExtSourceInformation

User getUserByExtSourceInformation(PerunSession sess,
 PerunPrincipal principal)
                            throws UserExtSourceNotExistsException,
UserNotExistsException,
ExtSourceNotExistsException

Get user by principal's additional identifiers or extSourceName and extSourceLogin. Additional identifiers are used in case principal's extSource was send through proxy which has enabled multiple identifiers. extSourceName and extSourceLogin are used otherwise.

Parameters:

sess -

principal -

Returns:

Throws:

UserExtSourceNotExistsException

UserNotExistsException

ExtSourceNotExistsException

getUserByExtSourceNameAndExtLogin

User getUserByExtSourceNameAndExtLogin(PerunSession sess,
 String extSourceName,
 String extLogin)
                                throws ExtSourceNotExistsException,
UserExtSourceNotExistsException,
UserNotExistsException

Get user by extSourceName and extSourceLogin

Parameters:

sess -

extSourceName -

extLogin -

Returns:

user

Throws:

ExtSourceNotExistsException

UserExtSourceNotExistsException

UserNotExistsException

InternalErrorException

getUserById

User getUserById(PerunSession perunSession,
 int id)
          throws UserNotExistsException

Returns user by his/her id.

Parameters:

perunSession -

id -

Returns:

user

Throws:

InternalErrorException

UserNotExistsException

getUserByMember

User getUserByMember(PerunSession perunSession,
 Member member)

Returns user by VO member.

Parameters:

perunSession -

member -

Returns:

user

Throws:

InternalErrorException

getUserByUserExtSource

User getUserByUserExtSource(PerunSession perunSession,
 UserExtSource userExtSource)
                     throws UserNotExistsException

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

getUserByUserExtSources

User getUserByUserExtSources(PerunSession sess,
 List<UserExtSource> userExtSources)
                      throws UserNotExistsException

Get the user based on one of the userExtSource.

Parameters:

sess -

userExtSources -

Returns:

user

Throws:

InternalErrorException

UserNotExistsException

getUserExtSourceByExtLogin

UserExtSource getUserExtSourceByExtLogin(PerunSession perunSession,
 ExtSource source,
 String extLogin)
                                  throws 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

UserExtSourceNotExistsException

getUserExtSourceById

UserExtSource getUserExtSourceById(PerunSession sess,
 int id)
                            throws UserExtSourceNotExistsException

Get the user ext source by its id.

Parameters:

sess -

id -

Returns:

user external source for the id

Throws:

InternalErrorException

UserExtSourceNotExistsException

getUserExtSourceByUniqueAttributeValue

UserExtSource getUserExtSourceByUniqueAttributeValue(PerunSession sess,
 int attrId,
 String uniqueValue)
                                              throws AttributeNotExistsException,
UserExtSourceNotExistsException

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 -

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:

InternalErrorException - if attrId or uniqueValue is in incorrect format

UserExtSourceNotExistsException - if userExtSource can't be found

AttributeNotExistsException - if attribute can't be found by it's id

getUserExtSourceByUniqueAttributeValue

UserExtSource getUserExtSourceByUniqueAttributeValue(PerunSession sess,
 String attrName,
 String uniqueValue)
                                              throws AttributeNotExistsException,
UserExtSourceNotExistsException

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 -

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:

InternalErrorException - if attrName or uniqueValue is in incorrect format

UserExtSourceNotExistsException - if userExtSource can't be found

AttributeNotExistsException - if attribute can't be found by it's name

getUserExtSourceFromMultipleIdentifiers

UserExtSource getUserExtSourceFromMultipleIdentifiers(PerunSession sess,
 PerunPrincipal principal)
                                               throws UserExtSourceNotExistsException

Iteratively searches through additional identifiers trying to find userExtSource with the same identifier. Returns first found userExtSource or throw an exception when no matching userExtSource is found.

Parameters:

sess - PerunSession to retrieve UserExtSource

principal - PerunPrincipal which contains additionalIdentifiers

Returns:

UserExtSource found using additionalIdentifiers

Throws:

UserExtSourceNotExistsException - When no matching userExtSource is found

getUserExtSources

List<UserExtSource> getUserExtSources(PerunSession perunSession,
 User user)

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

Parameters:

perunSession -

user -

Returns:

list of user's external sources

Throws:

InternalErrorException

getUserExtSourcesByIds

List<UserExtSource> getUserExtSourcesByIds(PerunSession sess,
 List<Integer> ids)

Get user ext sources by their ids.

Parameters:

sess -

ids -

Returns:

list of user external sources with specified ids

Throws:

InternalErrorException

getUsers

List<User> getUsers(PerunSession sess)

Returns all users (included specific users)

Parameters:

sess -

Returns:

list of all users

Throws:

InternalErrorException

getUsersByAttribute

List<User> getUsersByAttribute(PerunSession sess,
 Attribute attribute)

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

getUsersByAttribute

List<User> getUsersByAttribute(PerunSession sess,
 String attributeName,
 String attributeValue)

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

getUsersByAttribute

List<User> getUsersByAttribute(PerunSession sess,
 Attribute attribute,
 boolean ignoreCase)

Returns all users who have set the attribute with the value IGNORING CASE in the comparison. Searching only def and opt attributes.

Parameters:

sess -

attribute -

ignoreCase - TRUE to perform case-insensitive check

Returns:

list of users

Throws:

InternalErrorException

getUsersByAttributeValue

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.

Parameters:

sess -

attributeName -

attributeValue -

Returns:

list of users

Throws:

InternalErrorException

getUsersByExtSourceTypeAndLogin

List<User> getUsersByExtSourceTypeAndLogin(PerunSession perunSession,
 String extSourceType,
 String login)

Get all the users who have given type of the ExtSource and login.

Parameters:

perunSession - perun session

extSourceType - type of the user extSource

login - login of the user

Returns:

all users with given parameters

Throws:

InternalErrorException

getUsersByIds

List<User> getUsersByIds(PerunSession sess,
 List<Integer> usersIds)

Batch method which returns users by theirs ids.

Parameters:

sess -

usersIds -

Returns:

Throws:

InternalErrorException

getUsersByPerunBean

List<User> getUsersByPerunBean(PerunSession sess,
 Group group)

Returns list of users connected with a group

Parameters:

sess -

group -

Returns:

list of users connected with group

Throws:

InternalErrorException

getUsersByPerunBean

List<User> getUsersByPerunBean(PerunSession sess,
 Member member)

Returns list of users connected with a member

Parameters:

sess -

member -

Returns:

list of users connected with member

Throws:

InternalErrorException

getUsersByPerunBean

List<User> getUsersByPerunBean(PerunSession sess,
 Resource resource)

Returns list of users connected with a resource

Parameters:

sess -

resource -

Returns:

list of users connected with resource

Throws:

InternalErrorException

getUsersByPerunBean

List<User> getUsersByPerunBean(PerunSession sess,
 Host host)

Returns list of users connected with a host

Parameters:

sess -

host -

Returns:

list of users connected with host

Throws:

InternalErrorException

getUsersByPerunBean

List<User> getUsersByPerunBean(PerunSession sess,
 Facility facility)

Returns list of users connected with a facility

Parameters:

sess -

facility -

Returns:

list of users connected with facility

Throws:

InternalErrorException

getUsersByPerunBean

List<User> getUsersByPerunBean(PerunSession sess,
 Vo vo)

Returns list of users connected with a vo

Parameters:

sess -

vo -

Returns:

list of users connected with vo

Throws:

InternalErrorException

getUsersBySpecificUser

List<User> getUsersBySpecificUser(PerunSession sess,
 User specificUser)

Return all users who owns the specificUser and their ownership is not in status disabled

Parameters:

sess -

specificUser - the specific User

Returns:

list of user who owns the specificUser

Throws:

InternalErrorException

getUnanonymizedUsersBySpecificUser

List<User> getUnanonymizedUsersBySpecificUser(PerunSession sess,
 User specificUser)

Return all users who owns the specificUser, their ownership is not in status disabled and are not anonymized

Parameters:

sess -

specificUser - the specific User

Returns:

list of user who owns the specificUser

Throws:

InternalErrorException

getUsersCount

int getUsersCount(PerunSession perunSession)

Get count of all users.

Parameters:

perunSession -

Returns:

count of all users

Throws:

InternalErrorException

getUsersPage

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

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

getUsersReservedLogins

List<Pair<String,String>> getUsersReservedLogins(PerunSession sess,
 User user)

Return list of all reserved logins for specific user (pair is namespace and login)

Parameters:

user - for which get reserved logins

Returns:

list of pairs namespace and login

getUsersWithoutSpecificVo

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.

Parameters:

sess -

vo -

searchString -

Returns:

list of users

Throws:

InternalErrorException

getUsersWithoutVoAssigned

List<User> getUsersWithoutVoAssigned(PerunSession sess)

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

getVosWhereUserIsAdmin

List<Vo> getVosWhereUserIsAdmin(PerunSession perunSession,
 User user)

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

getVosWhereUserIsMember

List<Vo> getVosWhereUserIsMember(PerunSession perunSession,
 User user)

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

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 or is not allowed.

isLoginBlocked

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. Globally banned logins are ALWAYS case-insensitive (ignoreCase value is not taken into account for them).

Parameters:

sess -

login - login to check

ignoreCase -

Returns:

true if login is blocked

isLoginBlockedForNamespace

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

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 -

login - login to check

namespace - namespace for login

ignoreCase -

Returns:

true if login is blocked for given namespace (or globally for null namespace)

isLoginBlockedGlobally

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 Globally banned logins are ALWAYS case-insensitive.

Parameters:

sess -

login - login to check

Returns:

true if login is blocked globally

isUserAnonymized

boolean isUserAnonymized(PerunSession sess,
 User user)

Checks whether user has been anonymized or not.

Parameters:

sess -

user -

Returns:

true if user has been anonymized, false otherwise.

isUserPerunAdmin

@Deprecated
boolean isUserPerunAdmin(PerunSession sess,
 User user)

Deprecated.

Returns true if the user is PERUNADMIN.

Parameters:

sess -

user -

Returns:

true if the user is PERUNADMIN, false otherwise.

Throws:

InternalErrorException

loginExist

boolean loginExist(PerunSession sess,
 User user,
 String loginNamespace)

Checks if login exists in given login-namespace.

Parameters:

sess - perunSession

user -

loginNamespace -

Returns:

True if login for user exists in given namespace, false otherwise

moveUserExtSource

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

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

removeAllUserExtSources

void removeAllUserExtSources(PerunSession sess,
 User user)

Removes all user's external sources. It also means removing all it's attributes.

Parameters:

sess - session

user - owner of external sources

Throws:

InternalErrorException

removeSpecificUserOwner

void removeSpecificUserOwner(PerunSession sess,
 User user,
 User specificUser)
                      throws RelationNotExistsException,
SpecificUserOwnerAlreadyRemovedException

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

Parameters:

sess -

user - the user

specificUser - the specificUser

Throws:

InternalErrorException

RelationNotExistsException - if there is no such user (the user) to remove

SpecificUserOwnerAlreadyRemovedException - if there are 0 rows affected by deleting from DB

removeSpecificUserOwner

void removeSpecificUserOwner(PerunSession sess,
 User user,
 User specificUser,
 boolean forceDelete)
                      throws RelationNotExistsException,
SpecificUserOwnerAlreadyRemovedException

Remove specificUser owner (the user). If forceDelete false, only disable ownership of user and specificUser. If forceDelete true, delete this ownership from DB.

Parameters:

sess -

user - the user

specificUser - the specificUser

forceDelete - if true, remove from database, if false, only disable this ownership

Throws:

InternalErrorException

RelationNotExistsException - if there is no such user (the user) to remove

SpecificUserOwnerAlreadyRemovedException - if there are 0 rows affected by deleting from DB

removeUserExtSource

void removeUserExtSource(PerunSession perunSession,
 User user,
 UserExtSource userExtSource)
                  throws UserExtSourceAlreadyRemovedException

Removes user's external sources. It also means removing all it's attributes.

Parameters:

perunSession -

user -

userExtSource -

Throws:

InternalErrorException

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)

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:preferredEmail)

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

reservePassword

void reservePassword(PerunSession sess,
 String userLogin,
 String loginNamespace,
 String password)
              throws PasswordCreationFailedException,
PasswordOperationTimeoutException,
PasswordStrengthFailedException,
InvalidLoginException,
PasswordStrengthException

Reserves the password in external system. User must not exists.

Parameters:

sess -

userLogin - string representation of the userLogin

loginNamespace -

password -

Throws:

InternalErrorException

PasswordCreationFailedException

InvalidLoginException - When login of user has invalid syntax (is not allowed)

PasswordStrengthException - When password doesn't match expected strength by namespace configuration

PasswordOperationTimeoutException

PasswordStrengthFailedException

reservePassword

void reservePassword(PerunSession sess,
 User user,
 String loginNamespace,
 String password)
              throws PasswordCreationFailedException,
LoginNotExistsException,
PasswordOperationTimeoutException,
PasswordStrengthFailedException,
InvalidLoginException,
PasswordStrengthException

Reserves the password in external system. User must exists. User's login for specified namespace must exist in Perun.

Parameters:

sess -

user -

loginNamespace -

password -

Throws:

InternalErrorException

PasswordCreationFailedException

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

PasswordOperationTimeoutException

PasswordStrengthFailedException

reserveRandomPassword

void reserveRandomPassword(PerunSession sess,
 User user,
 String loginNamespace)
                    throws PasswordCreationFailedException,
LoginNotExistsException,
PasswordOperationTimeoutException,
PasswordStrengthFailedException,
InvalidLoginException

Reserves random password in external system. User must exists. User's login for specified namespace must exist in Perun.

Parameters:

sess -

user -

loginNamespace -

Throws:

InternalErrorException

PasswordCreationFailedException

LoginNotExistsException - When user doesn't have login in specified namespace

InvalidLoginException - When login of user has invalid syntax (is not allowed)

PasswordOperationTimeoutException

PasswordStrengthFailedException

setLogin

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

Parameters:

sess -

user -

loginNamespace -

login -

Throws:

InternalErrorException

setSpecificUser

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

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

specificUserOwnershipExists

boolean specificUserOwnershipExists(PerunSession sess,
 User user,
 User specificUser)

Return true if ownership of user and specificUser already exists. Return false if not.

Looking for enabled and also for disabled ownership.

Parameters:

sess -

user -

specificUser -

Returns:

Throws:

InternalErrorException

unblockLogins

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

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

Parameters:

sess -

logins - logins list of logins to be unblocked

namespace - namespace where the logins should be unblocked (null means unblock the logins globally)

Throws:

LoginIsNotBlockedException

unblockLoginsById

void unblockLoginsById(PerunSession sess,
 List<Integer> loginIds)
                throws LoginIsNotBlockedException

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

Parameters:

sess - session

loginIds - list of login ids

Throws:

LoginIsNotBlockedException - when login is not blocked

unblockLoginsForNamespace

void unblockLoginsForNamespace(PerunSession sess,
 String namespace)

Unblock all logins for given namespace

Parameters:

sess - PerunSession

namespace - Namespace or null for globally blocked

unsetSpecificUser

User unsetSpecificUser(PerunSession sess,
 User specificUser,
 SpecificUserType specificUserType)
                throws 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

ServiceOnlyRoleAssignedException - when trying to unset service flag from a user with service only role

updateNameTitles

User updateNameTitles(PerunSession perunSession,
 User user)
               throws UserNotExistsException

Updates titles before/after users name.

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 - if user not exists when method trying to update him

updateUser

User updateUser(PerunSession perunSession,
 User user)
         throws UserNotExistsException

Updates users data in DB.

Parameters:

perunSession -

user -

Returns:

updated user

Throws:

InternalErrorException

UserNotExistsException - if user not exists when method trying to update him

updateUserExtSource

UserExtSource updateUserExtSource(PerunSession perunSession,
 UserExtSource userExtSource)
                           throws UserExtSourceExistsException

Updates user's userExtSource in DB.

Parameters:

perunSession -

userExtSource -

Returns:

updated userExtSource

Throws:

InternalErrorException

UserExtSourceExistsException - When UES with same login/extSource already exists.

updateUserExtSourceLastAccess

void updateUserExtSourceLastAccess(PerunSession perunSession,
 UserExtSource userExtSource)

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

userExtSourceExists

boolean userExtSourceExists(PerunSession sess,
 UserExtSource userExtSource)

validatePassword

void validatePassword(PerunSession sess,
 String userLogin,
 String loginNamespace)
               throws PasswordCreationFailedException,
InvalidLoginException

Validates the password in external system and sets user extSources and extSource related attributes. User must not exists.

Parameters:

sess -

userLogin - string representation of the userLogin

loginNamespace -

Throws:

InternalErrorException

PasswordCreationFailedException

InvalidLoginException - When login of user has invalid syntax (is not allowed)

validatePassword

void validatePassword(PerunSession sess,
 User user,
 String loginNamespace)
               throws PasswordCreationFailedException,
LoginNotExistsException,
InvalidLoginException

Validates the password in external system and sets user extSources and extSource related attributes. User must exists. User's login for specified namespace must exist in Perun.

Parameters:

sess -

user -

loginNamespace -

Throws:

InternalErrorException

PasswordCreationFailedException

LoginNotExistsException - When user doesn't have login in specified namespace

InvalidLoginException - When login of user has invalid syntax (is not allowed)

validatePreferredEmailChange

String validatePreferredEmailChange(PerunSession sess,
 User user,
 UUID token)
                             throws WrongAttributeValueException,
WrongAttributeAssignmentException,
AttributeNotExistsException,
WrongReferenceAttributeValueException

Validate change of user's preferred email address. New email address is set as value of urn:perun:user:attribute-def:def:preferredEmail 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

WrongAttributeValueException - If new email address is in wrong format

WrongAttributeAssignmentException

AttributeNotExistsException - If user:preferredEmail attribute doesn't exists.

WrongReferenceAttributeValueException

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 PersonalDataChangeNotEnabledException,
UserExtSourceNotExistsException

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

Parameters:

sess - session

user - user

newOrganizationName - new organization name

Throws:

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 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:

PersonalDataChangeNotEnabledException - If change of organization to custom organization is not enabled.

changeName

void changeName(PerunSession sess,
 User user,
 String newUserName)
         throws 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:

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 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:

PersonalDataChangeNotEnabledException - If change of user's name to custom name is not enabled.

changeEmail

void changeEmail(PerunSession sess,
 User user,
 String newEmail)
          throws PersonalDataChangeNotEnabledException,
UserExtSourceNotExistsException

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

Parameters:

sess - session

user - user

newEmail - new email

Throws:

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 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:

PersonalDataChangeNotEnabledException - If change of user's email to custom email is not enabled.