Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> flexstor >> common >> data >> ejb >> [ user overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

com.flexstor.common.data.ejb.user
Class UserData  

java.lang.Object
  com.flexstor.common.data.ejb.Data
      com.flexstor.common.data.ejb.user.UserData

All Implemented Interfaces:

java.io.Serializable

---

public class UserData

extends com.flexstor.common.data.ejb.Data

This class supports state data for User. A Data class holds
all of the state information for a corresponding class and reference
pointers to other classes

Since:

FLEXSTOR.db 3.0

Version:

1.0, 10/19/98

---

Field Summary
protected  java.sql.Timestamp	currentTimestamp
protected  com.flexstor.common.keys.ejb.EmailAddressKey	emailAddressKey
protected  java.lang.String	firstName
protected  com.flexstor.common.keys.ejb.FtpAddressKey	ftpAddressKey
protected  com.flexstor.common.keys.ejb.GroupCollectionKey	groupKey
protected  java.lang.String	lastName
protected  java.lang.String	overrideRole
protected  java.lang.String	password
protected  java.util.Vector	properties
protected  com.flexstor.common.data.ejb.role.RoleData	roleData
protected  java.lang.String	sEmailAddress
protected  java.lang.String	sFtpAddress
protected  java.lang.String	userid
protected  com.flexstor.common.keys.ejb.UserKey	userKey
protected  java.util.Vector	vAssignedGroups

 

Fields inherited from class com.flexstor.common.data.ejb.Data

DELETE, DELETED, derived, htModifiedStates, htOptions, MODIFY, modTime, NEW_ENTRY, presentState, prevState, UNCHANGED, UPDATED, WARN_BEFORE_DELETE

 

Constructor Summary

UserData()           Default constructor for the UserData class

UserData(java.lang.String aUserID, java.lang.String aPassword)           Constructor for the UserData class

 

Method Summary
boolean	equals(java.lang.Object o)           Determine if these two objects are equal, i.e.
java.util.Vector	getAssignedGroups()           Gets the list of GroupData objects for the groups this user has been assigned to through the Admin Tool.
java.lang.String	getEmailAddress()           This will retrieve the String email address.
com.flexstor.common.keys.ejb.EmailAddressKey	getEMailAddressKey()           Return an object reference to user's email address
java.lang.String	getFirstName()           Return the user's first name
java.lang.String	getFtpAddress()           This will retrieve the String ftp address.
com.flexstor.common.keys.ejb.FtpAddressKey	getFtpAddressKey()           Return an object reference to user's default ftp server
com.flexstor.common.keys.ejb.GroupCollectionKey	getGroupKey()           Return an object reference to collection of groups the user is assigned to
com.flexstor.common.keys.ejb.UserKey	getKey()           Return the reference to this object
java.lang.String	getLanguage()           This will get the language definition for user
java.lang.String	getLastName()           Return the user's last name
boolean	getOverrideRole()           Return the boolean indicator that states whether a user's individual Role or the Group Role should be used when properties in those roles conflict.
java.lang.String	getOverrideRoleAsIndicator()           Return the String indicator that states whether a user's individual Role or the Group Role should be used.
java.lang.String	getPassword()           Return the user's encrypted password
java.lang.String	getProperty(java.lang.String key)           Get property where it accepts a property String and returns the value
java.util.Vector	getPropertyDataObjects()           This will return a list of properties.
com.flexstor.common.keys.ejb.UserKey	getReference()           Deprecated. see getKey()
com.flexstor.common.data.ejb.role.RoleData	getRoleData()           Return the user's role data
com.flexstor.common.keys.ejb.RoleKey	getRoleKey()           Return an object reference to user's default role
java.sql.Timestamp	getTimestamp()           Return the timestamp of this object in database when the object was retrieved
java.lang.String	getUserID()           Return the user's id that uniquely identifies the user to the FLEXSTOR system
int	hashCode()           Get a value that represents this Object, as uniquely as possible within the confines of an int.
void	setAssignedGroups(java.util.Vector vAssignedGroups)           Sets the list of GroupData objects for the groups this user has been assigned to through the Admin Tool.
void	setEMailAddress(com.flexstor.common.keys.ejb.EmailAddressKey anEMailAddressKey)           Assign an email address to a user
void	setEmailAddress(java.lang.String addr)           Set the String email address.
void	setEMailAddressKey(com.flexstor.common.keys.ejb.EmailAddressKey aKey)           Assign the primary key to the user's email address
void	setFirstName(java.lang.String aFirstName)           Assign the user's first name
void	setFtpAddress(com.flexstor.common.keys.ejb.FtpAddressKey anFtpAddressKey)           Assign an ftp address to auser
void	setFtpAddress(java.lang.String addr)           Set the String ftp address.
void	setFtpAddressKey(com.flexstor.common.keys.ejb.FtpAddressKey aKey)           Assign the primary key to the user's ftp address
void	setGroupKey(com.flexstor.common.keys.ejb.GroupCollectionKey aKey)           Assign the primary key to a user's collection of groups
void	setKey(com.flexstor.common.keys.ejb.UserKey aKey)           Assign the reference to this record
void	setLanguage(java.lang.String lang)           This will set the language definition for user
void	setLastName(java.lang.String aLastName)           Assign the user's last name
void	setOverrideRole(java.lang.String aOverrideIndicator)           Assign the user's override indicator.
void	setPassword(java.lang.String aPassword)           Assign the user's password
void	setProperty(java.lang.String key, java.lang.String value)           Set a property where it accepts a property String and value
void	setPropertyDataObjects(java.util.Vector props)           Set a list of properties.
void	setReference(com.flexstor.common.keys.ejb.UserKey aKey)           Deprecated. see setKey()
void	setRoleData(com.flexstor.common.data.ejb.role.RoleData aRoleData)           Assign a role to a user
void	setRoleKey(com.flexstor.common.keys.ejb.RoleKey aKey)           Assign the primary key to the user's role
void	setTimestamp(java.sql.Timestamp aTimeStamp)           Assign the current timestamp of the object
void	setUserID(java.lang.String aUserID)           Assign the user's identification
java.lang.String	toString()           Convert this Object to a human-readable String.

 

Methods inherited from class com.flexstor.common.data.ejb.Data

assertEquals, changed, fillCloneInfo, getDateModTime, getModTime, getPresentState, getPreviousState, initializeState, isDeleted, isDerived, isModified, isModified, isObjectPersist, isOptionAllowed, resetModifiedStates, rollBackState, setDeleted, setDerived, setModifiedState, setModTime, setModTime, setNewEntry, setOption, setPerisistState, setPreviousState, setState, setUpdated

 

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

 

Field Detail

userid

protected java.lang.String userid

---

password

protected java.lang.String password

---

firstName

protected java.lang.String firstName

---

lastName

protected java.lang.String lastName

---

overrideRole

protected java.lang.String overrideRole

---

currentTimestamp

protected java.sql.Timestamp currentTimestamp

---

userKey

protected com.flexstor.common.keys.ejb.UserKey userKey

---

roleData

protected com.flexstor.common.data.ejb.role.RoleData roleData

---

groupKey

protected com.flexstor.common.keys.ejb.GroupCollectionKey groupKey

---

emailAddressKey

protected com.flexstor.common.keys.ejb.EmailAddressKey emailAddressKey

---

sFtpAddress

protected java.lang.String sFtpAddress

---

sEmailAddress

protected java.lang.String sEmailAddress

---

ftpAddressKey

protected com.flexstor.common.keys.ejb.FtpAddressKey ftpAddressKey

---

properties

protected java.util.Vector properties

---

vAssignedGroups

protected java.util.Vector vAssignedGroups

Constructor Detail

UserData

public UserData()

Default constructor for the UserData class

Warning Any objects created with this constructor are not updatable or insertable to the database

---

UserData

public UserData(java.lang.String aUserID,
                java.lang.String aPassword)

Constructor for the UserData class

Warning Any objects created with this constructor are not updatable (insertable, but not updatable) to the database

Method Detail

equals

public boolean equals(java.lang.Object o)

Determine if these two objects are equal, i.e. their attributes are equal. This method will not test the equality of references to other objects

---

hashCode

public int hashCode()

Description copied from class: java.lang.Object

Get a value that represents this Object, as uniquely as possible within the confines of an int.

There are some requirements on this method which subclasses must follow:

• Semantic equality implies identical hashcodes. In other words, if a.equals(b) is true, then a.hashCode() == b.hashCode() must be as well. However, the reverse is not necessarily true, and two objects may have the same hashcode without being equal.
• It must be consistent. Whichever value o.hashCode() returns on the first invocation must be the value returned on all later invocations as long as the object exists. Notice, however, that the result of hashCode may change between separate executions of a Virtual Machine, because it is not invoked on the same object.

Notice that since hashCode is used in java.util.Hashtable and other hashing classes, a poor implementation will degrade the performance of hashing (so don't blindly implement it as returning a constant!). Also, if calculating the hash is time-consuming, a class may consider caching the results.

The default implementation returns System.identityHashCode(this)

---

getEMailAddressKey

public com.flexstor.common.keys.ejb.EmailAddressKey getEMailAddressKey()

Return an object reference to user's email address

---

getFirstName

public java.lang.String getFirstName()

Return the user's first name

---

getFtpAddressKey

public com.flexstor.common.keys.ejb.FtpAddressKey getFtpAddressKey()

Return an object reference to user's default ftp server

---

getGroupKey

public com.flexstor.common.keys.ejb.GroupCollectionKey getGroupKey()

Return an object reference to collection of groups the user is assigned to

---

getLastName

public java.lang.String getLastName()

Return the user's last name

---

getOverrideRole

public boolean getOverrideRole()

Return the boolean indicator that states whether a user's individual Role or the Group Role should be used when properties in those roles conflict. An example is default language.

---

getOverrideRoleAsIndicator

public java.lang.String getOverrideRoleAsIndicator()

Return the String indicator that states whether a user's individual Role or the Group Role should be used.

"Y" = Yes "N" = No

---

getPassword

public java.lang.String getPassword()

Return the user's encrypted password

---

getReference

public com.flexstor.common.keys.ejb.UserKey getReference()

Deprecated. see getKey()

Return the reference to this object

---

getKey

public com.flexstor.common.keys.ejb.UserKey getKey()

Return the reference to this object

---

getRoleData

public com.flexstor.common.data.ejb.role.RoleData getRoleData()

Return the user's role data

---

getRoleKey

public com.flexstor.common.keys.ejb.RoleKey getRoleKey()

Return an object reference to user's default role

---

getTimestamp

public java.sql.Timestamp getTimestamp()

Return the timestamp of this object in database when the object was retrieved

---

getUserID

public java.lang.String getUserID()

Return the user's id that uniquely identifies the user to the FLEXSTOR system

---

setEMailAddress

public void setEMailAddress(com.flexstor.common.keys.ejb.EmailAddressKey anEMailAddressKey)

Assign an email address to a user

---

setEMailAddressKey

public void setEMailAddressKey(com.flexstor.common.keys.ejb.EmailAddressKey aKey)

Assign the primary key to the user's email address

---

setEmailAddress

public void setEmailAddress(java.lang.String addr)

Set the String email address. For the full email address, the user should use the EMailPersistBean.

---

setFtpAddress

public void setFtpAddress(java.lang.String addr)

Set the String ftp address. For the full ftp address, the user should use the FtpPersistBean.

---

getEmailAddress

public java.lang.String getEmailAddress()

This will retrieve the String email address.

---

getFtpAddress

public java.lang.String getFtpAddress()

This will retrieve the String ftp address.

---

getLanguage

public java.lang.String getLanguage()

This will get the language definition for user

---

setLanguage

public void setLanguage(java.lang.String lang)

This will set the language definition for user

---

setFirstName

public void setFirstName(java.lang.String aFirstName)

Assign the user's first name

---

setFtpAddress

public void setFtpAddress(com.flexstor.common.keys.ejb.FtpAddressKey anFtpAddressKey)

Assign an ftp address to auser

---

setFtpAddressKey

public void setFtpAddressKey(com.flexstor.common.keys.ejb.FtpAddressKey aKey)

Assign the primary key to the user's ftp address

---

setGroupKey

public void setGroupKey(com.flexstor.common.keys.ejb.GroupCollectionKey aKey)

Assign the primary key to a user's collection of groups

---

setLastName

public void setLastName(java.lang.String aLastName)

Assign the user's last name

---

setOverrideRole

public void setOverrideRole(java.lang.String aOverrideIndicator)

Assign the user's override indicator. This switch states whether a user's individual Role or the Group Role should be used.

---

setPassword

public void setPassword(java.lang.String aPassword)

Assign the user's password

---

setReference

public void setReference(com.flexstor.common.keys.ejb.UserKey aKey)

Deprecated. see setKey()

Assign the reference to this record

---

setKey

public void setKey(com.flexstor.common.keys.ejb.UserKey aKey)

Assign the reference to this record

---

setRoleData

public void setRoleData(com.flexstor.common.data.ejb.role.RoleData aRoleData)

Assign a role to a user

---

setRoleKey

public void setRoleKey(com.flexstor.common.keys.ejb.RoleKey aKey)

Assign the primary key to the user's role

---

setTimestamp

public void setTimestamp(java.sql.Timestamp aTimeStamp)

Assign the current timestamp of the object

---

setUserID

public void setUserID(java.lang.String aUserID)

Assign the user's identification

---

getPropertyDataObjects

public java.util.Vector getPropertyDataObjects()

This will return a list of properties.

---

getProperty

public java.lang.String getProperty(java.lang.String key)

Get property where it accepts a property String and returns the value

---

setPropertyDataObjects

public void setPropertyDataObjects(java.util.Vector props)

Set a list of properties. Vector is a collection of import com.flexstor.common.data.ejb.property.PropertyData objects

---

setProperty

public void setProperty(java.lang.String key,
                        java.lang.String value)

Set a property where it accepts a property String and value

---

setAssignedGroups

public void setAssignedGroups(java.util.Vector vAssignedGroups)

Sets the list of GroupData objects for the groups this user has been assigned to through the Admin Tool. This method will be invoked by the Admin Tool prior to calling the UserPersistBean to update the database.

---

getAssignedGroups

public java.util.Vector getAssignedGroups()

Gets the list of GroupData objects for the groups this user has been assigned to through the Admin Tool. This method will be invoked by the UserPersistBean to update the database.

---

toString

public java.lang.String toString()

Description copied from class: java.lang.Object

Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() 55 and such.

It is typical, but not required, to ensure that this method never completes abruptly with a java.lang.RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> flexstor >> common >> data >> ejb >> [ user overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---