All Superinterfaces:

IConfigDeleter

All Known Subinterfaces:

IUserManagerSPI

All Known Implementing Classes:

UserManager
```
@StableMinor(version="14.1",
             sinceVersion="4.0")
public interface IUserManager
extends IConfigDeleter
```
Class interface responsible for managing operations on the portal users.

Since:

4.0.0

Version:

$Revision: 24683 $ $Date: 2021-08-23 18:55:58 -0300 (Mon, 23 Aug 2021) $

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`String`	`add(SessionConfig sessionConfig, UserConfig userConfig, ITransaction transaction)`	Adds a user to the portal and returns the identifier of the user added.
`void`	`addAlternativeLogin(SessionConfig sessionConfig, String userId, String newLogin, ITransaction transaction)`	Adds an alternative login for an user.
`void`	`addOrUpdate(SessionConfig sessionConfig, UserConfig userConfig, ITransaction transaction)`
`void`	`delete(SessionConfig sessionConfig, String userId, ITransaction transaction)`	Delete an user.
`void`	`deleteAlternativeLogin(SessionConfig sessionConfig, String loginToDelete, ITransaction transaction)`	Deletes an alternative login.
`UserConfig`	`get(SessionConfig sessionConfig, String userId, ITransaction transaction)`	Get user configuration from userId.
`Collection<String>`	`getAlternativeLogins(SessionConfig sessionConfig, String userId, ITransaction transaction)`	Returns the alternative logins for an user.
`Collection<UserConfig>`	`getByChannelId(SessionConfig sessionConfig, String channelId, ITransaction transaction)`	Returns the local users of the specified channel
`Collection<UserConfig>`	`getByOrigin(SessionConfig sessionConfig, String origin, ITransaction transaction)`	Return the users, searching by the user's origin.
`String`	`getUserId(SessionConfig sessionConfig, String userLogin, ITransaction transaction)`	Deprecated. Since 4.0.10, replaced by `getUserIdByLogin(SessionConfig, String, ITransaction)`.
`String`	`getUserIdByLogin(SessionConfig sessionConfig, String userLogin, ITransaction transaction)`	Get the id for a user with the given login.
`void`	`setPassword(SessionConfig sessionConfig, String userId, String password, ITransaction transaction)`	Set a new password for the user
`void`	`update(SessionConfig sessionConfig, UserConfig userConfig, ITransaction transaction)`	Update the user configuration.

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

Method Detail

add
```
String add(SessionConfig sessionConfig,
           UserConfig userConfig,
           ITransaction transaction)
    throws ManagerException,
           PortalException
```
Adds a user to the portal and returns the identifier of the user added. If the userId is not provided, a new userId is created.

Parameters:

sessionConfig -

userConfig -

transaction -

Returns:

a String Identifier of the user added

Throws:

ManagerException

PortalException

get

UserConfig get(SessionConfig sessionConfig,
               String userId,
               ITransaction transaction)
        throws ManagerException,
               PortalException

Get user configuration from userId.

Parameters:: sessionConfig -; userId -; transaction -
Returns:: an UserConfig.
Throws:: ManagerException; PortalException

getUserId

@Deprecated
String getUserId(SessionConfig sessionConfig,
                 String userLogin,
                 ITransaction transaction)
          throws ManagerException,
                 PortalException

Deprecated.

Since 4.0.10, replaced by getUserIdByLogin(SessionConfig, String, ITransaction).

Get the userId from the userLogin

Parameters:: sessionConfig -; userLogin -; transaction -
Returns:: an UserConfig.
Throws:: ManagerException; PortalException
Since:: 4.0.4

getUserIdByLogin

String getUserIdByLogin(SessionConfig sessionConfig,
                        String userLogin,
                        ITransaction transaction)
                 throws ManagerException,
                        PortalException

Get the id for a user with the given login.

Parameters:: sessionConfig - the current user session information.; userLogin - the login.; transaction - the transaction for persistence access.
Returns:: the userId.
Throws:: ManagerException; PortalException
Since:: 4.0.10

delete

void delete(SessionConfig sessionConfig,
            String userId,
            ITransaction transaction)
     throws ManagerException,
            PortalException

Delete an user.

Parameters:: sessionConfig -; userId -; transaction -
Throws:: ManagerException; PortalException

update

void update(SessionConfig sessionConfig,
            UserConfig userConfig,
            ITransaction transaction)
     throws ManagerException,
            PortalException

Update the user configuration.

Parameters:: sessionConfig -; userConfig -; transaction -
Throws:: ManagerException; PortalException

setPassword

void setPassword(SessionConfig sessionConfig,
                 String userId,
                 String password,
                 ITransaction transaction)
          throws ManagerException,
                 PortalException

Set a new password for the user

Parameters:: sessionConfig -; userId -; password -; transaction -
Throws:: ManagerException; PortalException

getByChannelId

Collection<UserConfig> getByChannelId(SessionConfig sessionConfig,
                                      String channelId,
                                      ITransaction transaction)
                               throws ManagerException,
                                      PortalException

Returns the local users of the specified channel

Parameters:: sessionConfig -; channelId -; transaction -
Returns:: an aray of UserConfig.
Throws:: ManagerException; PortalException

addOrUpdate

void addOrUpdate(SessionConfig sessionConfig,
                 UserConfig userConfig,
                 ITransaction transaction)
          throws ManagerException,
                 PortalException

Throws:: ManagerException; PortalException

addAlternativeLogin

void addAlternativeLogin(SessionConfig sessionConfig,
                         String userId,
                         String newLogin,
                         ITransaction transaction)
                  throws PortalException

Adds an alternative login for an user.

Parameters:: sessionConfig - the user session information.; userId - the user id.; newLogin - the new alternative login.; transaction - the transaction for persistence access.
Throws:: PortalException
Since:: 4.0.8

getAlternativeLogins

Collection<String> getAlternativeLogins(SessionConfig sessionConfig,
                                        String userId,
                                        ITransaction transaction)
                                 throws PortalException

Returns the alternative logins for an user.

Parameters:: sessionConfig - the user session information.; userId - the user id.; transaction - the transaction for persistence access.
Throws:: PortalException
Since:: 4.0.8

deleteAlternativeLogin

void deleteAlternativeLogin(SessionConfig sessionConfig,
                            String loginToDelete,
                            ITransaction transaction)
                     throws PortalException

Deletes an alternative login.

Parameters:: sessionConfig - the user session information.; loginToDelete - the login to be deleted.; transaction - the transaction for persistence access.
Throws:: PortalException
Since:: 4.0.8

getByOrigin

Collection<UserConfig> getByOrigin(SessionConfig sessionConfig,
                                   String origin,
                                   ITransaction transaction)
                            throws ManagerException,
                                   PortalException

Return the users, searching by the user's origin.

Parameters:: sessionConfig - the user session information.; origin - the origin.; transaction - the transaction for persistence access.
Returns:: the UserConfig instances, or an empty collection if none was found.
Throws:: DaoException; PortalException; ManagerException
Since:: 4.0.8

Interface IUserManager