|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.security.CmsPrincipal
org.opencms.file.CmsUser
A user principal in the OpenCms permission system.
A user in OpenCms is uniquely definded by its user named returned by
.CmsPrincipal.getName()
Basic users in OpenCms are of type
.
This means that the user can access the OpenCms Workplace.
Moreover, the user must be created by another user with the
USER_TYPE_SYSTEMUSER
.
This user type is for "content managers" that actually have write permissions in
at last some parts of the VFS.CmsRole.ACCOUNT_MANAGER
Another possible type of users is
.
These users do not have access to the OpenCms Workplace.
However, a web user can be created by every user, for example the "Guest" user.
The main use case is that web users are used for users of the website that
can generate their own accounts, in a "please register your account..." scenario.
These web user accounts can then be used to
build personalized web sites. A web user is created using
USER_TYPE_WEBUSER
.CmsObject.addWebUser(String, String, String, String, Map)
CmsGroup
Field Summary | |
static int |
USER_TYPE_SYSTEMUSER
Identifies the system user type. |
static int |
USER_TYPE_WEBUSER
Identifies the web user type. |
Fields inherited from class org.opencms.security.CmsPrincipal |
m_description, m_flags, m_id, m_name |
Fields inherited from interface org.opencms.security.I_CmsPrincipal |
FLAG_CORE_LIMIT, FLAG_DISABLED, FLAG_ENABLED, FLAG_GROUP_PROJECT_MANAGER, FLAG_GROUP_PROJECT_USER, FLAG_GROUP_WORKFLOW_ROLE, PRINCIPAL_GROUP, PRINCIPAL_USER |
Constructor Summary | |
CmsUser()
Creates a new, empty OpenCms user principal. |
|
CmsUser(CmsUUID id,
java.lang.String name,
java.lang.String description)
Creates a new OpenCms user principal. |
|
CmsUser(CmsUUID id,
java.lang.String name,
java.lang.String password,
java.lang.String description,
java.lang.String firstname,
java.lang.String lastname,
java.lang.String email,
long lastlogin,
int flags,
java.util.Map additionalInfo,
java.lang.String address,
int type)
Creates a new OpenCms user principal. |
Method Summary | |
static void |
checkEmail(java.lang.String email)
Validates an email address. |
void |
checkName(java.lang.String name)
Checks if the provided user name is a valid user name and can be used as an argument value for CmsPrincipal.setName(String) . |
static void |
checkZipCode(java.lang.String zipcode)
Validates a zip code. |
java.lang.Object |
clone()
|
void |
deleteAdditionalInfo(java.lang.String key)
Deletes a value from this users "additional information" storage map. |
java.util.Map |
getAdditionalInfo()
Returns this users complete "additional information" storage map. |
java.lang.Object |
getAdditionalInfo(java.lang.String key)
Returns a value from this users "additional information" storage map, or null if no value for the given key is available. |
java.lang.String |
getAddress()
Returns the address line of this user. |
java.lang.String |
getCity()
Returns the city information of this user. |
java.lang.String |
getCountry()
Returns the country information of this user. |
boolean |
getDisabled()
Deprecated. use CmsPrincipal.isEnabled() instead |
java.lang.String |
getEmail()
Returns the email address of this user. |
java.lang.String |
getFirstname()
Returns the firstname of this user. |
java.lang.String |
getFullName()
Returns the "full" name of the this user in the format "{firstname} {lastname} ({username})" . |
static java.lang.String |
getFullName(CmsUser user)
Returns the "full" name of the given user in the format "{firstname} {lastname} ({username})" ,
or the empty String "" if the user is null. |
long |
getLastlogin()
Returns the time of the last login of this user. |
java.lang.String |
getLastname()
Returns the lastname of this user. |
java.lang.String |
getPassword()
Returns the encrypted user password. |
int |
getType()
Returns the type of this user. |
java.lang.String |
getZipcode()
Returns the zip code information of this user. |
boolean |
isGroup()
Returns true if this principal is of type . |
boolean |
isGuestUser()
Returns true if this user is the default guest user. |
boolean |
isSystemUser()
Returns true if this user is a "system user". |
static boolean |
isSystemUser(int type)
Returns true if the provided user type indicates a system user. |
boolean |
isTouched()
Returns true if this user was touched. |
boolean |
isUser()
Returns true if this principal is of type . |
boolean |
isWebUser()
Returns true if this user is a "web user". |
static boolean |
isWebUser(int type)
Returns true if the provided user type indicates a web user. |
void |
setAdditionalInfo(java.util.Map additionalInfo)
Sets this users complete "additional information" storage map to the given value. |
void |
setAdditionalInfo(java.lang.String key,
java.lang.Object value)
Stores a value in this users "additional information" storage map with the gicen access key. |
void |
setAddress(java.lang.String address)
Sets the address line of this user. |
void |
setCity(java.lang.String city)
Sets the city information of this user. |
void |
setCountry(java.lang.String country)
Sets the country information of this user. |
void |
setDisabled()
Deprecated. use CmsPrincipal.setEnabled(boolean) instead |
void |
setEmail(java.lang.String email)
Sets the email address of this user. |
void |
setEnabled()
Deprecated. use CmsPrincipal.setEnabled(boolean) instead |
void |
setFirstname(java.lang.String firstname)
Sets the first name of this user. |
void |
setLastlogin(long value)
Sets the last login timestamp of this user. |
void |
setLastname(java.lang.String lastname)
Sets the last name of this user. |
void |
setPassword(java.lang.String value)
Sets the password of this user. |
protected void |
setType(int value)
Sets the type of this user. |
void |
setZipcode(java.lang.String zipcode)
Sets the zip code information of this user. |
java.lang.String |
toString()
|
void |
touch()
Sets the "touched" status of this user to true . |
Methods inherited from class org.opencms.security.CmsPrincipal |
equals, filterCore, filterCoreFlag, filterFlag, getDescription, getFlags, getId, getName, getPrefixedGroup, getPrefixedName, getPrefixedUser, hashCode, isEnabled, readPrefixedPrincipal, readPrincipal, setDescription, setEnabled, setFlags, setName |
Methods inherited from class java.lang.Object |
finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.opencms.security.I_CmsPrincipal |
equals, getDescription, getFlags, getId, getName, getPrefixedName, hashCode, isEnabled, setDescription, setEnabled, setFlags, setName |
Field Detail |
public static final int USER_TYPE_SYSTEMUSER
public static final int USER_TYPE_WEBUSER
Constructor Detail |
public CmsUser()
Mostly intented to be used with the org.opencms.workplace.tools.accounts.A_CmsEditUserDialog
.
public CmsUser(CmsUUID id, java.lang.String name, java.lang.String description)
id
- the unique id of the new username
- the unique name of the new userdescription
- the description of the new userpublic CmsUser(CmsUUID id, java.lang.String name, java.lang.String password, java.lang.String description, java.lang.String firstname, java.lang.String lastname, java.lang.String email, long lastlogin, int flags, java.util.Map additionalInfo, java.lang.String address, int type)
id
- the unique id of the new username
- the unique name of the new userpassword
- the password of the userdescription
- the description of the new userfirstname
- the first namelastname
- the last nameemail
- the email addresslastlogin
- time stampflags
- flagsadditionalInfo
- user related informationaddress
- the addresstype
- the type of this userMethod Detail |
public static void checkEmail(java.lang.String email)
That means, the parameter should only be composed by digits and standard english letters, points, underscores and exact one "At" symbol.
email
- the email to validatepublic static void checkZipCode(java.lang.String zipcode)
That means, the parameter should only be composed by digits and standard english letters.
zipcode
- the zipcode to validatepublic static java.lang.String getFullName(CmsUser user)
"{firstname} {lastname} ({username})"
,
or the empty String ""
if the user is null.
user
- the user to get the full name from
getFullName()
public static boolean isSystemUser(int type)
true
if the provided user type indicates a system user.
type
- the user type to check
public static boolean isWebUser(int type)
true
if the provided user type indicates a web user.
type
- the user type to check
public void checkName(java.lang.String name) throws CmsIllegalArgumentException
CmsPrincipal.setName(String)
.
checkName
in interface I_CmsPrincipal
name
- the user name to check
CmsIllegalArgumentException
- if the check failspublic java.lang.Object clone()
Object.clone()
public void deleteAdditionalInfo(java.lang.String key)
key
- the additional user information to deletegetAdditionalInfo()
public java.util.Map getAdditionalInfo()
The "additional information" storage map is a simple java.util#Map
that can be used to store any key / value pairs for the user.
Some information parts of the users address are stored in this map
by default. The map is serialized when the user is stored in the database.
public java.lang.Object getAdditionalInfo(java.lang.String key)
null
if no value for the given key is available.
key
- selects the value to return from the "additional information" storage map
getAdditionalInfo()
public java.lang.String getAddress()
public java.lang.String getCity()
This informaion is stored in the "additional information" storage map
using the key
.CmsUserSettings.ADDITIONAL_INFO_CITY
public java.lang.String getCountry()
This informaion is stored in the "additional information" storage map
using the key
.CmsUserSettings.ADDITIONAL_INFO_COUNTRY
public boolean getDisabled()
CmsPrincipal.isEnabled()
instead
true
if this user is disabled.
true
if this user is disabledpublic java.lang.String getEmail()
public java.lang.String getFirstname()
public java.lang.String getFullName()
"{firstname} {lastname} ({username})"
.
public long getLastlogin()
public java.lang.String getLastname()
public java.lang.String getPassword()
public int getType()
Possible options are
for a "system user",
or USER_TYPE_SYSTEMUSER
for a "web user".USER_TYPE_WEBUSER
public java.lang.String getZipcode()
This informaion is stored in the "additional information" storage map
using the key
.CmsUserSettings.ADDITIONAL_INFO_ZIPCODE
public boolean isGroup()
I_CmsPrincipal
true
if this principal is of type CmsGroup
.
isGroup
in interface I_CmsPrincipal
isGroup
in class CmsPrincipal
I_CmsPrincipal.isGroup()
public boolean isGuestUser()
true
if this user is the default guest user.
public boolean isSystemUser()
true
if this user is a "system user".
public boolean isTouched()
true
if this user was touched.
public boolean isUser()
I_CmsPrincipal
true
if this principal is of type CmsUser
.
isUser
in interface I_CmsPrincipal
isUser
in class CmsPrincipal
I_CmsPrincipal.isUser()
public boolean isWebUser()
true
if this user is a "web user".
public void setAdditionalInfo(java.util.Map additionalInfo)
additionalInfo
- the complete "additional information" map to setgetAdditionalInfo()
public void setAdditionalInfo(java.lang.String key, java.lang.Object value)
key
- the key to store the value undervalue
- the value to store in the users "additional information" storage mapgetAdditionalInfo()
public void setAddress(java.lang.String address)
address
- the address line to setpublic void setCity(java.lang.String city)
city
- the city information to setpublic void setCountry(java.lang.String country)
country
- the city information to setpublic void setDisabled()
CmsPrincipal.setEnabled(boolean)
instead
public void setEmail(java.lang.String email)
email
- the email address to setpublic void setEnabled()
CmsPrincipal.setEnabled(boolean)
instead
public void setFirstname(java.lang.String firstname)
firstname
- the name to setpublic void setLastlogin(long value)
value
- the last login timestamp to setpublic void setLastname(java.lang.String lastname)
lastname
- the name to setpublic void setPassword(java.lang.String value)
value
- the password to setpublic void setZipcode(java.lang.String zipcode)
zipcode
- the zip code information to setpublic java.lang.String toString()
toString
in interface java.security.Principal
Object.toString()
public void touch()
true
.
protected void setType(int value)
Possible options are
for a "system user",
or USER_TYPE_SYSTEMUSER
for a "web user".USER_TYPE_WEBUSER
value
- the type to set
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |