org.xwiki.users

Interface UserManager

All Known Implementing Classes:

AbstractUserManager

@Unstable
@Role
public interface UserManager

User management APIs.

Since:

1.0M9

Version:

$Id: cfd719b94e12c5270823667753038c7c709609c2 $

Method Summary

Methods

Modifier and Type	Method and Description
User	getCurrentUser() Get the currently logged in user.
User	getUser(String identifier) The user corresponding to the identifier.
User	getUser(String identifier, boolean force) The user corresponding to the identifier.

Method Detail

getUser

User getUser(String identifier)

The user corresponding to the identifier.

Parameters:

identifier - the user identifier to resolve: the username passed in the login form, a serialized identifier stored in the document's metadata, or an identifier passed by an external authentication service

Returns:

the corresponding user, if found, or null otherwise

getUser

User getUser(String identifier,
           boolean force)

The user corresponding to the identifier. If no existing user is found and the force parameter is true, return a new user in the default user management system.

Parameters:

identifier - the user identifier to resolve: the username passed in the login form, a serialized identifier stored in the document's metadata, or an identifier passed by an external authentication service

force - whether to force returning a new profile in case the user is not found

Returns:

the corresponding user, if found; a new user profile if force is true; null otherwise

getCurrentUser

User getCurrentUser()

Get the currently logged in user.

Returns:

the currently logged in user, or null if no user is logged in