UserConfig

java.lang.Object
- lumis.portal.user.UserConfig

All Implemented Interfaces:

Cloneable, ICacheEntry, ICloneableCacheEntry
```
@StableMinor(version="12.4",
             sinceVersion="4.0")
public class UserConfig
extends Object
implements ICloneableCacheEntry
```
Represents a portal user

Since:

4.0.6

Version:

$Revision: 23904 $ $Date: 2020-06-16 15:23:44 +0000 (Tue, 16 Jun 2020) $

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`USER_ADMINISTRATOR_ID`
`static String`	`USER_FRAMEWORKCLOCK_ID`
`static String`	`USER_GUEST_ID`
`static String`	`USER_PAGECACHE_ID`
`static String`	`USER_SYSTEM_ID`
`static int`	`USER_TYPE_COMMON`
`static int`	`USER_TYPE_FRAMEWORK`

Constructor Summary

Constructors
Constructor and Description

UserConfig()

Constructors
Constructor and Description
`UserConfig()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`UserConfig`	`clone()`
`Map<String,String>`	`getAttributes()` Deprecated. Since 11.0.0 replaced by `getCustomAttributes()` due to the inclusion of the possibility of attributes having values of different types. For backwards compatibility, this map reflects the map returned by `getCustomAttributes()` but converts values to/from String according to the attribute type.
`String`	`getChannelId()`
`Map<String,Object>`	`getCustomAttributes()` Deprecated. Since 12.0.0, due to introduction of trusted and untrusted properties, replaced by `getTrustedProperties().getCustomAttributes()`.
`String`	`getEmail()` Deprecated. Since 12.0.0, due to introduction of trusted and untrusted properties, replaced by `getTrustedProperties().getEmail()`.
`String`	`getFirstName()` Deprecated. Since 12.0.0, due to introduction of trusted and untrusted properties, replaced by `getTrustedProperties().getFirstName()`.
`String`	`getFriendlyId()` Returns the friendly identifier of this user.
`String`	`getFullName()` Deprecated. Since 12.0.0, due to introduction of trusted and untrusted properties, replaced by `getTrustedProperties().getFullName()`.
`String`	`getId()`
`Date`	`getLastLogin()` Returns the date and time of last login for this user.
`String`	`getLastName()` Deprecated. Since 12.0.0, due to introduction of trusted and untrusted properties, replaced by `getTrustedProperties().getLastName()`.
`String`	`getLogin()`
`String`	`getMiddleName()` Deprecated. Since 12.0.0, due to introduction of trusted and untrusted properties, replaced by `getTrustedProperties().getMiddleName()`.
`String`	`getOrigin()` Returns the origin of this user.
`String`	`getPassword()`
`String`	`getProfileImageHref()` Returns the href of this user profile image.
`IUserPropertiesReadOnly`	`getProperties()` Returns a read-only view of this user's properties, merging trusted and untrusted properties.
`IUserProperties`	`getTrustedProperties()` Returns this user's trusted properties.
`int`	`getType()`
`IUserProperties`	`getUntrustedProperties()` Returns this user's untrusted properties.
`long`	`getVisitorId()` Returns the visitor identifier of this user.
`boolean`	`isDisabled()`
`boolean`	`isMultiSession()`
`boolean`	`isPortalLogin()` Indicates if this user may be logged in normally by the portal's default authenticator.
`void`	`setChannelId(String channelId)`
`void`	`setDisabled(boolean disabled)`
`void`	`setEmail(String email)` Deprecated. Since 12.0.0, due to introduction of trusted and untrusted properties, replaced by `getTrustedProperties().setEmail()`.
`void`	`setFirstName(String firstName)` Deprecated. Since 12.0.0, due to introduction of trusted and untrusted properties, replaced by `getTrustedProperties().setFirstName()`.
`void`	`setId(String id)`
`void`	`setLastName(String lastName)` Deprecated. Since 12.0.0, due to introduction of trusted and untrusted properties, replaced by `getTrustedProperties().setLastName()`.
`void`	`setLogin(String login)`
`void`	`setMiddleName(String middleName)` Deprecated. Since 12.0.0, due to introduction of trusted and untrusted properties, replaced by `getTrustedProperties().setMiddleName()`.
`void`	`setMultiSession(boolean multiSession)`
`void`	`setOrigin(String origin)` Sets the origin for this user.
`void`	`setPassword(String password)`
`void`	`setPortalLogin(boolean portalLogin)` Sets if this user may be logged in normally by the portal's default authenticator.
`void`	`setProfileImage(InputStream imageStream, String mimeType)` Sets the profile image of the given user.
`void`	`setType(int type)`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - USER_ADMINISTRATOR_ID
```
public static final String USER_ADMINISTRATOR_ID
```
    See Also:
    
    Constant Field Values
  - USER_GUEST_ID
```
public static final String USER_GUEST_ID
```
    See Also:
    
    Constant Field Values
  - USER_FRAMEWORKCLOCK_ID
```
public static final String USER_FRAMEWORKCLOCK_ID
```
    See Also:
    
    Constant Field Values
  - USER_PAGECACHE_ID
```
public static final String USER_PAGECACHE_ID
```
    See Also:
    
    Constant Field Values
  - USER_SYSTEM_ID
```
public static final String USER_SYSTEM_ID
```
    See Also:
    
    Constant Field Values
  - USER_TYPE_COMMON
```
public static final int USER_TYPE_COMMON
```
    See Also:
    
    Constant Field Values
  - USER_TYPE_FRAMEWORK
```
public static final int USER_TYPE_FRAMEWORK
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - UserConfig
```
public UserConfig()
```
- Method Detail
  - clone
