sirius.biz.web

Class BizController

java.lang.Object

sirius.web.controller.BasicController

sirius.biz.web.BizController

All Implemented Interfaces:

sirius.web.controller.Controller

Direct Known Subclasses:

AuditLogController, CodeListController, IncidentController, JobsController, JournalController, LogController, MailController, ProfileController, SAMLController, StorageController, TenantController, UserAccountController

public class BizController
extends sirius.web.controller.BasicController

Base class for all controllers which operate on entities.

Provides glue logic for filling entites from WebContexts and for resolving entities for a given id.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BizController.SaveHelper Provides a fluent API to control the process and user routing while creating or updating an entity in the database.

Field Summary

Fields

Modifier and Type	Field and Description
protected sirius.db.es.Elastic	elastic
static sirius.kernel.health.Log	LOG Contains the central logger for biz-relatet messages.
protected sirius.db.mongo.Mango	mango
protected sirius.db.mixing.Mixing	mixing
protected sirius.db.jdbc.OMA	oma
protected Tenants	tenants

Fields inherited from class sirius.web.controller.BasicController

defaultRoute

Constructor Summary

Constructors

Constructor and Description
BizController()

Method Summary

Modifier and Type	Method and Description
protected void	assertNotNew(sirius.db.mixing.BaseEntity<?> obj) Ensures that the given entity is already persisted in the database.
protected void	assertTenant(TenantAware tenantAware) Ensures that the tenant of the current user matches the tenant of the given entity.
protected <E extends sirius.db.mixing.BaseEntity<?>> E	find(Class<E> type, String id) Tries to find an entity of the given type with the given id.
protected <E extends sirius.db.mixing.BaseEntity<?>> E	findForTenant(Class<E> type, String id) Tries to find an entity for the given id, which belongs to the current tenant.
protected String	getBaseUrl() Returns the base URL of this instance.
protected void	load(sirius.web.http.WebContext ctx, sirius.db.mixing.BaseEntity<?> entity) Fetches all autoloaded fields of the given entity from the given request and populates the entity.
protected void	load(sirius.web.http.WebContext ctx, sirius.db.mixing.BaseEntity<?> entity, List<sirius.db.mixing.Mapping> properties)
protected void	load(sirius.web.http.WebContext ctx, sirius.db.mixing.BaseEntity<?> entity, sirius.db.mixing.Mapping... properties) Reads the given properties from the given request and populates the given entity.
protected BizController.SaveHelper	prepareSave(sirius.web.http.WebContext ctx) Creates a BizController.SaveHelper with provides a fluent API to save an entity into the database.
protected <I,E extends sirius.db.mixing.BaseEntity<I>> void	setOrVerify(sirius.db.mixing.BaseEntity<?> owner, sirius.db.mixing.types.BaseEntityRef<I,E> ref, E entity) Enusures or establishes a parent child relation.
protected <E extends sirius.db.mixing.BaseEntity<?>> Optional<E>	tryFind(Class<E> type, String id) Tries to find an existing entity with the given id.
protected <E extends sirius.db.mixing.BaseEntity<?>> Optional<E>	tryFindForTenant(Class<E> type, String id) Tries to find an entity for the given id, which belongs to the current tenant.
protected void	validate(sirius.db.mixing.BaseEntity<?> entity) Performs a validation and reports all warnings via the UserContext.

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

mixing

protected sirius.db.mixing.Mixing mixing

oma

protected sirius.db.jdbc.OMA oma

mango

protected sirius.db.mongo.Mango mango

elastic

protected sirius.db.es.Elastic elastic

tenants

protected Tenants tenants

LOG

public static final sirius.kernel.health.Log LOG

Contains the central logger for biz-relatet messages.

Constructor Detail

BizController

public BizController()

Method Detail

assertTenant

protected void assertTenant(TenantAware tenantAware)

Ensures that the tenant of the current user matches the tenant of the given entity.

Parameters:

tenantAware - the entity to check

Throws:

sirius.kernel.health.HandledException - if the tenants do no match

setOrVerify

protected <I,E extends sirius.db.mixing.BaseEntity<I>> void setOrVerify(sirius.db.mixing.BaseEntity<?> owner,
                                                                        sirius.db.mixing.types.BaseEntityRef<I,E> ref,
                                                                        E entity)

