Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> com >> opencms >> [ file overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of com.opencms.file.CmsUser JAVADOC | Sourc code of com.opencms.file.CmsUser SOURCE | Download com.opencms.file.CmsUser DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.opencms.file
Class CmsUser  view CmsUser download CmsUser.java

java.lang.Object
  extended bycom.opencms.file.CmsUser
All Implemented Interfaces:
java.lang.Cloneable, com.opencms.core.I_CmsConstants
public class CmsUser
extends java.lang.Object
implements com.opencms.core.I_CmsConstants, java.lang.Cloneable

Describes the Cms user object and the methods to access it.

Version:
$Revision: 1.33 $ $Date: 2003/04/01 15:20:18 $

Field Summary
private  java.util.Hashtable m_additionalInfo
          A storage for additional user information.
private  java.lang.String m_address
          The address of the user.
private  CmsGroup m_defaultGroup
          The default group of this user.
private  int m_defaultGroupId
          The default group ID of this user.
private  java.lang.String m_description
          The description of the user.
private  java.lang.String m_email
          The email of the user.
private  java.lang.String m_firstname
          The firstname of the user.
private  int m_flags
          The flags of the user.
private  int m_id
          The Id of this user.
private  long m_lastlogin
          The last login of the user.
private  java.lang.String m_lastname
          The lastname of the user.
private  long m_lastused
          The lastused date.
private  java.lang.String m_name
          The login-name of the user.
private  java.lang.String m_password
          The password of the user.
private  java.lang.String m_recoveryPassword
          The password of the user.
private  java.lang.String m_section
          The section of the user.
private  int m_type
          Defines if the user is a webuser or a systemuser.
 
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, java.lang.String name, java.lang.String description)
          Constructor, creates a new Cms user object.
CmsUser(int id, java.lang.String name, java.lang.String password, java.lang.String recoveryPassword, java.lang.String description, java.lang.String firstname, java.lang.String lastname, java.lang.String email, long lastlogin, long lastused, int flags, java.util.Hashtable additionalInfo, CmsGroup defaultGroup, java.lang.String address, java.lang.String section, int typ)
          Constructor, creates a new Cms user object.
 
Method Summary
 java.lang.Object clone()
          Clones the CmsResource by creating a new CmsUser Object.
 boolean equals(java.lang.Object obj)
          Compares the given object with this user.
 java.util.Hashtable getAdditionalInfo()
          Returns the complete Hashtable with additional information about the user.
 java.lang.Object getAdditionalInfo(java.lang.String key)
          Returns additional information about the user which are usually set in the users preferences.
 java.lang.String getAddress()
          Gets the address.
 CmsGroup getDefaultGroup()
          Returns the default group object of this user.
 int getDefaultGroupId()
          Gets the defaultgroup id.
 java.lang.String getDescription()
          Gets the description of this user.
 boolean getDisabled()
          Decides, if this user is disabled.
 java.lang.String getEmail()
          Gets the email.
 java.lang.String getFirstname()
          Gets the firstname.
 int getFlags()
          Gets the flags.
 int getId()
          Gets the id of this user.
 long getLastlogin()
          Gets the lastlogin.
 java.lang.String getLastname()
          Gets the lastname.
 long getLastUsed()
          Gets the lastlogin.
 java.lang.String getName()
          Gets the login-name of the user.
 java.lang.String getPassword()
          Gets the password.
 java.lang.String getRecoveryPassword()
          Gets the recovery password.
 java.lang.String getSection()
          Gets the section of the user.
 int getType()
          Gets the type of the user (webuser or a systemuser).
(package private)  void setAdditionalInfo(java.util.Hashtable additionalInfo)
          Sets the complete Hashtable with additional information about the user.
 void setAdditionalInfo(java.lang.String key, java.lang.Object obj)
          Sets additional information about the user.
 void setAddress(java.lang.String value)
          Sets the address.
 void setDefaultGroup(CmsGroup defaultGroup)
          Sets the default group object of this user.
 void setDescription(java.lang.String value)
          Sets the description of this user.
 void setDisabled()
          Disables the user flags by setting them to C_FLAG_DISABLED.
 void setEmail(java.lang.String value)
          Sets the email.
 void setEnabled()
          Enables the user flags by setting them to C_FLAG_ENABLED.
 void setFirstname(java.lang.String firstname)
          Sets the firstname.
(package private)  void setFlags(int value)
          Sets the flags.
 void setLastlogin(long value)
          Sets the lastlogin.
 void setLastname(java.lang.String lastname)
          Gets the lastname.
(package private)  void setLastUsed(long value)
          Sets the lastlogin.
 void setPassword(java.lang.String value)
          Sets the password.
 void setSection(java.lang.String value)
          Sets the section of the user.
(package private)  void setType(int value)
          Sets the typ.
 java.lang.String toString()
          Returns a string-representation for this object.
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

m_name

private java.lang.String m_name
The login-name of the user.

m_id

private int m_id
The Id of this user.

m_password

