com.suncode.pwfl.administration.user

Class UserContext

java.lang.Object

com.suncode.pwfl.administration.user.UserContext

All Implemented Interfaces:

Context

@Api
public class UserContext
extends Object
implements Context

Context that holds informations about current user.

Author:

Cezary Kozar 14 cze 2016

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Method Summary

Modifier and Type	Method and Description
static UserContext	activate(String userName) Activates context of given user so current() will return context created for given user.
static UserContext	activate(UserInfo user) Activates context of given user so current() will return context created for given user.
static void	activate(UserInfo user, InContext<UserContext> action) Activates context of given user and invokes provided action in created context.
static UserContext	current() Returns current user context.
static UserContext	deactivate() Deactivates current user context
UserInfo	getUser() Returns user associated with this context.
String	getUserJson() Returns serialized user in JSON notation.
static boolean	isActive() Returns true if this context is active.
String	name() Returns this context name (for identification purposes)

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Method Detail

name

public String name()

Description copied from interface: Context

Returns this context name (for identification purposes)

Specified by:

name in interface Context

getUser

public UserInfo getUser()

Returns user associated with this context.

Returns:

user

getUserJson

public String getUserJson()

Returns serialized user in JSON notation.

Returns:

json representation of user

isActive

public static boolean isActive()

Returns true if this context is active.

current

public static UserContext current()
                           throws ContextNotActiveException

Returns current user context.

Throws:

ContextNotActiveException

activate

public static UserContext activate(String userName)

Activates context of given user so current() will return context created for given user.

Parameters:

userName - user name

Returns:

user context

activate

public static UserContext activate(UserInfo user)

Activates context of given user so current() will return context created for given user.

Parameters:

user - user

Returns:

user context

activate

public static void activate(UserInfo user,
                            InContext<UserContext> action)

Activates context of given user and invokes provided action in created context.

Parameters:

user - user

action - action executed in user context

deactivate

public static UserContext deactivate()

Deactivates current user context

Returns:

deactivated context