UserContext (SIRIUS web 19.0-rc8 API)

java.lang.Object
- sirius.web.security.UserContext

All Implemented Interfaces:

sirius.kernel.async.SubContext
```
public class UserContext
extends Object
implements sirius.kernel.async.SubContext
```
Used to access the current user and scope.
An instance of this class is present in the CallContext and takes care of picking the right user manager to authenticate users or store / load them from a session.
This class also manages messages shown to the user.

Field Summary

Fields
Modifier and Type	Field and Description
`static sirius.kernel.health.Log`	`LOG` Contains the logger `user` used by the auth framework
`static String`	`MDC_SCOPE` The key used to store the current scope in the MDC
`static String`	`MDC_USER_ID` The key used to store the current user id in the MDC
`static String`	`MDC_USER_NAME` The key used to store the current user name in the MDC

Constructor Summary

Constructors
Constructor and Description

UserContext()

Constructors
Constructor and Description
`UserContext()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addFieldError(String field, String value)` Adds an error for a given field
`void`	`addFieldErrorMessage(String field, String errorMessage)` Adds an error message for the given field
`void`	`addMessage(Message msg)` Adds a message to be shown to the user.
`void`	`attachUserToSession()` Binds the currently active user to the session.
`void`	`detach()`
`void`	`detachUserFromSession()` Removes the authentication and user identity from the session.
`sirius.kernel.async.SubContext`	`fork()`
`static UserContext`	`get()` Retrieves the current UserContext from the `CallContext`.
`static ScopeInfo`	`getCurrentScope()` Boilerplate method to quickly access the current scope.
`static UserInfo`	`getCurrentUser()` Boilerplate method to quickly access the current user.
`String`	`getFieldErrorMessage(String field)` Returns an error message for the given field
`String`	`getFieldValue(String field)` Returns the originally submitted field value even if it was rejected due to an error.
`String`	`getFieldValue(String field, Object value)` Returns the originally submitted field value even if it was rejected due to an error.
`Collection<String>`	`getFieldValues(String field)` Returns all values submitted for the given field
`static <H> H`	`getHelper(Class<H> helperType)` Returns the helper of the given class for the current scope.
`static <H> H`	`getHelper(String name)` Returns the helper with the given name for the current scope.
`List<Message>`	`getMessages()` Returns all messages to be shown to the user.
`ScopeInfo`	`getScope()` Returns the currently active scope.
`static UserSettings`	`getSettings()` Returns the configuration with is specific to the current user.
`UserInfo`	`getUser()` Returns the current user.
`UserInfo`	`getUserForScope(ScopeInfo scope)` Returns the used which would be the current user if the space with the given id would be active.
`UserManager`	`getUserManager()` Determines and returns the current user manager.
`List<Message>`	`getUserSpecificMessages()` Returns all user specific messages without any globally or locally generated ones.
`static void`	`handle(Throwable e)` Handles the given exception by passing it to `Exceptions` and by creating an appropriate message for the user.
`boolean`	`hasError(String field)` Determines if there is an error or error message for the given field
`boolean`	`isUserPresent()` Determines if the user is present.
`static void`	`message(Message msg)` Adds a message to the current UserContext.
`void`	`runAs(UserInfo user, Runnable section)` Executes the given section as the given user.
`void`	`setCurrentScope(ScopeInfo scope)` Installs the given scope as current scope.
`void`	`setCurrentUser(UserInfo user)` Installs the given user as current user.
`static void`	`setErrorMessage(String field, String errorMessage)` Adds an error message for the given field
`static void`	`setFieldError(String field, Object value)` Adds a field error to the current UserContext.
`String`	`signalFieldError(String field)` Returns "has-error" if an error was added for the given field.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MDC_SCOPE
```
public static final String MDC_SCOPE
```
    The key used to store the current scope in the MDC
    
    See Also:
    
    Constant Field Values
  - MDC_USER_ID
```
public static final String MDC_USER_ID
```
    The key used to store the current user id in the MDC
    
    See Also:
    
    Constant Field Values
  - MDC_USER_NAME
```
public static final String MDC_USER_NAME
```
    The key used to store the current user name in the MDC
    
    See Also:
    
    Constant Field Values
  - LOG
```
public static final sirius.kernel.health.Log LOG
```
    Contains the logger user used by the auth framework
- Constructor Detail
  - UserContext
