sirius.biz.jdbc.tenants

Class TenantController

java.lang.Object

sirius.web.controller.BasicController

sirius.biz.web.BizController

sirius.biz.jdbc.tenants.TenantController

All Implemented Interfaces:

sirius.web.controller.Controller

public class TenantController
extends BizController

Provides a GUI for managing tenants.

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_TENANTS Contains the permission required to manage tenants.

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
TenantController()

Method Summary

Modifier and Type	Method and Description
void	deleteTenant(sirius.web.http.WebContext ctx, String tenantId) Deletes the given tenant and returns the list of tenants.
String	getPermissionDescription(String role) Returns a translated description of the given permission.
String	getPermissionName(String role) Returns a translated name of the given permission.
List<String>	getPermissions() Returns all available features which can be assigned to a tenant.
void	selectTenant(sirius.web.http.WebContext ctx, String id) Makes the current user belong to the given tenant.
void	selectTenants(sirius.web.http.WebContext ctx) Lists all tenants which the current user can "become" (switch to).
void	tenant(sirius.web.http.WebContext ctx, String tenantId) Provides an editor for updating a tenant.
void	tenantConfig(sirius.web.http.WebContext ctx, String tenantId) Provides an editor for changing the config of a tenant.
void	tenants(sirius.web.http.WebContext ctx) Lists all tenants known to the system.
void	tenantUpdate(sirius.web.http.WebContext ctx, sirius.web.services.JSONStructuredOutput out, String tenantId) Provides a JSON API to change the settings of a tenant, including its configuration.

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_TENANTS

public static final String PERMISSION_MANAGE_TENANTS

Contains the permission required to manage tenants.

See Also:

Constant Field Values

Constructor Detail

TenantController

public TenantController()

Method Detail

getPermissions

public List<String> getPermissions()

Returns all available features which can be assigned to a tenant.

Returns:

an unmodifyable list of all features available.

getPermissionName

public String getPermissionName(String role)

Returns a translated name of the given permission.

Parameters:

role - the permission or feature to translate

Returns:

a translated name for the permission

getPermissionDescription

public String getPermissionDescription(String role)

Returns a translated description of the given permission.

Parameters:

role - the permission for which a description is requested

Returns:

the translated description of the permission

tenants

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

Lists all tenants known to the system.

Parameters:

ctx - the current request

tenant

public void tenant(sirius.web.http.WebContext ctx,
                   String tenantId)

Provides an editor for updating a tenant.

Parameters:

ctx - the current request

tenantId - the id of the tenant to change

tenantUpdate

public void tenantUpdate(sirius.web.http.WebContext ctx,
                         sirius.web.services.JSONStructuredOutput out,
                         String tenantId)

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

Parameters:

ctx - the current request

out - the JSON response being generated

tenantId - the id of the tenant to update

tenantConfig

public void tenantConfig(sirius.web.http.WebContext ctx,
                         String tenantId)

Provides an editor for changing the config of a tenant.

Parameters:

ctx - the current request

tenantId - the id of the tenant to change

deleteTenant

public void deleteTenant(sirius.web.http.WebContext ctx,
                         String tenantId)

Deletes the given tenant and returns the list of tenants.

Parameters:

ctx - the current request

tenantId - the id of the tenant to delete

selectTenants

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

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

Parameters:

ctx - the current request

selectTenant

public void selectTenant(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