Enusures or establishes a parent child relation.

For new entities (owner), the given reference is initialized with the given entity. For existing entities it is verified, that the given reference points to the given entity.

Type Parameters:

E - the generic type the the entity being referenced

Parameters:

owner - the entity which contains the reference

ref - the reference which is either filled or verified that it points to entity

entity - the entity the reference must point to

Throws:

sirius.kernel.health.HandledException - if the entities do no match

assertNotNew

protected void assertNotNew(sirius.db.mixing.BaseEntity<?> obj)

Ensures that the given entity is already persisted in the database.

Parameters:

obj - the entity to check

Throws:

sirius.kernel.health.HandledException - if the entity is still new and not yet persisted in the database

getBaseUrl

protected String getBaseUrl()

Returns the base URL of this instance.

Returns:

the base URL like http://www.mydomain.stuff

load

protected void load(sirius.web.http.WebContext ctx,
                    sirius.db.mixing.BaseEntity<?> entity)

Fetches all autoloaded fields of the given entity from the given request and populates the entity.

Parameters:

ctx - the request to read parameters from

entity - the entity to fill

See Also:

Autoloaded

load

protected void load(sirius.web.http.WebContext ctx,
                    sirius.db.mixing.BaseEntity<?> entity,
                    sirius.db.mixing.Mapping... properties)

Reads the given properties from the given request and populates the given entity.

Parameters:

ctx - the request to read parameters from

entity - the entity to fill

properties - the list of properties to transfer

load

protected void load(sirius.web.http.WebContext ctx,
                    sirius.db.mixing.BaseEntity<?> entity,
                    List<sirius.db.mixing.Mapping> properties)

prepareSave

protected BizController.SaveHelper prepareSave(sirius.web.http.WebContext ctx)

Creates a BizController.SaveHelper with provides a fluent API to save an entity into the database.

Parameters:

ctx - the current request

Returns:

a helper used to configure the save process

validate

protected void validate(sirius.db.mixing.BaseEntity<?> entity)

Performs a validation and reports all warnings via the UserContext.

Parameters:

entity - the entity to validate

find

protected <E extends sirius.db.mixing.BaseEntity<?>> E find(Class<E> type,
                                                            String id)

Tries to find an entity of the given type with the given id.

Note, if new is given as id, a new entity is created. This permits many editors to create a new entity simply by calling /editor-uri/new

Type Parameters:

E - the generic type of the entity class

Parameters:

type - the type of the entity to find

id - the id to lookup

Returns:

the requested entity or a new one, if id was new

Throws:

sirius.kernel.health.HandledException - if either the id is unknown or a new instance cannot be created

tryFind

protected <E extends sirius.db.mixing.BaseEntity<?>> Optional<E> tryFind(Class<E> type,
                                                                         String id)

Tries to find an existing entity with the given id.

Type Parameters:

E - the generic type of the entity class

Parameters:

type - the type of the entity to find

id - the id of the entity to find

Returns:

the requested entity wrapped as Optional or an empty optional, if no entity with the given id was found or if the id was new

findForTenant

protected <E extends sirius.db.mixing.BaseEntity<?>> E findForTenant(Class<E> type,
                                                                     String id)

Tries to find an entity for the given id, which belongs to the current tenant.

This behaves just like find(Class, String) but once an existing entity was found, which also extends TenantAware, it is ensured (using assertTenant(TenantAware) that it belongs to the current tenant.

Type Parameters:

E - the generic type of the entity class

Parameters:

type - the type of the entity to find

id - the id of the entity to find

Returns:

the requested entity, which is either new or belongs to the current tenant

tryFindForTenant

protected <E extends sirius.db.mixing.BaseEntity<?>> Optional<E> tryFindForTenant(Class<E> type,
                                                                                  String id)

Tries to find an entity for the given id, which belongs to the current tenant.

This behaves just like tryFind(Class, String) but once an existing entity was found, which also extends TenantAware, it is ensured (using assertTenant(TenantAware) that it belongs to the current tenant.

Type Parameters:

E - the generic type of the entity class

Parameters:

type - the type of the entity to find

id - the id of the entity to find

Returns:

the requested entity, which belongs to the current tenant, wrapped as Optional or an empty optional.