com.mf.roundhouse.core.domain
Class UserProfile

java.lang.Object
  KennewickObject
      com.mf.roundhouse.core.domain.RoundhouseObject
          com.mf.roundhouse.core.domain.UserProfile

All Implemented Interfaces:

java.security.Principal, RoundhousePrincipal, java.io.Serializable

public class UserProfile

extends RoundhouseObject

implements RoundhousePrincipal

Author:

Jeffrey Payne

See Also:

Serialized Form

Field Summary

static java.lang.String	DEFAULT_GROUP
static java.lang.String	EMAIL_ADDRESS
static java.lang.String	NAME
static java.lang.String	NICKNAME
static java.lang.String	NOTES
static java.lang.String	PASSWORD_HASH
static java.lang.String	PASSWORD_HISTORY
static java.lang.String	PERMISSIONS
static java.lang.String	REGISTRATION_DATE

Constructor Summary

UserProfile()

UserProfile(ObjectIdentifier anId)

Method Summary

void	delete(ITransaction aTransaction) Delete the UserProfile from the system.
java.util.Collection	getAllDeniedPermissions()
java.util.Collection	getAllGrantedPermissions()
UserGroup	getDefaultGroup()
ObjectIdentifier	getDefaultGroupId()
java.util.Collection	getDeniedPermissions()
java.lang.String	getEmailAddress()
java.util.Collection	getGrantedPermissions()
java.util.Collection	getGroups()
java.util.Date	getInitialLoginDate()
java.lang.String	getName()
java.lang.String	getNickname()
java.lang.String	getNotes()
java.lang.String	getPasswordHash()
java.util.Collection	getPasswordHistory()
boolean	getPasswordIsValid()
java.util.Collection	getPermissions()
java.util.Date	getRegistrationDate()
java.lang.String	getSecretAnswer()
SecretQuestion	getSecretQuestion()
ObjectIdentifier	getSecretQuestionId()
java.util.Date	getUserAgreeDate()
java.util.Hashtable	getUserProperties() Return a Hashtable of UserPropertyEntry objects keyed by the name of the associated UserProperty object.
java.util.Hashtable	getUserPropertiesOrderBySequence() Answer this users UserPropertyEntry objects sorted by the sequence of the associated UserProperty
UserPropertyEntry	getUserPropertyEntry(java.lang.String name)
java.lang.String	getUserPropertyValue(java.lang.String name)
boolean	isGuestUser()
boolean	isSecretAnswer(java.lang.String anAnswer, boolean secretQuestionEnabled)
void	setDefaultGroupId(ObjectIdentifier identifier)
void	setEmailAddress(java.lang.String string)
void	setInitialLoginDate(java.util.Date date)
void	setName(java.lang.String string)
void	setNickname(java.lang.String string)
void	setNotes(java.lang.String string)
void	setPasswordHash(java.lang.String string)
void	setPasswordHistory(java.util.Collection passwordHistory)
void	setPasswordIsValid(boolean passwordIsValid)
void	setPermissions(java.util.Collection permissions)
void	setRegistrationDate(java.util.Date date)
void	setSecretAnswer(java.lang.String secretAnswer)
void	setSecretQuestion(SecretQuestion secretQuestion)
void	setSecretQuestionId(ObjectIdentifier identifier)
void	setUserAgreeDate(java.util.Date date)
void	setUserProperties(java.util.Hashtable map) Establish the UserPropertyEntry objects Hashtable.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.mf.roundhouse.core.domain.RoundhousePrincipal

getIdString, getObjectIdentifier

Methods inherited from interface java.security.Principal

equals, hashCode, toString

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

EMAIL_ADDRESS

public static final java.lang.String EMAIL_ADDRESS

See Also:

Constant Field Values

PASSWORD_HASH

public static final java.lang.String PASSWORD_HASH

See Also:

Constant Field Values

NICKNAME

public static final java.lang.String NICKNAME

See Also:

Constant Field Values

REGISTRATION_DATE

public static final java.lang.String REGISTRATION_DATE

See Also:

Constant Field Values

NOTES

public static final java.lang.String NOTES

See Also:

Constant Field Values

DEFAULT_GROUP

public static final java.lang.String DEFAULT_GROUP

See Also:

Constant Field Values

PASSWORD_HISTORY

public static final java.lang.String PASSWORD_HISTORY

See Also:

Constant Field Values

PERMISSIONS

public static final java.lang.String PERMISSIONS

See Also:

Constant Field Values

Constructor Detail

UserProfile

public UserProfile(ObjectIdentifier anId)
            throws java.lang.Exception

Parameters:

anId -

Throws:

java.lang.Exception

UserProfile

public UserProfile()

Throws:

java.lang.Exception

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface RoundhousePrincipal

getEmailAddress

public java.lang.String getEmailAddress()

getPasswordHash

public java.lang.String getPasswordHash()

setEmailAddress

public void setEmailAddress(java.lang.String string)

Parameters:

string -

setName

public void setName(java.lang.String string)

Parameters:

