com.communote.server.core.security

Class SwitchUserHelper

java.lang.Object

com.communote.server.core.security.SwitchUserHelper

public final class SwitchUserHelper
extends Object

This helper contains methods to switch a user context. Switch user means that the current authentication will be hold and another user will be set as authenticated allowing to do operations for the target user without him logging on. Typical use case is the message queue component, which only authenticated a system user and then process messages in the context of another user. The current authentication will be stored in a SwitchUserGrantedAuthority of the new user which then will be used when switching back. The target user will only have the roles as defined in ROLE_SWITCH_ORGINAL_USER, all other roles will not be used as authority for the target user. Therefore the target user will not have client admin rights, even if the admin role is assigned in the database. The switching of a user is only allowed if the current user has a system role authority (

Author:

Communote GmbH - http://www.communote.com/

See Also:

UserRole.ROLE_SYSTEM_USER

Method Summary

Modifier and Type	Method and Description
static boolean	canSwitchUser()
static org.springframework.security.core.Authentication	getOriginalAuthentication()
static boolean	isUserSwitched()
static org.springframework.security.core.Authentication	removeSwitchedUser() Throws an exception in case no switched user exists
static org.springframework.security.core.Authentication	switchUser(User targetUser) Switch the user to the target user.

Methods inherited from class java.lang.Object

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

Method Detail

canSwitchUser

public static boolean canSwitchUser()

Returns:

true if the current user can switch to another user

getOriginalAuthentication

public static org.springframework.security.core.Authentication getOriginalAuthentication()

Returns:

if there is a switched user return the original one, returns null if there is no switched user

isUserSwitched

public static boolean isUserSwitched()

Returns:

true if there is a currently switched user

removeSwitchedUser

public static org.springframework.security.core.Authentication removeSwitchedUser()

Throws an exception in case no switched user exists

Returns:

remove a switched user

switchUser

public static org.springframework.security.core.Authentication switchUser(User targetUser)
                                                                   throws SwitchUserNotAllowedException

Switch the user to the target user. Method will thrown an AccessDeniedException if the current user is not allowed to switch the user. No admin roles will be granted to the target user if even if its a client admin in the databse.

Parameters:

targetUser - the user to switch to

Returns:

get the authentication for the target user

Throws:

SwitchUserNotAllowedException - in case the switching is not allowed