Package de.xima.fc.user

Class UserContextFactory

java.lang.Object

de.xima.fc.user.UserContextFactory

public class UserContextFactory
extends Object

Factory methods for creating new UserContext instances.

Author:

XIMA MEDIA GmbH

Field Summary

Fields

Modifier and Type	Field	Description
static UserContext	ANONYMOUS	User context for the anonymous user.
static UserContext	SETUP	Deprecated. Use forSystem() instead.
static UserContext	SYSTEM	User context for the system user.

Constructor Summary

Constructors

Constructor	Description
UserContextFactory()

Method Summary

Modifier and Type	Method	Description
static UserContext	copyOf(UserContext uc)
static UserContext	forAnonymous()
static UserContext	forBenutzer(Benutzer ben)	Deprecated. use forUser(IUser) instead.
static UserContext	forRequest(javax.servlet.http.HttpServletRequest request)	Deprecated. Use forWebContext(HttpServletRequest, HttpServletResponse, IAuthenticationTarget) instead.
static UserContext	forRequest(javax.servlet.http.HttpServletRequest request, boolean createSession)	Deprecated. Use forWebContext(HttpServletRequest, HttpServletResponse, IAuthenticationTarget) instead.
static UserContext	forSystem()
static UserContext	forUser(IUser user)
static UserContext	forWebContext(javax.faces.context.FacesContext ctx, IAuthenticationTarget target)	Reads the user from the given Faces context, and creates a new user context wrapper for that user.
static UserContext	forWebContext(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, IAuthenticationTarget target)	Reads the user from the given request and response, and creates a new user context wrapper for that user.
static UserContext	forXfcSession(XfcSession session)	Deprecated. Use forWebContext(HttpServletRequest, HttpServletResponse, IAuthenticationTarget) instead.
static UserContext	getNew()	Deprecated. Use forAnonymous().

Methods inherited from class java.lang.Object

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

Field Detail

ANONYMOUS

public static UserContext ANONYMOUS

User context for the anonymous user. The parameters cannot be modified.

See Also:

, for a user context with modifiable parameters., , if you need to create a user context with modifiable parameters from an existing user context.

SYSTEM

public static UserContext SYSTEM

User context for the system user. The parameters cannot be modified.

See Also:

, for a user context with modifiable parameters., , if you need to create a user context with modifiable parameters from an existing user context.

SETUP

@Deprecated
public static UserContext SETUP

Deprecated.

Use forSystem() instead.

Constructor Detail

UserContextFactory

public UserContextFactory()

Method Detail

forAnonymous

public static UserContext forAnonymous()

Returns:

User context for the anonymous user VirtualUser.ANONYMOUS.

copyOf

public static UserContext copyOf(UserContext uc)

Parameters:

uc - A user context to copy.

Returns:

A new user context with the same user and parameters. Modifications to the parameters do not affect the parameters of the original user context.

forSystem

public static UserContext forSystem()

Returns:

User context for the system user VirtualUser.SYSTEM.

forUser

public static UserContext forUser(IUser user)

Parameters:

user - The user to wrap.

Returns:

A new modifiable user context for the given user.

forWebContext

public static UserContext forWebContext(javax.servlet.http.HttpServletRequest request,
                                        javax.servlet.http.HttpServletResponse response,
                                        IAuthenticationTarget target)

Reads the user from the given request and response, and creates a new user context wrapper for that user.

Parameters:

request - The request from which to read the user.

response - The response from which to read the user.

target - Authentication target (e.g. backend or frontend).

Returns:

A new modifiable user context for the user from the given request.

forWebContext

public static UserContext forWebContext(javax.faces.context.FacesContext ctx,
                                        IAuthenticationTarget target)

Reads the user from the given Faces context, and creates a new user context wrapper for that user.

Parameters:

ctx - Faces context from which to read the user.

target - Authentication target (e.g. backend or frontend).

Returns:

A new modifiable user context for the user from the given request.

forBenutzer

@Deprecated
public static UserContext forBenutzer(Benutzer ben)

Deprecated.

use forUser(IUser) instead.

forRequest

@Deprecated
public static UserContext forRequest(javax.servlet.http.HttpServletRequest request)

Deprecated.

Use forWebContext(HttpServletRequest, HttpServletResponse, IAuthenticationTarget) instead.

forRequest

@Deprecated
public static UserContext forRequest(javax.servlet.http.HttpServletRequest request,
                                     boolean createSession)

Deprecated.

Use forWebContext(HttpServletRequest, HttpServletResponse, IAuthenticationTarget) instead.

forXfcSession

@Deprecated
public static UserContext forXfcSession(XfcSession session)

Deprecated.

Use forWebContext(HttpServletRequest, HttpServletResponse, IAuthenticationTarget) instead.

getNew

@Deprecated
public static UserContext getNew()

Deprecated.

Use forAnonymous().

Returns:

User context for the anonymous user VirtualUser.ANONYMOUS.