```
public UserContext()
```
- Method Detail
  - get
```
public static UserContext get()
```
    Retrieves the current UserContext from the CallContext.
    
    Returns:
    
    the current user context.
  - getCurrentUser
```
public static UserInfo getCurrentUser()
```
    Boilerplate method to quickly access the current user.
    
    Returns:
    
    the current user
    
    See Also:
    
    getUser()
  - getSettings
```
public static UserSettings getSettings()
```
    Returns the configuration with is specific to the current user.
    This is boilerplate for UserContext.getCurrentUser().getConfig().
    
    Returns:
    
    the config for the current user
    
    See Also:
    
    UserInfo.getSettings()
  - getHelper
```
@Nonnull
public static <H> H getHelper(@Nonnull
                                       Class<H> helperType)
```
    Returns the helper of the given class for the current scope.
    NOTE: This helper is per ScopeInfo not per UserInfo! Therefore no user dependent data may be kept in its state.
    
    Type Parameters:
    
    H - the generic type of the helper
    
    Parameters:
    
    helperType - the type of the helper to fetch
    
    Returns:
    
    an instance of the given helper. If the helper can neither be found nor created, an exception will be thrown.
  - getHelper
```
@Nonnull
public static <H> H getHelper(@Nonnull
                                       String name)
```
    Returns the helper with the given name for the current scope.
    NOTE: This helper is per ScopeInfo not per UserInfo! Therefore no user dependent data may be kept in its state.
    
    Type Parameters:
    
    H - the generic type of the helper
    
    Parameters:
    
    name - the name of the helper to fetch
    
    Returns:
    
    an instance of the given helper. If the helper can neither be found nor created, an exception will be thrown.
  - getCurrentScope
```
public static ScopeInfo getCurrentScope()
```
    Boilerplate method to quickly access the current scope.
    
    Returns:
    
    the currently active scope
    
    See Also:
    
    getScope()
  - handle
```
public static void handle(@Nullable
                          Throwable e)
```
    Handles the given exception by passing it to Exceptions and by creating an appropriate message for the user.
    
    Parameters:
    
    e - the exception to handle. If the given exception is null nothing will happen.
  - message
```
public static void message(Message msg)
```
    Adds a message to the current UserContext.
    
    Parameters:
    
    msg - the message to add
  - setFieldError
```
public static void setFieldError(String field,
                                 Object value)
```
    Adds a field error to the current UserContext.
    
    Parameters:
    
    field - the field for which an error occurred
    
    value - the value which was rejected
  - setCurrentScope
```
public void setCurrentScope(ScopeInfo scope)
```
    Installs the given scope as current scope.
    For generic web requests, this is not necessary, as the scope is auto-detected.
    
    Parameters:
    
    scope - the scope to set
  - setCurrentUser
```
public void setCurrentUser(@Nullable
                           UserInfo user)
```
    Installs the given user as current user.
    For generic web requests, this is not necessary, as the user is auto-detected.
    
    Parameters:
    
    user - the user to set
  - runAs
```
public void runAs(@Nullable
                  UserInfo user,
                  @Nonnull
                  Runnable section)
```
    Executes the given section as the given user.
    Restores the previously active user once the section is left.
    
    Parameters:
    
    user - the user to install
    
    section - the section to execute as user
  - addMessage
```
public void addMessage(Message msg)
```
    Adds a message to be shown to the user.
    
    Parameters:
    
    msg - the message to be shown to the user
  - getMessages
```
public List<Message> getMessages()
```
    Returns all messages to be shown to the user.
    
    Returns:
    
    a list of messages to be shown to the user
  - getUserSpecificMessages
```
public List<Message> getUserSpecificMessages()
```
    Returns all user specific messages without any globally or locally generated ones.
    
    Returns:
    
    a list of "real" messages which were created while processing the current request
  - addFieldError
```
public void addFieldError(String field,
                          String value)
```
    Adds an error for a given field
    
    Parameters:
    
    field - the name of the field
    
    value - the value which was supplied and rejected
  - hasError
```
public boolean hasError(String field)
```
    Determines if there is an error or error message for the given field
    
    Parameters:
    
    field - the field to check for errors
    
    Returns:
    
    true if an error was added for the field, false otherwise
  - signalFieldError
```
public String signalFieldError(String field)
```
    Returns "has-error" if an error was added for the given field.
    
    Parameters:
    
    field - the field to check
    
    Returns:
    
    "has-error" if an error was added for the given field, an empty string otherwise
  - getFieldValue
