sirius.web.security

Interface UserManager

All Known Implementing Classes:

GenericUserManager, PublicUserManager

public interface UserManager

Responsible for authentication and session management.

A user manager extracts the current user from a request (its session) or tries to find appropriate login data in the request to authenticate the user.

Each scope (e.g. frontend, backend) has its own user manager, which is defined in the system configuration (security.scopes.[scope-type].manager). This acutally references the name of the UserManagerFactory used to create a user manager for the scope.

Method Summary

Modifier and Type	Method and Description
void	attachToSession(UserInfo user, WebContext ctx) Makes the currently authenticated user persistent by storing the required information in the session.
UserInfo	bindToRequest(WebContext ctx) Tries to find the current user in the current session or by checking the request for valid credentials
void	detachFromSession(UserInfo user, WebContext ctx) Removes all stored data from the session This can be considered a logout operation.
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.
UserInfo	findUserForRequest(WebContext ctx) Tries to find the current user in the current session.
boolean	isKeepLoginSupported() Determines if the login can be stored longer than a usual session.
boolean	isLoginSupported() Determines if a login via username and password is possible.

Method Detail

bindToRequest

@Nonnull
UserInfo bindToRequest(@Nonnull
                                WebContext ctx)

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

Parameters:

ctx - the request to attach to

Returns:

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

findUserForRequest

@Nonnull
UserInfo findUserForRequest(@Nonnull
                                     WebContext ctx)

Tries to find the current user in the current session. In contrast to bindToRequest(WebContext) this will not try to log a user in via credentials found in the request.

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

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

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

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

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

attachToSession

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

Makes the currently authenticated user persistent by storing the required information in the session.

Parameters:

user - the user to store

ctx - the request containing the session

detachFromSession

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

Removes all stored data from the session

This can be considered a logout operation.

Parameters:

user - the user to logout

ctx - the request containing the session

isLoginSupported

boolean isLoginSupported()

Determines if a login via username and password is possible.

Returns:

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

isKeepLoginSupported

boolean isKeepLoginSupported()

Determines if the login can be stored longer than a usual session.

Returns:

true if a "keep me logged in" function is available, false otherwise.