com.opencms.file
Class CmsUser
java.lang.Object
|
+--com.opencms.file.CmsUser
- All Implemented Interfaces:
- Cloneable, I_CmsConstants
- public class CmsUser
- extends Object
- implements I_CmsConstants, Cloneable
Describes the Cms user object and the methods to access it.
- Version:
- $Revision: 1.33 $ $Date: 2003/04/01 15:20:18 $
- Author:
- Michael Emmerich
| Fields inherited from interface com.opencms.core.I_CmsConstants |
C_ACCESS_DEFAULT_FLAGS, C_ACCESS_GROUP, C_ACCESS_GROUP_READ, C_ACCESS_GROUP_VISIBLE, C_ACCESS_GROUP_WRITE, C_ACCESS_INTERNAL_READ, C_ACCESS_OWNER, C_ACCESS_OWNER_READ, C_ACCESS_OWNER_VISIBLE, C_ACCESS_OWNER_WRITE, C_ACCESS_PUBLIC, C_ACCESS_PUBLIC_READ, C_ACCESS_PUBLIC_VISIBLE, C_ACCESS_PUBLIC_WRITE, C_ACCESS_READ, C_ACCESS_VISIBLE, C_ACCESS_WRITE, C_ADDITIONAL_INFO_EXPLORERSETTINGS, C_ADDITIONAL_INFO_PREFERENCES, C_ADDITIONAL_INFO_STARTSETTINGS, C_ADDITIONAL_INFO_TASKSETTINGS, C_ADDITIONAL_INFO_TOWN, C_ADDITIONAL_INFO_ZIPCODE, C_AT_LEAST_ONCE, C_CLUSTERURL, C_CONFIGURATION_CACHE, C_CONFIGURATION_CLASS, C_CONFIGURATION_REGISTRY, C_CONFIGURATION_RESOURCEBROKER, C_COPYRIGHT, C_DEFAULT_SITE, C_DELETE_HISTORY, C_ENABLE_HISTORY, C_ERRPREFIX, C_ERRSPERATOR, C_EXPORT_TAG_ACCESS, C_EXPORT_TAG_ADDRESS, C_EXPORT_TAG_CREATOR, C_EXPORT_TAG_DATE, C_EXPORT_TAG_DEFAULTGROUP, C_EXPORT_TAG_DESCRIPTION, C_EXPORT_TAG_DESTINATION, C_EXPORT_TAG_EMAIL, C_EXPORT_TAG_EXPORT, C_EXPORT_TAG_FILE, C_EXPORT_TAG_FIRSTNAME, C_EXPORT_TAG_FLAGS, C_EXPORT_TAG_GROUP, C_EXPORT_TAG_GROUPDATA, C_EXPORT_TAG_GROUPNAME, C_EXPORT_TAG_INFO, C_EXPORT_TAG_LASTMODIFIED, C_EXPORT_TAG_LASTNAME, C_EXPORT_TAG_LAUNCHER_START_CLASS, C_EXPORT_TAG_MODULEXPORT, C_EXPORT_TAG_NAME, C_EXPORT_TAG_OC_VERSION, C_EXPORT_TAG_PARENTGROUP, C_EXPORT_TAG_PASSWORD, C_EXPORT_TAG_PROJECT, C_EXPORT_TAG_PROPERTIES, C_EXPORT_TAG_PROPERTY, C_EXPORT_TAG_RECOVERYPASSWORD, C_EXPORT_TAG_SECTION, C_EXPORT_TAG_SOURCE, C_EXPORT_TAG_TYPE, C_EXPORT_TAG_USER, C_EXPORT_TAG_USERDATA, C_EXPORT_TAG_USERGROUPDATA, C_EXPORT_TAG_USERGROUPS, C_EXPORT_TAG_USERINFO, C_EXPORT_TAG_VALUE, C_EXPORT_TAG_VERSION, C_EXPORT_VERSION, C_EXPORT_XMLFILENAME, C_EXPORTONLYFILES, C_EXPORTONLYUSERS, C_EXPORTPOINT, C_EXPORTPOINT_PATH, C_EXPORTUSERSFILES, C_FCONTENT, C_FELEMENT, C_FILE, C_FILECONTENT, C_FILES_IMPORTED, C_FLAG_DISABLED, C_FLAG_ENABLED, C_FLAG_GROUP_PROJECTCOWORKER, C_FLAG_GROUP_PROJECTMANAGER, C_FLAG_GROUP_ROLE, C_FOLDER, C_FOLDER_SEPARATOR, C_GROUP, C_GROUP_ADMIN, C_GROUP_GUEST, C_GROUP_PROJECTLEADER, C_GROUP_USERS, C_LINKCHECKTABLE_DATE, C_MAX_LENGTH_RESOURCE_NAME, C_MODULE_PROPERTY_ADDITIONAL_RESOURCES, C_MODULE_PROPERTY_ADDITIONAL_RESOURCES_SEPARATOR, C_MODUS_AUTO, C_MODUS_EXPORT, C_MODUS_EXTERN, C_MODUS_OFFLINE, C_MODUS_ONLINE, C_MOUNTPOINT_FILESYSTEM, C_MOUNTPOINT_MYSQL, C_NEVER, C_NO_FILES_IMPORTED, C_ORDER_AGENTUSER, C_ORDER_ENDTIME, C_ORDER_ID, C_ORDER_INITIATORUSER, C_ORDER_NAME, C_ORDER_ORIGINALUSER, C_ORDER_PERCENTAGE, C_ORDER_PRIORITY, C_ORDER_ROLE, C_ORDER_STARTTIME, C_ORDER_STATE, C_ORDER_TASKTYPE, C_ORDER_TIMEOUT, C_ORDER_WAKEUPTIME, C_PASSWORD_MINIMUMSIZE, C_PROJECT_ONLINE, C_PROJECT_ONLINE_ID, C_PROJECT_STATE_ARCHIVE, C_PROJECT_STATE_INVISIBLE, C_PROJECT_STATE_LOCKED, C_PROJECT_STATE_UNLOCKED, C_PROJECT_TYPE_INVISIBLE, C_PROJECT_TYPE_NORMAL, C_PROJECT_TYPE_TEMPORARY, C_PROPERTY_ACTIV, C_PROPERTY_CHANNELID, C_PROPERTY_CONTENT_ENCODING, C_PROPERTY_DEFAULT_FILE, C_PROPERTY_DESCRIPTION, C_PROPERTY_EXPORT, C_PROPERTY_EXPORTNAME, C_PROPERTY_KEYWORDS, C_PROPERTY_NAVPOS, C_PROPERTY_NAVTEXT, C_PROPERTY_RELATIVEROOT, C_PROPERTY_TEMPLATETYPE, C_PROPERTY_TITLE, C_PROPERTY_VISIBLE, C_PUBLISH_METHOD_LINK, C_REGISTRY_DESTINATION, C_REGISTRY_HISTORY, C_REGISTRY_KNOWNLAUNCHERS, C_REGISTRY_LAUNCHER, C_REGISTRY_SOURCE, C_REQUEST_CONSOLE, C_REQUEST_HTTP, C_RESPONSE_CONSOLE, C_RESPONSE_HTTP, C_ROOT, C_ROOT_TEMPLATE_NAME, C_ROOTNAME_COS, C_ROOTNAME_VFS, C_SESSION_ADMIN_POS, C_SESSION_BROADCASTMESSAGE, C_SESSION_CONTENT_ENCODING, C_SESSION_CURRENTGROUP, C_SESSION_DATA, C_SESSION_IS_DIRTY, C_SESSION_MESSAGEPENDING, C_SESSION_MODULE_VECTOR, C_SESSION_PROJECT, C_SESSION_THREAD_ERROR, C_SESSION_USERNAME, C_SORT_ASC, C_SORT_DESC, C_START_ACCESSFLAGS, C_START_DEFAULTGROUP, C_START_LANGUAGE, C_START_LOCKDIALOG, C_START_PROJECT, C_START_VIEW, C_STATE_CHANGED, C_STATE_DELETED, C_STATE_NEW, C_STATE_UNCHANGED, C_STATICEXPORT_PATH, C_STATICEXPORT_START, C_SYNCHRONISATION_PATH, C_SYNCHRONISATION_PROJECT, C_SYNCHRONISATION_RESOURCE, C_SYNCHRONISATION_RESOURCETAG, C_SYSTEMPROPERTY_CRONTABLE, C_SYSTEMPROPERTY_EXPORTPATH, C_SYSTEMPROPERTY_EXTENSIONS, C_SYSTEMPROPERTY_LINKCHECKTABLE, C_SYSTEMPROPERTY_MIMETYPES, C_SYSTEMPROPERTY_MOUNTPOINT, C_SYSTEMPROPERTY_RESOURCE_TYPE, C_TABLE_CHANNELID, C_TASK_FILTER, C_TASK_MESSAGES, C_TASK_MESSAGES_ACCEPTED, C_TASK_MESSAGES_COMPLETED, C_TASK_MESSAGES_FORWARDED, C_TASK_MESSAGES_MEMBERS, C_TASK_ORDER_BY_DATE, C_TASK_ORDER_BY_NAME, C_TASK_PRIORITY_HIGH, C_TASK_PRIORITY_LOW, C_TASK_PRIORITY_NORMAL, C_TASK_STATE_ENDED, C_TASK_STATE_HALTED, C_TASK_STATE_NOTENDED, C_TASK_STATE_PREPARE, C_TASK_STATE_START, C_TASK_STATE_STARTED, C_TASK_VIEW_ALL, C_TASKLOG_SYSTEM, C_TASKLOG_USER, C_TASKORDER_NONE, C_TASKORDER_STARTDATE, C_TASKORDER_TIMEOUT, C_TASKS_ACTIVE, C_TASKS_ALL, C_TASKS_DONE, C_TASKS_NEW, C_TASKS_OPEN, C_TASKSORDER_TASKNAME, C_TEMP_PREFIX, C_TFACCESS, C_TFGROUP, C_TFILEOBJ, C_TFILES, C_TFNAME, C_TFPROPERTYINFO, C_TFPROPERTYNAME, C_TFPROPERTYTYPE, C_TFPROPERTYVALUE, C_TFTYPE, C_TFTYPENAME, C_TFUSER, C_TGDESC, C_TGFLAG, C_TGNAME, C_TGPARENTGROUP, C_TGROUPOBJ, C_TGROUPS, C_TGROUPUSERS, C_TGUSER, C_TUADDINFO, C_TUDESC, C_TUDGROUP, C_TUDISABLED, C_TUEMAIL, C_TUFIRSTNAME, C_TUFLAG, C_TUGROUP, C_TUINFOKEY, C_TUINFOVALUE, C_TULOGIN, C_TUNAME, C_TUPASSWD, C_TUSERGROUPS, C_TUSEROBJ, C_TUSERS, C_TYPE_BODY_NAME, C_TYPE_COMPATIBLEPLAIN_NAME, C_TYPE_FOLDER, C_TYPE_FOLDER_NAME, C_TYPE_IMAGE_NAME, C_TYPE_LAST_INDEX, C_TYPE_PAGE_NAME, C_TYPE_PLAIN_NAME, C_UNKNOWN_ID, C_UNKNOWN_INT, C_UNKNOWN_LAUNCHER, C_UNKNOWN_LAUNCHER_ID, C_UNKNOWN_LONG, C_URL_PREFIX_EXPORT, C_URL_PREFIX_HTTP, C_URL_PREFIX_HTTPS, C_URL_PREFIX_SERVERNAME, C_USER, C_USER_ADMIN, C_USER_GUEST, C_USER_TYPE_SYSTEMANDWEBUSER, C_USER_TYPE_SYSTEMUSER, C_USER_TYPE_WEBUSER, C_WEB_APP_REPLACE_KEY, C_WEEKS_HISTORY, C_WHATEVER, C_XML_BODY_ELEMENT |
|
Constructor Summary |
CmsUser(int id,
String name,
String description)
Constructor, creates a new Cms user object. |
CmsUser(int id,
String name,
String password,
String recoveryPassword,
String description,
String firstname,
String lastname,
String email,
long lastlogin,
long lastused,
int flags,
Hashtable additionalInfo,
CmsGroup defaultGroup,
String address,
String section,
int typ)
Constructor, creates a new Cms user object. |
CmsUser
public CmsUser(int id,
String name,
String description)
- Constructor, creates a new Cms user object.
- Parameters:
id - The id of the new user.name - The name of the new user.description - The description of the new user.
CmsUser
public CmsUser(int id,
String name,
String password,
String recoveryPassword,
String description,
String firstname,
String lastname,
String email,
long lastlogin,
long lastused,
int flags,
Hashtable additionalInfo,
CmsGroup defaultGroup,
String address,
String section,
int typ)
- Constructor, creates a new Cms user object.
- Parameters:
id - The id of the new user.name - The name of the new user.description - The description of the new user.
clone
public Object clone()
- Clones the CmsResource by creating a new CmsUser Object.
- Overrides:
clone in class Object
- Returns:
- Cloned CmsUser.
equals
public boolean equals(Object obj)
- Compares the given object with this user.
- Overrides:
equals in class Object
- Returns:
- true if the object is equal, false otherwise
getAdditionalInfo
public Hashtable getAdditionalInfo()
- Returns the complete Hashtable with additional information about the user.
Additional infos are for example emailadress, adress or surname...
The additional infos must be requested via the CmsObject.
Returns additional information about the user.
getAdditionalInfo
public Object getAdditionalInfo(String key)
- Returns additional information about the user which are usually set
in the users preferences.
- Parameters:
key - the key to the additional information.
- Returns:
- additional information Object about the user, if the additional info
does not exists, it returns
null
getAddress
public String getAddress()
- Gets the address.
- Returns:
- the USER_ADDRESS, or null.
getDefaultGroup
public CmsGroup getDefaultGroup()
- Returns the default group object of this user.
- Returns:
- Default Group of the user
getDefaultGroupId
public int getDefaultGroupId()
- Gets the defaultgroup id.
- Returns:
- the USER_DEFAULTGROUP_ID, or null.
getDescription
public String getDescription()
- Gets the description of this user.
- Returns:
- the description of this user.
getDisabled
public boolean getDisabled()
- Decides, if this user is disabled.
- Returns:
- USER_FLAGS == C_FLAG_DISABLED
getEmail
public String getEmail()
- Gets the email.
- Returns:
- the USER_EMAIL, or null.
getFirstname
public String getFirstname()
- Gets the firstname.
- Returns:
- the USER_FIRSTNAME, or null.
getFlags
public int getFlags()
- Gets the flags.
- Returns:
- the USER_FLAGS, or C_UNKNOWN_INT.
getId
public int getId()
- Gets the id of this user.
- Returns:
- the id of this user.
getLastlogin
public long getLastlogin()
- Gets the lastlogin.
- Returns:
- the USER_LASTLOGIN, or C_UNKNOWN_LONG.
getLastname
public String getLastname()
- Gets the lastname.
- Returns:
- the USER_SURNAME, or null.
getLastUsed
public long getLastUsed()
- Gets the lastlogin.
- Returns:
- the USER_LASTLOGIN, or C_UNKNOWN_LONG.
getName
public String getName()
- Gets the login-name of the user.
- Returns:
- the login-name of the user.
getPassword
public String getPassword()
- Gets the password.
- Returns:
- the USER_PASSWORD, or null.
getRecoveryPassword
public String getRecoveryPassword()
- Gets the recovery password.
- Returns:
- the USER_RECOVERY_PASSWORD, or null.
getSection
public String getSection()
- Gets the section of the user.
- Returns:
- the USER_SECTION, or null.
getType
public int getType()
- Gets the type of the user (webuser or a systemuser).
C_USER_TYPE_SYSTEMUSER for systemuser (incl. guest).
C_USER_TYPE_WEBUSER for webuser.
- Returns:
- the type, or C_UNKNOWN_INT.
setAdditionalInfo
public void setAdditionalInfo(String key,
Object obj)
- Sets additional information about the user.
Additional infos are for example emailadress, adress or surname...
- Parameters:
key - The key to the additional information.obj - The additinoal information value.
setAddress
public void setAddress(String value)
- Sets the address.
- Parameters:
value - The user adress.
setDefaultGroup
public void setDefaultGroup(CmsGroup defaultGroup)
- Sets the default group object of this user.
- Parameters:
defaultGroup - The default group of this user.
setDescription
public void setDescription(String value)
- Sets the description of this user.
setDisabled
public void setDisabled()
- Disables the user flags by setting them to C_FLAG_DISABLED.
setEmail
public void setEmail(String value)
- Sets the email.
setEnabled
public void setEnabled()
- Enables the user flags by setting them to C_FLAG_ENABLED.
setFirstname
public void setFirstname(String firstname)
- Sets the firstname.
setLastlogin
public void setLastlogin(long value)
- Sets the lastlogin.
- Parameters:
value - The new user section.
setLastname
public void setLastname(String lastname)
- Gets the lastname.
- Returns:
- the USER_SURNAME, or null.
setPassword
public void setPassword(String value)
- Sets the password.
setSection
public void setSection(String value)
- Sets the section of the user.
- Parameters:
value - The new user section.
toString
public String toString()
- Returns a string-representation for this object.
This can be used for debugging.
- Overrides:
toString in class Object
- Returns:
- string-representation for this object.