lumis.portal.user

Interface IUserManagerSPI

All Superinterfaces:

IConfigDeleter, IUserManager

All Known Implementing Classes:

UserManager

public interface IUserManagerSPI
extends IUserManager

Class interface responsible for managing internal operations on the portal users.

Since:

8.0.0

Version:

$Revision: 21880 $ $Date: 2018-09-21 20:07:19 +0000 (Fri, 21 Sep 2018) $

Method Summary

Modifier and Type	Method and Description
default List<UserConfig>	findUsers(String query) Find the first five users which are not framework users, given a search query for user login or user name.
List<UserConfig>	findUsers(String query, boolean includeFrameworkUsers, int maxResults) Find users by user login or user name, given a search query.
UserConfig	getByMonitorUserId(String monitorUserId) Returns the user that corresponds to the given monitor user identifier.
String	getMonitorUserId(UserConfig user) Returns the identifier of the monitor user associated with the given user.
IFile	getUserProfileImageContentTypeFile(String userId) Returns the user's profile image content type file.
IFile	getUserProfileImageFile(String userId) Returns the user's profile image file.
String	getUserProfileImageHref(String userId) Get user profile image href by user identifier
Collection<UserConfig>	getUsersByLogins(Set<String> logins) Get users with the given logins.

Methods inherited from interface lumis.portal.user.IUserManager

add, addAlternativeLogin, addOrUpdate, delete, deleteAlternativeLogin, get, getAlternativeLogins, getByChannelId, getByOrigin, getUserId, getUserIdByLogin, setPassword, update

Methods inherited from interface lumis.portal.serialization.operation.IConfigDeleter

deleteConfig

Method Detail

getUserProfileImageHref

String getUserProfileImageHref(String userId)

Get user profile image href by user identifier

Parameters:

userId - the user identifier

Returns:

user profile image href

Since:

8.0.0

getUserProfileImageContentTypeFile

IFile getUserProfileImageContentTypeFile(String userId)

Returns the user's profile image content type file.

Parameters:

userId - the user identifier.

Returns:

the user's profile image content type file.

Since:

8.0.0

getUserProfileImageFile

IFile getUserProfileImageFile(String userId)

Returns the user's profile image file.

Parameters:

userId - the user identifier.

Returns:

the user's profile image file.

Since:

8.0.0

findUsers

default List<UserConfig> findUsers(String query)
                            throws PortalException

Find the first five users which are not framework users, given a search query for user login or user name.

Parameters:

query - query used to search users

Returns:

List of users which matches the search query.

Throws:

PortalException

Since:

10.1.0

See Also:

findUsers(String, boolean, int)

findUsers

List<UserConfig> findUsers(String query,
                           boolean includeFrameworkUsers,
                           int maxResults)
                    throws PortalException

Find users by user login or user name, given a search query.

Parameters:

query - query used to search users

includeFrameworkUsers - indicates if framework users must also be returned

maxResults - amount of users to return

Returns:

List of users which matches the search query with the given parameters.

Throws:

PortalException

Since:

10.1.0

See Also:

IUserDao.findUsers(String, boolean, int)

getUsersByLogins

Collection<UserConfig> getUsersByLogins(Set<String> logins)
                                 throws PortalException

Get users with the given logins.

Parameters:

logins - logins for getting users

Returns:

List of users with the given logins.

Throws:

PortalException

Since:

10.1.0

See Also:

IUserDao.getUsersByLogins(Set)

getByMonitorUserId

UserConfig getByMonitorUserId(String monitorUserId)
                       throws PortalException

Returns the user that corresponds to the given monitor user identifier.

Parameters:

monitorUserId - the monitor user identifier.

Returns:

the user or null if no such user was found.

Throws:

PortalException

Since:

11.0.0

getMonitorUserId

String getMonitorUserId(UserConfig user)

Returns the identifier of the monitor user associated with the given user.

Parameters:

user - the user.

Returns:

the monitor user identifier, or null if the user is guest.

Since:

11.0.0