sirius.biz.jdbc.tenants

Class Tenants

java.lang.Object

sirius.biz.jdbc.tenants.Tenants

public class Tenants
extends Object

Helps for extract the current UserAccount and Tenant.

Also some boiler plate methods are provided to perform some assertions.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FRAMEWORK_TENANTS Names the framework which must be enabled to activate the tenant based user management.

Constructor Summary

Constructors

Constructor and Description
Tenants()

Method Summary

Modifier and Type	Method and Description
void	assertTenantOrParentTenant(TenantAware tenantAware) Checks if the tenant aware entity belongs to the current tenant or to its parent tenant.
protected void	flushTenantChildrenCache() Flushes the cache which determines if a tenant has children or not.
<E extends SQLTenantAware> sirius.db.jdbc.SmartQuery<E>	forCurrentTenant(sirius.db.jdbc.SmartQuery<E> qry)
Optional<Tenant>	getCurrentTenant() Returns the Tenant of the current user.
Optional<UserAccount>	getCurrentUser() Returns the current user as UserAccount which is logged in.
Tenant	getRequiredTenant() Returns the tenant of the currently logged in user or throws an exception if no user is present.
UserAccount	getRequiredUser() Returns the current user or throws an exception if no user is currently available.
boolean	hasChildTenants(long tenantId) Determines if the tenant with the given ID has child tenants.
boolean	hasTenant() Determines if there is a user logged in which has a tenant.
boolean	hasUser() Determines if there is currently a user logged in.

Methods inherited from class java.lang.Object

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

Field Detail

FRAMEWORK_TENANTS

public static final String FRAMEWORK_TENANTS

Names the framework which must be enabled to activate the tenant based user management.

See Also:

Constant Field Values

Constructor Detail

Tenants

public Tenants()

Method Detail

getCurrentUser

@Nonnull
public Optional<UserAccount> getCurrentUser()

Returns the current user as UserAccount which is logged in.

Returns:

the current user wrapped as Optional or an empty optional, if no user is logged in.

getRequiredUser

@Nonnull
public UserAccount getRequiredUser()

Returns the current user or throws an exception if no user is currently available.

Returns:

the currently logged in user

hasUser

public boolean hasUser()

Determines if there is currently a user logged in.

Returns:

true if a user is present, false otherwise

getCurrentTenant

@Nonnull
public Optional<Tenant> getCurrentTenant()

Returns the Tenant of the current user.

Returns:

the tenant of the current user wrapped as Optional or an empty optional, if no user is logged in.

getRequiredTenant

@Nonnull
public Tenant getRequiredTenant()

Returns the tenant of the currently logged in user or throws an exception if no user is present.

Returns:

the tenant of the currently logged in user

hasTenant

public boolean hasTenant()

Determines if there is a user logged in which has a tenant.

Returns:

true if there is a user with a known tenant currently logged in

hasChildTenants

public boolean hasChildTenants(long tenantId)

Determines if the tenant with the given ID has child tenants.

This call utilizes a cache, therefore a lookup if quite fast and cheap.

Parameters:

tenantId - the id of the tenant to check if there are children

Returns:

true if the given tenant has children, false if there are no children, or if the tenant id is unknown.

flushTenantChildrenCache

protected void flushTenantChildrenCache()

Flushes the cache which determines if a tenant has children or not.

assertTenantOrParentTenant

public void assertTenantOrParentTenant(TenantAware tenantAware)

Checks if the tenant aware entity belongs to the current tenant or to its parent tenant.

Parameters:

tenantAware - TenantAware entity to be asserted

forCurrentTenant

public <E extends SQLTenantAware> sirius.db.jdbc.SmartQuery<E> forCurrentTenant(sirius.db.jdbc.SmartQuery<E> qry)