string -

setPasswordHash

public void setPasswordHash(java.lang.String string)

Parameters:

string -

getNickname

public java.lang.String getNickname()

setNickname

public void setNickname(java.lang.String string)

Parameters:

string -

getAllDeniedPermissions

public java.util.Collection getAllDeniedPermissions()
                                             throws java.lang.Exception

Specified by:

getAllDeniedPermissions in interface RoundhousePrincipal

Returns:

Throws:

java.lang.Exception

getRegistrationDate

public java.util.Date getRegistrationDate()

setRegistrationDate

public void setRegistrationDate(java.util.Date date)

Parameters:

date -

getNotes

public java.lang.String getNotes()

Returns:

setNotes

public void setNotes(java.lang.String string)

Parameters:

string -

isGuestUser

public boolean isGuestUser()

getGroups

public java.util.Collection getGroups()
                               throws java.lang.Exception

Throws:

java.lang.Exception

getAllGrantedPermissions

public java.util.Collection getAllGrantedPermissions()
                                              throws java.lang.Exception

Specified by:

getAllGrantedPermissions in interface RoundhousePrincipal

Throws:

java.lang.Exception

getDefaultGroupId

public ObjectIdentifier getDefaultGroupId()

Returns:

setDefaultGroupId

public void setDefaultGroupId(ObjectIdentifier identifier)

Parameters:

identifier -

getDefaultGroup

public UserGroup getDefaultGroup()
                          throws java.lang.Exception

Returns:

Throws:

java.lang.Exception

getSecretAnswer

public java.lang.String getSecretAnswer()

Returns:

Returns the secretAnswer.

setSecretAnswer

public void setSecretAnswer(java.lang.String secretAnswer)

Parameters:

secretAnswer - The secretAnswer to set.

getSecretQuestion

public SecretQuestion getSecretQuestion()
                                 throws java.lang.Exception

Returns:

Returns the secretQuestion.

Throws:

java.lang.Exception

setSecretQuestion

public void setSecretQuestion(SecretQuestion secretQuestion)

Parameters:

secretQuestion - The secretQuestion to set.

isSecretAnswer

public boolean isSecretAnswer(java.lang.String anAnswer,
                              boolean secretQuestionEnabled)

getInitialLoginDate

public java.util.Date getInitialLoginDate()

Returns:

setInitialLoginDate

public void setInitialLoginDate(java.util.Date date)

Parameters:

date -

getUserAgreeDate

public java.util.Date getUserAgreeDate()

Returns:

setUserAgreeDate

public void setUserAgreeDate(java.util.Date date)

Parameters:

date -

getSecretQuestionId

public ObjectIdentifier getSecretQuestionId()

Returns:

setSecretQuestionId

public void setSecretQuestionId(ObjectIdentifier identifier)

Parameters:

identifier -

getUserProperties

public java.util.Hashtable getUserProperties()

Return a Hashtable of UserPropertyEntry objects keyed by the name of the associated UserProperty object.

Returns:

getUserPropertyEntry

public UserPropertyEntry getUserPropertyEntry(java.lang.String name)

Parameters:

name -

Returns:

the entry for the user property keyed by the specified name

getUserPropertyValue

public java.lang.String getUserPropertyValue(java.lang.String name)

Parameters:

name -

Returns:

the String value for the user property keyed by the specified name

getUserPropertiesOrderBySequence

public java.util.Hashtable getUserPropertiesOrderBySequence()

Answer this users UserPropertyEntry objects sorted by the sequence of the associated UserProperty

Returns:

setUserProperties

public void setUserProperties(java.util.Hashtable map)

Establish the UserPropertyEntry objects Hashtable.

delete

public void delete(ITransaction aTransaction)
            throws java.lang.Exception

Delete the UserProfile from the system. Additionally, delete any associated UserPropertyEntry objects as well.

Throws:

java.lang.Exception

getPasswordHistory

public java.util.Collection getPasswordHistory()

Returns:

Returns the passwordHistory.

setPasswordHistory

public void setPasswordHistory(java.util.Collection passwordHistory)

Parameters:

passwordHistory - The passwordHistory to set.

getPasswordIsValid

public boolean getPasswordIsValid()

Returns:

Returns the passwordIsValid.

setPasswordIsValid

public void setPasswordIsValid(boolean passwordIsValid)

Parameters:

passwordIsValid - The passwordIsValid to set.

getPermissions

public java.util.Collection getPermissions()

Specified by:

getPermissions in interface RoundhousePrincipal

Returns:

Returns the permissions.

setPermissions

public void setPermissions(java.util.Collection permissions)

Specified by:

setPermissions in interface RoundhousePrincipal

Parameters:

permissions - The permissions to set.

getDeniedPermissions

public java.util.Collection getDeniedPermissions()

Specified by:

getDeniedPermissions in interface RoundhousePrincipal

Returns:

getGrantedPermissions

public java.util.Collection getGrantedPermissions()

Specified by:

getGrantedPermissions in interface RoundhousePrincipal

Returns: