sirius.biz.jdbc.tenants

Class UserAccountController

java.lang.Object

sirius.web.controller.BasicController

sirius.biz.web.BizController

sirius.biz.jdbc.tenants.UserAccountController

All Implemented Interfaces:

sirius.web.controller.Controller

public class UserAccountController
extends BizController

Provides a GUI for managing user accounts.

Nested Class Summary

Nested classes/interfaces inherited from class sirius.biz.web.BizController

BizController.SaveHelper

Field Summary

Fields

Modifier and Type	Field and Description
static String	PERMISSION_MANAGE_USER_ACCOUNTS The permission required to add, modify or delete accounts

Fields inherited from class sirius.biz.web.BizController

elastic, LOG, mango, mixing, oma, tenants

Fields inherited from class sirius.web.controller.BasicController

defaultRoute

Constructor Summary

Constructors

Constructor and Description
UserAccountController()

Method Summary

Modifier and Type	Method and Description
void	account(sirius.web.http.WebContext ctx, String accountId) Shows an editor for the given account.
void	accountConfig(sirius.web.http.WebContext ctx, String accountId) Shows an editor for the custom configuration of the given user.
void	accounts(sirius.web.http.WebContext ctx) Shows a list of all available users of the current tenant.
void	accountUpdate(sirius.web.http.WebContext ctx, sirius.web.services.JSONStructuredOutput out, String accountId) Provides a JSON API to change the settings of an account, including its configuration.
void	deleteAdmin(sirius.web.http.WebContext ctx, String id) Deletes the given account.
void	forgotPassword(sirius.web.http.WebContext ctx, sirius.web.services.JSONStructuredOutput out) Provides a JSON API which re-sends the password to the account with the given email address.
void	generatePassword(sirius.web.http.WebContext ctx, String id) Generates a new password for the given account and send a mail to the user.
String	getRoleDescription(String role) Returns a description of the role.
String	getRoleName(String role) Returns the translated name of a role.
List<String>	getRoles() Lists all roles which can be granted to a user.
void	logout(sirius.web.http.WebContext ctx) Executes a logout for the current scope.
void	selectUserAccount(sirius.web.http.WebContext ctx, String id) Makes the current user belong to the given tenant.
void	selectUserAccounts(sirius.web.http.WebContext ctx) Lists all users which the current user can "become" (switch to).
void	usersAutocomplete(sirius.web.http.WebContext ctx) Autocompletion for UserAccounts.

Methods inherited from class sirius.biz.web.BizController

assertNotNew, assertTenant, find, findForTenant, getBaseUrl, load, load, load, prepareSave, setOrVerify, tryFind, tryFindForTenant, validate

Methods inherited from class sirius.web.controller.BasicController

assertNotNull, assertPermission, fail, getUser, hasPermission, onError, showDeletedMessage, showSavedMessage

Methods inherited from class java.lang.Object

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

Field Detail

PERMISSION_MANAGE_USER_ACCOUNTS

public static final String PERMISSION_MANAGE_USER_ACCOUNTS

The permission required to add, modify or delete accounts

See Also:

Constant Field Values

Constructor Detail

UserAccountController

public UserAccountController()

Method Detail

accounts

public void accounts(sirius.web.http.WebContext ctx)

Shows a list of all available users of the current tenant.

Parameters:

ctx - the current request

account

public void account(sirius.web.http.WebContext ctx,
                    String accountId)

Shows an editor for the given account.

Parameters:

ctx - the current request

accountId - the UserAccount to edit

accountConfig

public void accountConfig(sirius.web.http.WebContext ctx,
                          String accountId)

Shows an editor for the custom configuration of the given user.

Parameters:

ctx - the current request

accountId - the id of the account which config will be edited

accountUpdate

public void accountUpdate(sirius.web.http.WebContext ctx,
                          sirius.web.services.JSONStructuredOutput out,
                          String accountId)

Provides a JSON API to change the settings of an account, including its configuration.

Parameters:

ctx - the current request

out - the JSON response being generated

accountId - the id of the account to update

getRoles

public List<String> getRoles()

Lists all roles which can be granted to a user.

Returns:

all roles which can be granted to a user

getRoleName

public String getRoleName(String role)

Returns the translated name of a role.

Parameters:

role - the role to translate

Returns:

a translated name for the given role

getRoleDescription

public String getRoleDescription(String role)

Returns a description of the role.

Parameters:

role - the role to fetch the description for

Returns:

the description of the given role

generatePassword

public void generatePassword(sirius.web.http.WebContext ctx,
                             String id)

Generates a new password for the given account and send a mail to the user.

Parameters:

ctx - the current request

id - the account for which a password is to be created

forgotPassword

public void forgotPassword(sirius.web.http.WebContext ctx,
                           sirius.web.services.JSONStructuredOutput out)

Provides a JSON API which re-sends the password to the account with the given email address.

Parameters:

ctx - the current request

out - the JSON response being generated

deleteAdmin

public void deleteAdmin(sirius.web.http.WebContext ctx,
                        String id)

Deletes the given account.

Parameters:

ctx - the current request

id - the account to delete

logout

public void logout(sirius.web.http.WebContext ctx)

Executes a logout for the current scope.

Parameters:

ctx - the current request

usersAutocomplete

public void usersAutocomplete(sirius.web.http.WebContext ctx)

Autocompletion for UserAccounts.

Only accepts UserAccounts which belong to the current Tenant.

Parameters:

ctx - the current request

selectUserAccounts

public void selectUserAccounts(sirius.web.http.WebContext ctx)

Lists all users which the current user can "become" (switch to).

Parameters:

ctx - the current request

selectUserAccount

public void selectUserAccount(sirius.web.http.WebContext ctx,
                              String id)

Makes the current user belong to the given tenant.

Parameters:

ctx - the current request

id - the id of the tenant to switch to