Class SessionUser


  • public class SessionUser
    extends java.lang.Object
    Utility class which can be used to obtain currently authenticated User from session. The User is placed in the session upon login and is updated on every HTTP request.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static SUser getUser​(javax.servlet.http.HttpServletRequest request)
      Returns currently authenticated user.
      static SUser getUser​(javax.servlet.http.HttpSession session)  
      static AuthModule<? extends AuthModuleType> getUserAuthModule​(javax.servlet.http.HttpServletRequest request)
      Returns authentication module used by currently authenticated user.
      static java.util.TimeZone getUserTimeZone​(javax.servlet.http.HttpServletRequest request)
      Returns timezone of the user
      static boolean isUserOverride​(SUser user, SUser existingUser)  
      static void removeUser​(java.lang.String userKey, javax.servlet.http.HttpSession session)  
      static void removeUser​(javax.servlet.http.HttpServletRequest request)
      Removes user from the session
      static void setUser​(javax.servlet.http.HttpServletRequest request, SUser user)
      Sets new user in the session
      static void setUser​(javax.servlet.http.HttpServletRequest request, SUser user, AuthModule<? extends AuthModuleType> authModule)
      Sets new user with used authentication module in the session
      static void setUserTimeZone​(javax.servlet.http.HttpServletRequest request, java.util.TimeZone tz)
      Sets current user timezone
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • getUser

        public static SUser getUser​(@NotNull
                                    javax.servlet.http.HttpServletRequest request)
        Returns currently authenticated user.
        Parameters:
        request - request
        Returns:
        authenticated user
      • getUser

        @Nullable
        public static SUser getUser​(@Nullable
                                    javax.servlet.http.HttpSession session)
      • getUserAuthModule

        @Nullable
        public static AuthModule<? extends AuthModuleType> getUserAuthModule​(@NotNull
                                                                             javax.servlet.http.HttpServletRequest request)
        Returns authentication module used by currently authenticated user.
        Parameters:
        request - request
        Returns:
        authentication module
        Since:
        8.0
      • setUser

        public static void setUser​(@NotNull
                                   javax.servlet.http.HttpServletRequest request,
                                   SUser user)
        Sets new user in the session
        Parameters:
        request - request
        user - new user
      • setUser

        public static void setUser​(@NotNull
                                   javax.servlet.http.HttpServletRequest request,
                                   @NotNull
                                   SUser user,
                                   @Nullable
                                   AuthModule<? extends AuthModuleType> authModule)
        Sets new user with used authentication module in the session
        Parameters:
        request - request
        user - new user
        authModule - authentication module used to login
        Since:
        8.0
      • isUserOverride

        public static boolean isUserOverride​(SUser user,
                                             SUser existingUser)
      • removeUser

        public static void removeUser​(@NotNull
                                      javax.servlet.http.HttpServletRequest request)
        Removes user from the session
        Parameters:
        request - request
      • removeUser

        public static void removeUser​(@Nullable
                                      java.lang.String userKey,
                                      @Nullable
                                      javax.servlet.http.HttpSession session)
      • getUserTimeZone

        @NotNull
        public static java.util.TimeZone getUserTimeZone​(@NotNull
                                                         javax.servlet.http.HttpServletRequest request)
        Returns timezone of the user
        Parameters:
        request - HTTP request
        Returns:
        user timezone if it was determined or default timezone
      • setUserTimeZone

        public static void setUserTimeZone​(@NotNull
                                           javax.servlet.http.HttpServletRequest request,
                                           @NotNull
                                           java.util.TimeZone tz)
        Sets current user timezone
        Parameters:
        request - HTTP request
        tz - timezone