com.communote.server.core.security

Class AuthenticationHelper

java.lang.Object

com.communote.server.core.security.AuthenticationHelper

public final class AuthenticationHelper
extends Object

Provides functionality to login a user not using the web frontend e.g. for a test. should only be used rarely.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	KENMEI_USER_ROLE The user role of the user
static String	PUBLIC_USER_ROLE The user role of the public user
static String	ROLE_ANONYMOUS The user role of the anonymous user
static String	ROLE_INTERNAL_SYSTEM The user role of the public user

Method Summary

Modifier and Type	Method and Description
static org.springframework.security.core.Authentication	createAuthentication(User user) Create an authentication for the user that can be used to be set in the security context
static void	removeAuthentication() Remove the authentication from the security context.
static org.springframework.security.core.Authentication	setAsAuthenticatedUser(User user) Set the provided user as the currently authenticated user for the current thread.
static org.springframework.security.core.Authentication	setAuthentication(org.springframework.security.core.Authentication newAuth) Set the provided authentication object as the currently authenticated principal for the current thread.
static org.springframework.security.core.context.SecurityContext	setInternalSystemToSecurityContext() Login as the internal system user.
static void	setPublicUserToSecurityContext(javax.servlet.ServletRequest request) Set the public user as authenticated user to the current SecurityContext.
static void	setSecurityContext(org.springframework.security.core.context.SecurityContext securityContext) Set the given SecurityContext.

Methods inherited from class java.lang.Object

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

Field Detail

ROLE_ANONYMOUS

public static final String ROLE_ANONYMOUS

The user role of the anonymous user

See Also:

Constant Field Values

PUBLIC_USER_ROLE

public static final String PUBLIC_USER_ROLE

The user role of the public user

See Also:

Constant Field Values

ROLE_INTERNAL_SYSTEM

public static final String ROLE_INTERNAL_SYSTEM

The user role of the public user

See Also:

Constant Field Values

KENMEI_USER_ROLE

public static final String KENMEI_USER_ROLE

The user role of the user

Method Detail

createAuthentication

public static org.springframework.security.core.Authentication createAuthentication(User user)

Create an authentication for the user that can be used to be set in the security context

Parameters:

user - the user

Returns:

the authentication

removeAuthentication

public static void removeAuthentication()

Remove the authentication from the security context.

See Also:

setAuthentication(Authentication)

setAsAuthenticatedUser

public static org.springframework.security.core.Authentication setAsAuthenticatedUser(User user)

Set the provided user as the currently authenticated user for the current thread. The authentication object that is replaced with that of the provided user will be returned.

The caller is responsible for restoring the authentication object that was previously set for the current thread.

NOTE: be careful when using this method from threads that originate from servlet requests as in this context the authentication is shared among all threads of the current HTTP session.

Parameters:

user - the user to set as authenticated

Returns:

the replaced authentication object, can be null

setAuthentication

public static org.springframework.security.core.Authentication setAuthentication(org.springframework.security.core.Authentication newAuth)

Set the provided authentication object as the currently authenticated principal for the current thread. The authentication object that is replaced with the provided one will be returned.

The caller is responsible for restoring the authentication object that was previously set for the current thread.

NOTE: be careful when using this method from threads that originate from servlet requests as in this context the authentication is shared among all threads of the current HTTP session.

Parameters:

newAuth - the new authentication object, can be null to clear the authentication

Returns:

the replaced authentication object, can be null

setInternalSystemToSecurityContext

public static org.springframework.security.core.context.SecurityContext setInternalSystemToSecurityContext()

Login as the internal system user.

Since Communote uses the SecurityContextPersistenceFilter the SecurityContext is shared between all threads of the current session. Therefore the internal system user is not just set in the existing security context, instead a new security context containing the internal system user is exposed to the SecurityContextHolder. The calling code has to ensure that it resets the previously contained SecurityContext after completing the operation which should have been run as internal system user. The recommended pattern is to use a try-finally block.

Returns:

the current security context

See Also:

setSecurityContext(SecurityContext)

setPublicUserToSecurityContext

public static void setPublicUserToSecurityContext(javax.servlet.ServletRequest request)

Set the public user as authenticated user to the current SecurityContext. If the SecurityContext is shared between all threads of the current session.

Parameters:

request - the servlet request

setSecurityContext

public static void setSecurityContext(org.springframework.security.core.context.SecurityContext securityContext)

Set the given SecurityContext. Should be called after an operation that is run after calling setInternalSystemToSecurityContext() completed.

Parameters:

securityContext - The security context to restore