```
public String getFieldValue(String field,
                            Object value)
```
    Returns the originally submitted field value even if it was rejected due to an error.
    
    Parameters:
    
    field - the name of the form field
    
    value - the entity value (used if no error occurred)
    
    Returns:
    
    the originally submitted value (if an error occurred), the given value otherwise
  - getFieldValue
```
public String getFieldValue(String field)
```
    Returns the originally submitted field value even if it was rejected due to an error.
    
    Parameters:
    
    field - the name of the form field
    
    Returns:
    
    the originally submitted value (if an error occurred) or the parameter (using field as name) from the current WebContext otherwise
  - getFieldValues
```
public Collection<String> getFieldValues(String field)
```
    Returns all values submitted for the given field
    
    Parameters:
    
    field - the name of the field which values should be extracted
    
    Returns:
    
    a list of values submitted for the given field
  - setErrorMessage
```
public static void setErrorMessage(String field,
                                   String errorMessage)
```
    Adds an error message for the given field
    
    Parameters:
    
    field - name of the form field
    
    errorMessage - value to be added
  - addFieldErrorMessage
```
public void addFieldErrorMessage(String field,
                                 String errorMessage)
```
    Adds an error message for the given field
    
    Parameters:
    
    field - name of the form field
    
    errorMessage - value to be added
  - getFieldErrorMessage
```
public String getFieldErrorMessage(String field)
```
    Returns an error message for the given field
    
    Parameters:
    
    field - name of the form field
    
    Returns:
    
    error message if existant else an empty string
  - getUser
```
public UserInfo getUser()
```
    Returns the current user.
    If no user is present yet, it tries to parse the current WebContext and retireve the user from the session.
    
    Returns:
    
    the currently active user
  - getUserForScope
```
public UserInfo getUserForScope(ScopeInfo scope)
```
    Returns the used which would be the current user if the space with the given id would be active.
    You can use ScopeInfo.DEFAULT_SCOPE to access the user of the default scope which will most probably the administrative backend.
    Note that this method will only check the session (UserManager.findUserForRequest(WebContext)) and will not try to perform a login via credentials as given in the current request.
    
    Parameters:
    
    scope - the scope to fetch the user for
    
    Returns:
    
    the user found for the given scope or UserInfo.NOBODY if no user was found
  - isUserPresent
```
public boolean isUserPresent()
```
    Determines if the user is present.
    This can be either direclty via a setCurrentUser(UserInfo) or implicitely via getUser()
    
    Returns:
    
    the currently active user
  - attachUserToSession
```
public void attachUserToSession()
```
    Binds the currently active user to the session.
    This will make the authentication of a user persistent als long as the session remains
  - getUserManager
```
@Nonnull
public UserManager getUserManager()
```
    Determines and returns the current user manager.
    The user manager is determined by the current scope.
    
    Returns:
    
    the currently active user manager
    
    See Also:
    
    getCurrentScope(), ScopeDetector
  - detachUserFromSession
```
public void detachUserFromSession()
```
    Removes the authentication and user identity from the session.
    This can be considered a logout.
  - getScope
```
public ScopeInfo getScope()
```
    Returns the currently active scope.
    This is determined using the ScopeDetector or it will always be the ScopeInfo.DEFAULT_SCOPE if no scope detector is present.
    
    Returns:
    
    the currently active scope
  - fork
```
public sirius.kernel.async.SubContext fork()
```
    Specified by:
    
    fork in interface sirius.kernel.async.SubContext
  - detach
```
public void detach()
```
    Specified by:
    
    detach in interface sirius.kernel.async.SubContext

Class UserContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MDC_SCOPE

MDC_USER_ID

MDC_USER_NAME

LOG

Constructor Detail

UserContext

Method Detail

get

getCurrentUser

getSettings

getHelper

getHelper

getCurrentScope

handle

message

setFieldError

setCurrentScope

setCurrentUser

runAs

addMessage

getMessages

getUserSpecificMessages

addFieldError

hasError

signalFieldError

getFieldValue

getFieldValue

getFieldValues

setErrorMessage

addFieldErrorMessage

getFieldErrorMessage

getUser

getUserForScope

isUserPresent

attachUserToSession

getUserManager

detachUserFromSession

getScope

fork

detach