services.gui

Class UserService

java.lang.Object

services.gui.UserService

@Singleton
public class UserService
extends java.lang.Object

Service class mostly for Users controller. Handles everything around User.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ADMIN_NAME Default admin name; the admin user is created during first initialization of JATOS; don't confuse admin user with the Role ADMIN
static java.lang.String	ADMIN_PASSWORD Default admin password; the admin user is created during first initialization of JATOS; don't confuse admin user with the Role ADMIN
static java.lang.String	ADMIN_USERNAME Default admin username; the admin user is created during first initialization of JATOS; don't confuse admin user with the Role ADMIN

Method Summary

Modifier and Type	Method and Description
void	bindToUserAndPersist(NewUserModel newUserModel) Creates a user, sets password hash and persists him.
boolean	changeAdminRole(java.lang.String normalizedUsername, java.lang.Boolean admin) Adds or removes ADMIN role of the user with the given username and persists the change.
boolean	changeSuperuserRole(java.lang.String normalizedUsername, boolean superuser) Adds or removes SUPERUSER role of the user with the given username and persists the change.
void	createAdminIfNotExists() Check for user admin: In case the application is started the first time we need an initial user: admin.
void	createAndPersistUser(User user, java.lang.String password, boolean adminRole, User.AuthMethod authMethod) Creates a user, sets password hash and persists them.
void	removeUser(java.lang.String normalizedUsername) Removes the User belonging to the given username from the database.
User	retrieveUser(java.lang.String normalizedUsername) Retrieves the user with the given username from the DB.
void	setLastLogin(java.lang.String normalizedUsername)
void	toggleActive(java.lang.String normalizedUsername, boolean active)
void	updatePassword(User user, java.lang.String newPassword) Change password and persist user.

Methods inherited from class java.lang.Object

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

Field Detail

ADMIN_USERNAME

public static final java.lang.String ADMIN_USERNAME

Default admin username; the admin user is created during first initialization of JATOS; don't confuse admin user with the Role ADMIN

See Also:

Constant Field Values

ADMIN_PASSWORD

public static final java.lang.String ADMIN_PASSWORD

Default admin password; the admin user is created during first initialization of JATOS; don't confuse admin user with the Role ADMIN

See Also:

Constant Field Values

ADMIN_NAME

public static final java.lang.String ADMIN_NAME

Default admin name; the admin user is created during first initialization of JATOS; don't confuse admin user with the Role ADMIN

See Also:

Constant Field Values

Method Detail

retrieveUser

public User retrieveUser(java.lang.String normalizedUsername)
                  throws NotFoundException

Retrieves the user with the given username from the DB. Throws an Exception if it doesn't exist.

Throws:

NotFoundException

createAdminIfNotExists

public void createAdminIfNotExists()

Check for user admin: In case the application is started the first time we need an initial user: admin. If admin can't be found, create one.

bindToUserAndPersist

public void bindToUserAndPersist(NewUserModel newUserModel)

Creates a user, sets password hash and persists him. Creates and persists an JatosWorker for the user.

createAndPersistUser

public void createAndPersistUser(User user,
                                 java.lang.String password,
                                 boolean adminRole,
                                 User.AuthMethod authMethod)

Creates a user, sets password hash and persists them. Creates and persists an JatosWorker for the user.

updatePassword

public void updatePassword(User user,
                           java.lang.String newPassword)

Change password and persist user.

toggleActive

public void toggleActive(java.lang.String normalizedUsername,
                         boolean active)
                  throws NotFoundException,
                         ForbiddenException

Throws:

NotFoundException

ForbiddenException

changeSuperuserRole

public boolean changeSuperuserRole(java.lang.String normalizedUsername,
                                   boolean superuser)
                            throws NotFoundException,
                                   ForbiddenException

Adds or removes SUPERUSER role of the user with the given username and persists the change.

Throws:

NotFoundException

ForbiddenException

changeAdminRole

public boolean changeAdminRole(java.lang.String normalizedUsername,
                               java.lang.Boolean admin)
                        throws NotFoundException,
                               ForbiddenException

Adds or removes ADMIN role of the user with the given username and persists the change. If the parameter admin is true the ADMIN role will be set and if it's false it will be removed. Returns true if the user has the role in the end - or false if he hasn't.

Throws:

NotFoundException

ForbiddenException

setLastLogin

public void setLastLogin(java.lang.String normalizedUsername)

removeUser

public void removeUser(java.lang.String normalizedUsername)
                throws NotFoundException,
                       ForbiddenException,
                       java.io.IOException

Removes the User belonging to the given username from the database. It also removes all studies where this user is the last member (which subsequently removes all components, results and the study assets too).

Throws:

NotFoundException

ForbiddenException

java.io.IOException