sirius.web.security

Class UserInfo.Builder

java.lang.Object

sirius.web.security.UserInfo.Builder

Enclosing class:

UserInfo

public static class UserInfo.Builder
extends Object

Builder pattern to create a new UserInfo.

Method Summary

Modifier and Type	Method and Description
UserInfo	build() Builds the user, with the previously given settings.
static UserInfo.Builder	createUser(String id) Creates a new builder and initializes it with an id for the user.
UserInfo.Builder	withLang(String lang) Sets the language code of the user.
UserInfo.Builder	withPermissions(Set<String> permissions) Sets the permissions granted to the user.
UserInfo.Builder	withSettingsSupplier(Function<UserInfo,UserSettings> settingsSupplier) Sets a config supplier which can provide an individual configuration for the current user.
UserInfo.Builder	withTenantId(String id) Sets the id of the tenant the user belongs to.
UserInfo.Builder	withTenantName(String name) Sets the name of the tenant the user belongs to.
UserInfo.Builder	withUsername(String name) Sets the name of the user.
UserInfo.Builder	withUserSupplier(Function<UserInfo,Object> userSupplier) Sets a user supplier which returns the underlying user object (e.g. a database entity).

Methods inherited from class java.lang.Object

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

Method Detail

createUser

@CheckReturnValue
public static UserInfo.Builder createUser(@Nonnull
                                                            String id)

Creates a new builder and initializes it with an id for the user.

Parameters:

id - the id of the user to build.

Returns:

the builder itself for fluent method calls

withUsername

public UserInfo.Builder withUsername(String name)

Sets the name of the user.

Parameters:

name - the name of the user.

Returns:

the builder itself for fluent method calls

withTenantId

public UserInfo.Builder withTenantId(String id)

Sets the id of the tenant the user belongs to.

Parameters:

id - the id of the tenant

Returns:

the builder itself for fluent method calls

withTenantName

public UserInfo.Builder withTenantName(String name)

Sets the name of the tenant the user belongs to.

Parameters:

name - the name of the tenant

Returns:

the builder itself for fluent method calls

withLang

public UserInfo.Builder withLang(String lang)

Sets the language code of the user.

Parameters:

lang - a two-letter language code which should be understood by NLS.

Returns:

the builder itself for fluent method calls

withPermissions

public UserInfo.Builder withPermissions(Set<String> permissions)

Sets the permissions granted to the user.

Parameters:

permissions - the set of permissions granted to the user

Returns:

the builder itself for fluent method calls

withSettingsSupplier

public UserInfo.Builder withSettingsSupplier(Function<UserInfo,UserSettings> settingsSupplier)

Sets a config supplier which can provide an individual configuration for the current user.

Parameters:

settingsSupplier - the function which fetches or computes the configuration for this user on demand.

Returns:

the builder itself for fluent method calls

withUserSupplier

public UserInfo.Builder withUserSupplier(Function<UserInfo,Object> userSupplier)

Sets a user supplier which returns the underlying user object (e.g. a database entity).

Parameters:

userSupplier - the function which fetches or computes the user object

Returns:

the builder itself for fluent method calls

build

public UserInfo build()

Builds the user, with the previously given settings.

Returns:

the resulting user