org.openmrs.api.context

Class UserContext

java.lang.Object

org.openmrs.api.context.UserContext

All Implemented Interfaces:

Serializable

public class UserContext
extends Object
implements Serializable

Represents an OpenMRS User Context which stores the current user information. Only one User may be authenticated within a UserContext at any given time. The UserContext should not be accessed directly, but rather used through the Context. This class should be kept light-weight. There is one instance of this class per user that is logged into the system.

See Also:

Context, Serialized Form

Constructor Summary

Constructors

Constructor and Description
UserContext(AuthenticationScheme authenticationScheme) Creates a user context based on the provided auth. scheme.

Method Summary

Modifier and Type	Method and Description
void	addProxyPrivilege(String privilege) Gives the given privilege to all calls to hasPrivilege.
Authenticated	authenticate(Credentials credentials) Authenticate user with the provided credentials.
User	becomeUser(String systemId) Change current authentication to become another user.
Set<Role>	getAllRoles() Gets all the roles for the (un)authenticated user.
Set<Role>	getAllRoles(User user) Gets all the roles for a user.
User	getAuthenticatedUser()
protected Integer	getDefaultLocationId(User user)
Locale	getLocale()
Location	getLocation()
Integer	getLocationId()
boolean	hasPrivilege(String privilege) Tests whether currently authenticated user has a particular privilege
boolean	isAuthenticated()
void	logout() logs out the "active" (authenticated) user within this UserContext
void	refreshAuthenticatedUser() Refresh the authenticated user object in this UserContext.
void	removeProxyPrivilege(String privilege) Will remove one instance of privilege from the privileges that are currently proxied
void	setLocale(Locale locale)
void	setLocation(Location location)
void	setLocationId(Integer locationId)

Methods inherited from class java.lang.Object

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

Constructor Detail

UserContext

public UserContext(AuthenticationScheme authenticationScheme)

Creates a user context based on the provided auth. scheme.

Parameters:

authenticationScheme - The auth. scheme that applies for this user context.

Since:

2.3.0

Method Detail

authenticate

public Authenticated authenticate(Credentials credentials)
                           throws ContextAuthenticationException

Authenticate user with the provided credentials. The authentication scheme must be Spring wired, see Context.getAuthenticationScheme().

Parameters:

credentials - The credentials to use to authenticate

Returns:

The authenticated client information

Throws:

ContextAuthenticationException - if authentication fails

Since:

2.3.0

refreshAuthenticatedUser

public void refreshAuthenticatedUser()

Refresh the authenticated user object in this UserContext. This should be used when updating information in the database about the current user and it needs to be reflecting in the (cached) getAuthenticatedUser() User object.

Since:

1.5

becomeUser

public User becomeUser(String systemId)
                throws ContextAuthenticationException

Change current authentication to become another user. (You can only do this if you're already authenticated as a superuser.)

Parameters:

systemId -

Returns:

The new user that this context has been set to. (null means no change was made)

Throws:

ContextAuthenticationException

getAuthenticatedUser

public User getAuthenticatedUser()

Returns:

"active" user who has been authenticated, otherwise null

isAuthenticated

public boolean isAuthenticated()

Returns:

true if user has been authenticated in this UserContext

logout

public void logout()

logs out the "active" (authenticated) user within this UserContext

See Also:

authenticate(org.openmrs.api.context.Credentials)

addProxyPrivilege

public void addProxyPrivilege(String privilege)

Gives the given privilege to all calls to hasPrivilege. This method was visualized as being used as follows (try/finally is important):

 try {
   Context.addProxyPrivilege("AAA");
   Context.get*Service().methodRequiringAAAPrivilege();
 }
 finally {
   Context.removeProxyPrivilege("AAA");
 }
 

Parameters:

privilege - to give to users

removeProxyPrivilege

public void removeProxyPrivilege(String privilege)

Will remove one instance of privilege from the privileges that are currently proxied

Parameters:

privilege - Privilege to remove in string form

setLocale

public void setLocale(Locale locale)

Parameters:

locale - new locale for this context

getLocale

public Locale getLocale()

Returns:

current locale for this context

getAllRoles

public Set<Role> getAllRoles()
                      throws Exception

Gets all the roles for the (un)authenticated user. Anonymous and Authenticated roles are appended if necessary

Returns:

all expanded roles for a user

Throws:

Exception

getAllRoles

public Set<Role> getAllRoles(User user)
                      throws Exception

Gets all the roles for a user. Anonymous and Authenticated roles are appended if necessary

Parameters:

user -

Returns:

all expanded roles for a user Should not fail with null user Should add anonymous role to all users Should add authenticated role to all authenticated users Should return same roles as user getAllRoles method

Throws:

Exception

hasPrivilege

public boolean hasPrivilege(String privilege)

Tests whether currently authenticated user has a particular privilege

Parameters:

privilege -

Returns:

true if authenticated user has given privilege Should authorize if authenticated user has specified privilege Should authorize if authenticated role has specified privilege Should authorize if proxied user has specified privilege Should authorize if anonymous user has specified privilege Should not authorize if authenticated user does not have specified privilege Should not authorize if authenticated role does not have specified privilege Should not authorize if proxied user does not have specified privilege Should not authorize if anonymous user does not have specified privilege

getLocationId

public Integer getLocationId()

Returns:

locationId for this user context if any is set

Since:

1.10

setLocationId

public void setLocationId(Integer locationId)

Parameters:

locationId - locationId to set

Since:

1.10

getLocation

public Location getLocation()

Returns:

current location for this user context if any is set

Since:

1.9

setLocation

public void setLocation(Location location)

Parameters:

location - the location to set to

Since:

1.9

getDefaultLocationId

protected Integer getDefaultLocationId(User user)