```
public UserConfig clone()
```
    Specified by:
    
    clone in interface ICloneableCacheEntry
    
    Overrides:
    
    clone in class Object
  - isPortalLogin
```
public boolean isPortalLogin()
```
    Indicates if this user may be logged in normally by the portal's default authenticator.
    Users whose passwords are authenticated externally and should not use the password in the portal database must have this attribute set to false to prevent from being authenticated against the password stored in the portal database.
    
    Returns:
    
    if this user may be logged in normally by the portal's default authenticator.
    
    Since:
    
    4.0.8
  - setPortalLogin
```
public void setPortalLogin(boolean portalLogin)
```
    Sets if this user may be logged in normally by the portal's default authenticator.
    
    Parameters:
    
    portalLogin - the value to set.
    
    Since:
    
    4.0.8
    
    See Also:
    
    isPortalLogin()
  - getOrigin
```
public String getOrigin()
```
    Returns the origin of this user. The origin is used to identify from where the user was added, for example, was imported from an external repository.
    
    Returns:
    
    the origin of this user. null indicates the user was added normally.
    
    Since:
    
    4.0.8
  - setOrigin
```
public void setOrigin(String origin)
```
    Sets the origin for this user.
    
    Parameters:
    
    origin - the origin to set.
    
    Since:
    
    4.0.8
    
    See Also:
    
    getOrigin()
  - isDisabled
```
public boolean isDisabled()
```
  - setDisabled
```
public void setDisabled(boolean disabled)
```
  - getEmail
```
@Deprecated
public String getEmail()
```
    Deprecated. Since 12.0.0, due to introduction of trusted and untrusted properties, replaced by getTrustedProperties().getEmail().
  - setEmail
```
@Deprecated
public void setEmail(String email)
```
    Deprecated. Since 12.0.0, due to introduction of trusted and untrusted properties, replaced by getTrustedProperties().setEmail().
  - getFirstName
```
@Deprecated
public String getFirstName()
```
    Deprecated. Since 12.0.0, due to introduction of trusted and untrusted properties, replaced by getTrustedProperties().getFirstName().
  - setFirstName
```
@Deprecated
public void setFirstName(String firstName)
```
    Deprecated. Since 12.0.0, due to introduction of trusted and untrusted properties, replaced by getTrustedProperties().setFirstName().
  - getId
```
public String getId()
```
  - setId
```
public void setId(String id)
```
  - getLastName
```
@Deprecated
public String getLastName()
```
    Deprecated. Since 12.0.0, due to introduction of trusted and untrusted properties, replaced by getTrustedProperties().getLastName().
  - setLastName
```
@Deprecated
public void setLastName(String lastName)
```
    Deprecated. Since 12.0.0, due to introduction of trusted and untrusted properties, replaced by getTrustedProperties().setLastName().
  - getLogin
```
public String getLogin()
```
  - setLogin
```
public void setLogin(String login)
```
  - getMiddleName
```
@Deprecated
public String getMiddleName()
```
    Deprecated. Since 12.0.0, due to introduction of trusted and untrusted properties, replaced by getTrustedProperties().getMiddleName().
  - setMiddleName
```
@Deprecated
public void setMiddleName(String middleName)
```
    Deprecated. Since 12.0.0, due to introduction of trusted and untrusted properties, replaced by getTrustedProperties().setMiddleName().
  - isMultiSession
```
public boolean isMultiSession()
```
  - setMultiSession
```
public void setMultiSession(boolean multiSession)
```
  - getPassword
```
public String getPassword()
```
  - setPassword
```
public void setPassword(String password)
```
  - getType
```
public int getType()
```
  - setType
```
public void setType(int type)
```
  - getChannelId
```
public String getChannelId()
```
  - setChannelId
```
public void setChannelId(String channelId)
```
  - getProfileImageHref