private java.lang.String m_password
The password of the user.

m_recoveryPassword

private java.lang.String m_recoveryPassword
The password of the user.

m_description

private java.lang.String m_description
The description of the user.

m_additionalInfo

private java.util.Hashtable m_additionalInfo
A storage for additional user information.

m_defaultGroup

private CmsGroup m_defaultGroup
The default group of this user.

m_defaultGroupId

private int m_defaultGroupId
The default group ID of this user.

m_section

private java.lang.String m_section
The section of the user.

m_flags

private int m_flags
The flags of the user.

m_email

private java.lang.String m_email
The email of the user.

m_lastused

private long m_lastused
The lastused date.

m_firstname

private java.lang.String m_firstname
The firstname of the user.

m_lastname

private java.lang.String m_lastname
The lastname of the user.

m_address

private java.lang.String m_address
The address of the user.

m_lastlogin

private long m_lastlogin
The last login of the user.

m_type

private int m_type
Defines if the user is a webuser or a systemuser. C_USER_TYPE_SYSTEMUSER for systemuser (incl. guest). C_USER_TYPE_WEBUSER for webuser.

Constructor Detail

CmsUser

public CmsUser(int id,
               java.lang.String name,
               java.lang.String description)
Constructor, creates a new Cms user object.

CmsUser

public CmsUser(int id,
               java.lang.String name,
               java.lang.String password,
               java.lang.String recoveryPassword,
               java.lang.String description,
               java.lang.String firstname,
               java.lang.String lastname,
               java.lang.String email,
               long lastlogin,
               long lastused,
               int flags,
               java.util.Hashtable additionalInfo,
               CmsGroup defaultGroup,
               java.lang.String address,
               java.lang.String section,
               int typ)
Constructor, creates a new Cms user object.

Method Detail

clone

public java.lang.Object clone()
Clones the CmsResource by creating a new CmsUser Object.

equals

public boolean equals(java.lang.Object obj)
Compares the given object with this user.

getAdditionalInfo

public java.util.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 java.lang.Object getAdditionalInfo(java.lang.String key)
Returns additional information about the user which are usually set in the users preferences.

getAddress

public java.lang.String getAddress()
Gets the address.

getDefaultGroup

public CmsGroup getDefaultGroup()
Returns the default group object of this user.

getDefaultGroupId

public int getDefaultGroupId()
Gets the defaultgroup id.

getDescription

public java.lang.String getDescription()
Gets the description of this user.

getDisabled

public boolean getDisabled()
Decides, if this user is disabled.

getEmail

public java.lang.String getEmail()
Gets the email.

getFirstname

public java.lang.String getFirstname()
Gets the firstname.

getFlags

public int getFlags()
Gets the flags.

getId

public int getId()
Gets the id of this user.

getLastlogin

public long getLastlogin()
Gets the lastlogin.

getLastname

public java.lang.String getLastname()
Gets the lastname.

getLastUsed

public long getLastUsed()
Gets the lastlogin.

getName

public java.lang.String getName()
Gets the login-name of the user.

getPassword

public java.lang.String getPassword()
Gets the password.

getRecoveryPassword

public java.lang.String getRecoveryPassword()
Gets the recovery password.

getSection

public java.lang.String getSection()
Gets the section of the user.

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.

setAdditionalInfo

public void setAdditionalInfo(java.lang.String key,
                              java.lang.Object obj)
Sets additional information about the user.
Additional infos are for example emailadress, adress or surname...

setAdditionalInfo

void setAdditionalInfo(java.util.Hashtable additionalInfo)
Sets the complete Hashtable with additional information about the user.
Additional infos are for example emailadress, adress or surname...

This method has package-visibility for security-reasons. It is required to because of the use of two seprate databases for user data and additional user data.

setAddress

public void setAddress(java.lang.String value)
Sets the address.

setDefaultGroup

public void setDefaultGroup(CmsGroup defaultGroup)
Sets the default group object of this user.

setDescription

public void setDescription(java.lang.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(java.lang.String value)
Sets the email.

setEnabled

public void setEnabled()
Enables the user flags by setting them to C_FLAG_ENABLED.

setFirstname

public void setFirstname(java.lang.String firstname)
Sets the firstname.

setFlags

void setFlags(int value)
Sets the flags.

setLastlogin

public void setLastlogin(long value)
Sets the lastlogin.

setLastname

public void setLastname(java.lang.String lastname)
Gets the lastname.

setLastUsed

void setLastUsed(long value)
Sets the lastlogin.

setPassword

public void setPassword(java.lang.String value)
Sets the password.

setSection

public void setSection(java.lang.String value)
Sets the section of the user.

setType

void setType(int value)
Sets the typ.

toString

public java.lang.String toString()
Returns a string-representation for this object. This can be used for debugging.

Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> com >> opencms >> [ file overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of com.opencms.file.CmsUser JAVADOC | Sourc code of com.opencms.file.CmsUser SOURCE | Download com.opencms.file.CmsUser DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD