User (logicaldoc 6.8.3 API)

java.lang.Object
- com.logicaldoc.core.PersistentObject
- - com.logicaldoc.core.security.User

All Implemented Interfaces:

Serializable
```
public class User
extends PersistentObject
implements Serializable
```
This class represents a user. A user can be member of any number of groups, but it is always member of a special group named '_user_'+id. When a new user is created this special group of type 'user' is also created.

Version:

1.0

Author:

Michael Scholz, Marco Meschieri

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`SOURCE_ACTIVE_DIRECTORY`
`static int`	`SOURCE_DEFAULT`
`static int`	`SOURCE_LDAP`
`static int`	`TYPE_DEFAULT`
`static int`	`TYPE_SYSTEM`
`static long`	`USERID_ADMIN`

Constructor Summary

Constructors
Constructor and Description

User()

Constructors
Constructor and Description
`User()`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getCity()`
`String`	`getCountry()`
`String`	`getDecodedPassword()`
`String`	`getEmail()`
`int`	`getEnabled()`
`String`	`getFirstName()`
`String`	`getFullName()`
`long[]`	`getGroupIds()`
`String[]`	`getGroupNames()`
`Set<Group>`	`getGroups()`
`String`	`getIpBlackList()`
`String`	`getIpWhiteList()`
`String`	`getLanguage()`
`Locale`	`getLocale()`
`String`	`getName()`
`String`	`getPassword()`
`Date`	`getPasswordChanged()` When the password was modified
`int`	`getPasswordExpired()`
`int`	`getPasswordExpires()` If the password expires or not
`String`	`getPasswordmd4()`
`String`	`getPostalcode()`
`long`	`getQuota()`
`long`	`getQuotaCount()`
`String`	`getRepass()`
`String`	`getSignatureId()`
`String`	`getSignatureInfo()`
`int`	`getSource()` The source from which the user has been created
`String`	`getState()`
`String`	`getStreet()`
`String`	`getTelephone()`
`String`	`getTelephone2()`
`int`	`getType()`
`Group`	`getUserGroup()` Retrieves this user's group
`String`	`getUserGroupName()` The name of the group associated to this user, that is '_user_'+id
`String`	`getUserName()`
`Integer`	`getWelcomeScreen()`
`void`	`initGroupIdsAndNames()`
`boolean`	`isInGroup(String groupName)`
`void`	`reset()`
`void`	`setCity(String ct)`
`void`	`setCountry(String cnt)`
`void`	`setDecodedPassword(String pwd)` Sets the password and encode it
`void`	`setEmail(String mail)`
`void`	`setEnabled(int enabled)`
`void`	`setFirstName(String firstName)`
`void`	`setGroups(Set<Group> groups)`
`void`	`setIpBlackList(String ipBlackList)`
`void`	`setIpWhiteList(String ipWhiteList)`
`void`	`setLanguage(String lang)`
`void`	`setLocale(Locale locale)`
`void`	`setName(String name)`
`void`	`setPassword(String pwd)`
`void`	`setPasswordChanged(Date passwordChanged)`
`void`	`setPasswordExpired(int passwordExpired)`
`void`	`setPasswordExpires(int passwordExpires)`
`void`	`setPasswordmd4(String passwordmd4)`
`void`	`setPostalcode(String pc)`
`void`	`setQuota(long quota)`
`void`	`setQuotaCount(long quotaCount)`
`void`	`setRepass(String repass)`
`void`	`setSignatureId(String signatureId)`
`void`	`setSignatureInfo(String signatureInfo)`
`void`	`setSource(int source)`
`void`	`setState(String state)`
`void`	`setStreet(String str)`
`void`	`setTelephone(String phone)`
`void`	`setTelephone2(String telephone2)`
`void`	`setType(int type)`
`void`	`setUserName(String uname)`
`void`	`setWelcomeScreen(Integer welcomeScreen)`
`String`	`toString()`

Methods inherited from class com.logicaldoc.core.PersistentObject
equals, getDeleted, getId, getLastModified, hashCode, setDeleted, setId, setLastModified

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

TYPE_DEFAULT
```
public static int TYPE_DEFAULT
```

TYPE_SYSTEM
```
public static int TYPE_SYSTEM
```

SOURCE_DEFAULT
```
public static int SOURCE_DEFAULT
```

SOURCE_LDAP
```
public static int SOURCE_LDAP
```

SOURCE_ACTIVE_DIRECTORY

public static int SOURCE_ACTIVE_DIRECTORY

USERID_ADMIN
```
public static final long USERID_ADMIN
```
See Also:
Constant Field Values

Constructor Detail
- User
```
public User()
```

Method Detail

getType
```
public int getType()
```

setType
```
public void setType(int type)
```

getRepass
```
public String getRepass()
```

setRepass
```
public void setRepass(String repass)
```

getUserName
```
public String getUserName()
```

getPassword
```
public String getPassword()
```

getName
```
public String getName()
```

getFullName
```
public String getFullName()
```

getFirstName
```
public String getFirstName()
```

getStreet
```
public String getStreet()
```

getPostalcode
```
public String getPostalcode()
```

getCity
```
public String getCity()
```

getCountry
```
public String getCountry()
```

getLanguage
```
public String getLanguage()
```

getEmail
```
public String getEmail()
```

getTelephone
```
public String getTelephone()
```

getGroupIds
```
public long[] getGroupIds()
```

getGroupNames
```
public String[] getGroupNames()
```

isInGroup

public boolean isInGroup(String groupName)

setUserName

public void setUserName(String uname)

setPassword
```
public void setPassword(String pwd)
```

setDecodedPassword
```
public void setDecodedPassword(String pwd)
```
Sets the password and encode it

Parameters:
pwd - The password in readable format

setName
```
public void setName(String name)
```

setFirstName

public void setFirstName(String firstName)

setStreet
```
public void setStreet(String str)
```

setPostalcode
```
public void setPostalcode(String pc)
```

setCity
```
public void setCity(String ct)
```

setCountry
```
public void setCountry(String cnt)
```

setLanguage
```
public void setLanguage(String lang)
```

setEmail
```
public void setEmail(String mail)
```

setTelephone

public void setTelephone(String phone)

initGroupIdsAndNames
```
public void initGroupIdsAndNames()
```

reset
```
public void reset()
```

toString
```
public String toString()
```
Overrides:

toString in class PersistentObject

getGroups
```
public Set<Group> getGroups()
```

setGroups

public void setGroups(Set<Group> groups)

getUserGroupName
```
public String getUserGroupName()
```
The name of the group associated to this user, that is '_user_'+id

getUserGroup
```
public Group getUserGroup()
```
Retrieves this user's group

getEnabled
```
public int getEnabled()
```

setEnabled
```
public void setEnabled(int enabled)
```

getState
```
public String getState()
```

setState
```
public void setState(String state)
```

getTelephone2
```
public String getTelephone2()
```

setTelephone2

public void setTelephone2(String telephone2)

getLocale
```
public Locale getLocale()
```

setLocale
```
public void setLocale(Locale locale)
```

getPasswordChanged
```
public Date getPasswordChanged()
```
When the password was modified

setPasswordChanged

public void setPasswordChanged(Date passwordChanged)

getPasswordExpires
```
public int getPasswordExpires()
```
If the password expires or not

setPasswordExpires

public void setPasswordExpires(int passwordExpires)

getSource
```
public int getSource()
```
The source from which the user has been created

See Also:
SOURCE_DEFAULT, SOURCE_LDAP, SOURCE_ACTIVE_DIRECTORY

setSource
```
public void setSource(int source)
```

getQuota
```
public long getQuota()
```

setQuota
```
public void setQuota(long quota)
```

getQuotaCount
```
public long getQuotaCount()
```

setQuotaCount

public void setQuotaCount(long quotaCount)

getSignatureId
```
public String getSignatureId()
```

setSignatureId

public void setSignatureId(String signatureId)

getSignatureInfo
```
public String getSignatureInfo()
```

setSignatureInfo

public void setSignatureInfo(String signatureInfo)

getWelcomeScreen
```
public Integer getWelcomeScreen()
```

setWelcomeScreen

public void setWelcomeScreen(Integer welcomeScreen)

getIpWhiteList
```
public String getIpWhiteList()
```

setIpWhiteList

public void setIpWhiteList(String ipWhiteList)

getIpBlackList
```
public String getIpBlackList()
```

setIpBlackList

public void setIpBlackList(String ipBlackList)

getPasswordExpired
```
public int getPasswordExpired()
```

setPasswordExpired

public void setPasswordExpired(int passwordExpired)

getPasswordmd4
```
public String getPasswordmd4()
```

setPasswordmd4

public void setPasswordmd4(String passwordmd4)

getDecodedPassword
```
public String getDecodedPassword()
```

Class User

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.logicaldoc.core.PersistentObject

Methods inherited from class java.lang.Object

Field Detail

TYPE_DEFAULT

TYPE_SYSTEM

SOURCE_DEFAULT

SOURCE_LDAP

SOURCE_ACTIVE_DIRECTORY

USERID_ADMIN

Constructor Detail

User

Method Detail

getType

setType

getRepass

setRepass

getUserName

getPassword

getName

getFullName

getFirstName

getStreet

getPostalcode

getCity

getCountry

getLanguage

getEmail

getTelephone

getGroupIds

getGroupNames

isInGroup

setUserName

setPassword

setDecodedPassword

setName

setFirstName

setStreet

setPostalcode

setCity

setCountry

setLanguage

setEmail

setTelephone

initGroupIdsAndNames

reset

toString

getGroups

setGroups

getUserGroupName

getUserGroup

getEnabled

setEnabled

getState

setState

getTelephone2

setTelephone2

getLocale

setLocale

getPasswordChanged

setPasswordChanged

getPasswordExpires

setPasswordExpires

getSource

setSource

getQuota

setQuota

getQuotaCount

setQuotaCount

getSignatureId

setSignatureId

getSignatureInfo

setSignatureInfo

getWelcomeScreen

setWelcomeScreen

getIpWhiteList

setIpWhiteList