lumis.portal.user
Class UserConfig

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

All Implemented Interfaces:

Cloneable, ICacheEntry, ICloneableCacheEntry

@StableMinor(version="5.5",
             sinceVersion="4.0")
public class UserConfig
extends Object
implements ICloneableCacheEntry

Represents a portal user

Since:

4.0.6

Field Summary

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

UserConfig()

Method Summary

UserConfig	clone()
String	getChannelId()
String	getEmail()
String	getFirstName()
String	getFullName()
String	getId()
String	getLastName()
String	getLogin()
String	getMiddleName()
String	getOrigin() Returns the origin of this user.
String	getPassword()
int	getType()
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)
void	setFirstName(String firstName)
void	setId(String id)
void	setLastName(String lastName)
void	setLogin(String login)
void	setMiddleName(String middleName)
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	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

public String getEmail()

setEmail

public void setEmail(String email)

getFirstName

public String getFirstName()

setFirstName

public void setFirstName(String firstName)

getId

public String getId()

setId

public void setId(String id)

getLastName

public String getLastName()

setLastName

public void setLastName(String lastName)

getLogin

public String getLogin()

setLogin

public void setLogin(String login)

getMiddleName

public String getMiddleName()

setMiddleName

public void setMiddleName(String middleName)

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)

getFullName

public String getFullName()