sirius.web.security

Class UserInfo

java.lang.Object

sirius.kernel.di.transformers.Composable

sirius.web.security.UserInfo

All Implemented Interfaces:

sirius.kernel.di.transformers.Transformable

public class UserInfo
extends sirius.kernel.di.transformers.Composable

Represents an user.

A user is authenticated using a UserManager. To obtain or modify the current user, use UserContext.getCurrentUser() or UserContext.setCurrentUser(UserInfo).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserInfo.Builder Builder pattern to create a new UserInfo.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	lang
static UserInfo	NOBODY Fallback user if no user is currently available.
static String	PERMISSION_LOGGED_IN This permission represents a user which was successfully authenticated by its user manager.
protected Set<String>	permissions
protected Function<UserInfo,UserSettings>	settingsSupplier
protected String	tenantId
protected String	tenantName
protected String	userId
protected String	username
protected Function<UserInfo,Object>	userSupplier

Fields inherited from class sirius.kernel.di.transformers.Composable

components

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UserInfo()

Method Summary

Modifier and Type	Method and Description
void	assertPermission(String permission) Asserts that the user has the given permission.
String	getLang() The language code of the user.
Set<String>	getPermissions() Returns a set of all permissions granted to the user.
UserSettings	getSettings() Obtains the user specific config.
String	getTenantId() The unique ID of the tenant.
String	getTenantName() The name of the tenant.
String	getUserId() Returns the unique ID of the user.
String	getUserName() Returns the login or descriptive name of the user.
<T> T	getUserObject(Class<T> clazz) Fetches the underlying user object of the given type.
boolean	hasPermission(String permission) Determines if the user has the given permission.
boolean	hasPermissions(String... permissions) Determines if the user has the requested permissions
boolean	is(Class<?> type)
boolean	isLoggedIn() Determines if the user is logged in.
protected boolean	permissionFullfilled(String permission)
protected boolean	permissionsFullfilled(String permissions)
<A> Optional<A>	tryAs(Class<A> adapterType)

Methods inherited from class sirius.kernel.di.transformers.Composable

as, attach, attach

Methods inherited from class java.lang.Object

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

Field Detail

PERMISSION_LOGGED_IN

public static final String PERMISSION_LOGGED_IN

This permission represents a user which was successfully authenticated by its user manager.

See Also:

Constant Field Values

NOBODY

public static final UserInfo NOBODY

Fallback user if no user is currently available. This user has no permissions.

tenantId

protected String tenantId

tenantName

protected String tenantName

userId

protected String userId

username

protected String username

lang

protected String lang

permissions

protected Set<String> permissions

settingsSupplier

protected Function<UserInfo,UserSettings> settingsSupplier

userSupplier

protected Function<UserInfo,Object> userSupplier

Constructor Detail

UserInfo

protected UserInfo()

Method Detail

getUserId

public String getUserId()

Returns the unique ID of the user.

Returns:

the unique ID of the user

getUserName

public String getUserName()

Returns the login or descriptive name of the user.

Returns:

the name of the user

getTenantId

@Nullable
public String getTenantId()

The unique ID of the tenant.

Returns:

the unique ID the tenant the user belongs to

getTenantName

@Nullable
public String getTenantName()

The name of the tenant.

Returns:

the name of the tenant the user belongs to

getLang

public String getLang()

The language code of the user.

Returns:

the two-letter language code of the user

hasPermissions

public boolean hasPermissions(String... permissions)

Determines if the user has the requested permissions

Parameters:

permissions - the permissions to check

Returns:

true if the user has all the requested permissions, false otherwise

hasPermission

public boolean hasPermission(String permission)

Determines if the user has the given permission.

Next to plain permission names, permissions can also negated using !permission and on top of that, whole logical expressions in DNF (disjuctive normal form)can be passed in.

Such a formula is a set of expressions where a , represents an or and a + represents an and. An example would be "logged-in,important-customer+!locked". This would translate to "the user has to be logged in or it has to be an important customer and not be locked".

Parameters:

permission - the permission to check

Returns:

true if the user has the permission, false otherwise

permissionsFullfilled

protected boolean permissionsFullfilled(String permissions)

permissionFullfilled

protected boolean permissionFullfilled(String permission)

assertPermission

public void assertPermission(String permission)

Asserts that the user has the given permission.

If the user does not have the given permission, an exception is thrown.

Parameters:

permission - the permission to check

isLoggedIn

public boolean isLoggedIn()

Determines if the user is logged in.

Returns:

true if the user has the permission PERMISSION_LOGGED_IN, false otherwise

getUserObject

@Nullable
public <T> T getUserObject(Class<T> clazz)

Fetches the underlying user object of the given type.

Type Parameters:

T - the excepted type of the user object

Parameters:

clazz - the excepted type of the user object

Returns:

the underlying user object or null if no object is present or if it has a non matching type

is

public boolean is(@Nonnull
                  Class<?> type)

Specified by:

is in interface sirius.kernel.di.transformers.Transformable

Overrides:

is in class sirius.kernel.di.transformers.Composable

tryAs

public <A> Optional<A> tryAs(@Nonnull
                             Class<A> adapterType)

Specified by:

tryAs in interface sirius.kernel.di.transformers.Transformable

Overrides:

tryAs in class sirius.kernel.di.transformers.Composable

getPermissions

public Set<String> getPermissions()

Returns a set of all permissions granted to the user.

Returns:

all permissions granted to the user.

getSettings

public UserSettings getSettings()

Obtains the user specific config.

This can be used to make parts of the system behave specific to the current scope, current tenant and user.

Returns:

the config object which contains all settings of the current scope, current tenant and user.