sirius.web.security

Class PublicUserManager

java.lang.Object

sirius.web.security.GenericUserManager

sirius.web.security.PublicUserManager

All Implemented Interfaces:

UserManager

public class PublicUserManager
extends GenericUserManager

A simple user manager which always returns the same user with a defined set of roles.

Essentially this user manager makes all functionality public accessible by always returning a user which has a defined set of roles (therefore one can of course disable some functions entirely).

This roles granted can be controlled by two config entries. One is security.publicRoles which also affects all other user managers. The other is defaultRoles which has to be defined within the scope.

Note that also trustedRoles can be defined to control roles which are only added to a trusted user (i.e. from the local network).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PublicUserManager.Factory Used to create public user managers.

Field Summary

Fields inherited from class sirius.web.security.GenericUserManager

config, defaultRoles, defaultUser, hashFunction, keepLoginEnabled, loginCookieTTL, publicRoles, scope, ssoEnabled, ssoGraceInterval, ssoSecret, trustedRoles

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PublicUserManager(ScopeInfo scope, sirius.kernel.settings.Extension config)

Method Summary

Modifier and Type	Method and Description
void	attachToSession(UserInfo user, WebContext ctx) Attaches the given user to the current session.
UserInfo	bindToRequest(WebContext ctx) Tries to find the current user in the current session or by checking the request for valid credentials
protected String	computeLang(WebContext ctx, String userId) Compues the langange code of the given user and request.
protected Set<String>	computeRoles(WebContext ctx, String userId) Tries to compute the roles for the given user and request.
protected String	computeTenantname(WebContext ctx, String tenantId) Compues the name of the given tenant and request.
protected String	computeUsername(WebContext ctx, String userId) Compues the name of the given user and request.
void	detachFromSession(UserInfo user, WebContext ctx) Removes all stored user information from the current session.
UserInfo	findUserByCredentials(WebContext ctx, String user, String password) Tries to find a user with the given credentials.
UserInfo	findUserByName(WebContext ctx, String user) Tries to find a user with the given username.
protected Object	getUserObject(UserInfo u) Resolves the given user info back into the original (underlying) user object.
boolean	isLoginSupported() Determines if a login via username and password is possible.

Methods inherited from class sirius.web.security.GenericUserManager

buildDefaultUser, computeSSOHashInput, computeSSOToken, determineRolesOfDefaultUser, extractChallengeAndResponse, findUserForRequest, findUserInSession, getScopeSettings, getSSOHashFunction, getUserSettings, isKeepLoginSupported, isUserStillValid, log, recordUserLogin, transformRoles, updateLoginCookie

Methods inherited from class java.lang.Object

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

Constructor Detail

PublicUserManager

protected PublicUserManager(ScopeInfo scope,
                            sirius.kernel.settings.Extension config)

Method Detail

bindToRequest

@Nonnull
public UserInfo bindToRequest(@Nonnull
                                       WebContext ctx)

Description copied from interface: UserManager

Tries to find the current user in the current session or by checking the request for valid credentials

Specified by:

bindToRequest in interface UserManager

Overrides:

bindToRequest in class GenericUserManager

Parameters:

ctx - the request to attach to

Returns:

the user found in the session. If no user is available UserInfo.NOBODY can be used.

findUserByName

public UserInfo findUserByName(@Nullable
                               WebContext ctx,
                               String user)

Description copied from interface: UserManager

Tries to find a user with the given username.

Parameters:

ctx - the current HTTP request if one is present

user - the login name of the user to find

Returns:

the user with the given login name or null if no user is found

findUserByCredentials

public UserInfo findUserByCredentials(@Nullable
                                      WebContext ctx,
                                      String user,
                                      String password)

Description copied from interface: UserManager

Tries to find a user with the given credentials.

Parameters:

ctx - the current HTTP request if one is present

user - the login name of the user to find

password - the password of the user to find

Returns:

the user with the given credentials or null if no user is found

getUserObject

protected Object getUserObject(UserInfo u)

Description copied from class: GenericUserManager

Resolves the given user info back into the original (underlying) user object.

Specified by:

getUserObject in class GenericUserManager

Parameters:

u - the user info which was passed to the outside world.

Returns:

the original (underlying) user object

computeRoles

@Nullable
protected Set<String> computeRoles(@Nullable
                                             WebContext ctx,
                                             String userId)

Description copied from class: GenericUserManager

Tries to compute the roles for the given user and request.

If a server session is available, we try to load the roles from there.

Specified by:

computeRoles in class GenericUserManager

Parameters:

ctx - the current request

userId - the id of the user to fetch roles for

Returns:

a set of roles granted to the user or an empty set if no roles were found

computeUsername

@Nonnull
protected String computeUsername(@Nullable
                                          WebContext ctx,
                                          String userId)

Description copied from class: GenericUserManager

Compues the name of the given user and request.

Specified by:

computeUsername in class GenericUserManager

Parameters:

ctx - the current request

userId - the id of the user to fetch the name for

Returns:

the name of the user

computeTenantname

@Nonnull
protected String computeTenantname(@Nullable
                                            WebContext ctx,
                                            String tenantId)

Description copied from class: GenericUserManager

Compues the name of the given tenant and request.

Specified by:

computeTenantname in class GenericUserManager

Parameters:

ctx - the current request

tenantId - the id of the tenant to fetch the name for

Returns:

the name of the tenant

computeLang

@Nonnull
protected String computeLang(WebContext ctx,
                                      String userId)

Description copied from class: GenericUserManager

Compues the langange code of the given user and request.

Specified by:

computeLang in class GenericUserManager

Parameters:

ctx - the current request

userId - the id of the user to fetch the language for

Returns:

the language code for the user

attachToSession

public void attachToSession(@Nonnull
                            UserInfo user,
                            @Nonnull
                            WebContext ctx)

Description copied from class: GenericUserManager

Attaches the given user to the current session.

This will make the login persistent across requests (if session management is enabled).

Specified by:

attachToSession in interface UserManager

Overrides:

attachToSession in class GenericUserManager

Parameters:

user - the user to attach to the session

ctx - the current request to attach the user to

detachFromSession

public void detachFromSession(@Nonnull
                              UserInfo user,
                              @Nonnull
                              WebContext ctx)

Description copied from class: GenericUserManager

Removes all stored user information from the current session.

Specified by:

detachFromSession in interface UserManager

Overrides:

detachFromSession in class GenericUserManager

Parameters:

user - the current user - passed in, in case a cache etc. has to be cleared

ctx - the request to remove all data from

isLoginSupported

public boolean isLoginSupported()

Description copied from interface: UserManager

Determines if a login via username and password is possible.

Specified by:

isLoginSupported in interface UserManager

Overrides:

isLoginSupported in class GenericUserManager

Returns:

true if a username and password can be used to log a user in.