```
public String getProfileImageHref()
```
    Returns the href of this user profile image.
    
    Returns:
    
    the href of this user profile image.
    
    Since:
    
    8.0.0
  - setProfileImage
```
public void setProfileImage(InputStream imageStream,
                            String mimeType)
                     throws PortalException
```
    Sets the profile image of the given user.
    
    Parameters:
    
    imageStream - an input stream of the image to set, or null if the current profile image, if any, is to be deleted. This stream will be consumed but not closed by this method.
    
    mimeType - the MIME type of the image. This parameter is ignored if imageStream is null.
    
    Throws:
    
    IllegalArgumentException - if the image stream parameter is not null and the mime type parameter is null.
    
    PortalException - if other error occur.
    
    Since:
    
    8.0.0
  - getFullName
```
@Deprecated
public String getFullName()
```
    Deprecated. Since 12.0.0, due to introduction of trusted and untrusted properties, replaced by getTrustedProperties().getFullName().
  - getLastLogin
```
public Date getLastLogin()
```
    Returns the date and time of last login for this user.
    
    Returns:
    
    the date, or null if this user never logged in.
    
    Since:
    
    6.2.0
  - getAttributes
```
@Deprecated
public Map<String,String> getAttributes()
```
    Deprecated. Since 11.0.0 replaced by getCustomAttributes() due to the inclusion of the possibility of attributes having values of different types. For backwards compatibility, this map reflects the map returned by getCustomAttributes() but converts values to/from String according to the attribute type.
    
    Returns the attributes.
    
    Returns:
    
    the attributes
    
    Since:
    
    8.1.1
  - getCustomAttributes
```
@Deprecated
public Map<String,Object> getCustomAttributes()
```
    Deprecated. Since 12.0.0, due to introduction of trusted and untrusted properties, replaced by getTrustedProperties().getCustomAttributes().
    
    Returns a map with the values of custom attributes of this user. To modify the value of custom attributes of this user, the returned map may be modified and the changes will be persisted when IUserManager.update(lumis.portal.authentication.SessionConfig, UserConfig, ITransaction) is called, like other user properties.
    
    Returns:
    
    a map where the key of the map is the attribute identifier and the value of the map is the attribute value, with a type that corresponds to the attribute data type.
    
    Since:
    
    11.0.0
  - getVisitorId
```
public long getVisitorId()
```
    Returns the visitor identifier of this user.
    
    Returns:
    
    the visitor identifier.
    
    Throws:
    
    IllegalStateException - if this user was not persisted or obtained using IUserManager, so its visitor identifier was not generated, or if this user is the special guest user.
    
    Since:
    
    12.0.0
  - getFriendlyId
```
public String getFriendlyId()
```
    Returns the friendly identifier of this user.
    
    Returns:
    
    the friendly identifier.
    
    Since:
    
    12.0.0
  - getTrustedProperties
```
public IUserProperties getTrustedProperties()
```
    Returns this user's trusted properties. The trusted properties represents properties provided by trusted sources such as an authenticated user and always overwrites any corresponding untrusted property.
    
    Returns:
    
    the trusted properties.
    
    Since:
    
    12.0.0
    
    See Also:
    
    getUntrustedProperties(), getProperties()
  - getUntrustedProperties
```
public IUserProperties getUntrustedProperties()
```
    Returns this user's untrusted properties. The untrusted properties represents properties provided by untrusted sources such as unauthenticated information collected by user monitoring. It is always overwritten by corresponding untrusted property.
    
    Returns:
    
    the untrusted properties.
    
    Since:
    
    12.0.0
    
    See Also:
    
    getTrustedProperties(), getProperties()
  - getProperties
```
public IUserPropertiesReadOnly getProperties()
```
    Returns a read-only view of this user's properties, merging trusted and untrusted properties.
    
    Returns:
    
    the properties.
    
    Since:
    
    12.0.0

Class UserConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

USER_ADMINISTRATOR_ID

USER_GUEST_ID

USER_FRAMEWORKCLOCK_ID

USER_PAGECACHE_ID

USER_SYSTEM_ID

USER_TYPE_COMMON

USER_TYPE_FRAMEWORK

Constructor Detail

UserConfig

Method Detail

clone

isPortalLogin

setPortalLogin

getOrigin

setOrigin

isDisabled

setDisabled

getEmail

setEmail

getFirstName

setFirstName

getId

setId

getLastName

setLastName

getLogin

setLogin

getMiddleName

setMiddleName

isMultiSession

setMultiSession

getPassword

setPassword

getType

setType

getChannelId

setChannelId

getProfileImageHref

setProfileImage

getFullName

getLastLogin

getAttributes

getCustomAttributes

getVisitorId

getFriendlyId

getTrustedProperties

getUntrustedProperties

getProperties