net.ramapuram.thomas.model
Class User

java.lang.Object
  net.ramapuram.thomas.model.BaseObject
      net.ramapuram.thomas.model.User

All Implemented Interfaces:

java.io.Serializable, org.springframework.security.core.userdetails.UserDetails

@Entity
public class User
extends BaseObject
implements java.io.Serializable, org.springframework.security.core.userdetails.UserDetails

This class represents the basic "user" object in AppFuse that allows for authentication and user management. It implements Acegi Security's UserDetails interface.

Author:

Matt Raible Updated by Dan Kibler (dan@getrolling.com) Extended to implement Acegi UserDetails interface by David Carter david@carter.net

See Also:

Serialized Form

Constructor Summary

User()
Default constructor - creates a new instance with no values set.

User(java.lang.String username)
Create a new instance and set the username.

Method Summary

void	addRole(Role role) Adds a role for the user
boolean	equals(java.lang.Object o) Compares object equality.
Address	getAddress()
java.util.Set<org.springframework.security.core.GrantedAuthority>	getAuthorities()
java.lang.String	getConfirmPassword()
java.lang.String	getEmail()
java.lang.String	getFirstName()
java.lang.String	getFullName() Returns the full name.
java.lang.Long	getId()
java.lang.String	getLastName()
java.lang.String	getPassword()
java.lang.String	getPasswordHint()
java.lang.String	getPhoneNumber()
java.util.List<LabelValue>	getRoleList() Convert user roles to LabelValue objects for convenience.
java.util.Set<Role>	getRoles()
java.lang.String	getUsername()
java.lang.Integer	getVersion()
java.lang.String	getWebsite()
int	hashCode() When you override equals, you should override hashCode.
boolean	isAccountExpired()
boolean	isAccountLocked()
boolean	isAccountNonExpired()
boolean	isAccountNonLocked()
boolean	isCredentialsExpired()
boolean	isCredentialsNonExpired()
boolean	isEnabled()
void	setAccountExpired(boolean accountExpired)
void	setAccountLocked(boolean accountLocked)
void	setAddress(Address address)
void	setConfirmPassword(java.lang.String confirmPassword)
void	setCredentialsExpired(boolean credentialsExpired)
void	setEmail(java.lang.String email)
void	setEnabled(boolean enabled)
void	setFirstName(java.lang.String firstName)
void	setId(java.lang.Long id)
void	setLastName(java.lang.String lastName)
void	setPassword(java.lang.String password)
void	setPasswordHint(java.lang.String passwordHint)
void	setPhoneNumber(java.lang.String phoneNumber)
void	setRoles(java.util.Set<Role> roles)
void	setUsername(java.lang.String username)
void	setVersion(java.lang.Integer version)
void	setWebsite(java.lang.String website)
java.lang.String	toString() Returns a multi-line String with key=value pairs.

Methods inherited from class java.lang.Object

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

Constructor Detail

User

public User()

Default constructor - creates a new instance with no values set.

User

public User(java.lang.String username)

Create a new instance and set the username.

Parameters:

username - login name for user.

Method Detail

getId

public java.lang.Long getId()

getUsername

public java.lang.String getUsername()

Specified by:

getUsername in interface org.springframework.security.core.userdetails.UserDetails

getPassword

public java.lang.String getPassword()

Specified by:

getPassword in interface org.springframework.security.core.userdetails.UserDetails

getConfirmPassword

public java.lang.String getConfirmPassword()

getPasswordHint

public java.lang.String getPasswordHint()

getFirstName

public java.lang.String getFirstName()

getLastName

public java.lang.String getLastName()

getEmail

public java.lang.String getEmail()

getPhoneNumber

public java.lang.String getPhoneNumber()

getWebsite

public java.lang.String getWebsite()

getFullName

public java.lang.String getFullName()

Returns the full name.

Returns:

firstName + ' ' + lastName

getAddress

public Address getAddress()

getRoles

public java.util.Set<Role> getRoles()

getRoleList

public java.util.List<LabelValue> getRoleList()

Convert user roles to LabelValue objects for convenience.

Returns:

a list of LabelValue objects with role information

addRole

public void addRole(Role role)

Adds a role for the user

Parameters:

role - the fully instantiated role

getAuthorities

public java.util.Set<org.springframework.security.core.GrantedAuthority> getAuthorities()

Specified by:

getAuthorities in interface org.springframework.security.core.userdetails.UserDetails

Returns:

GrantedAuthority[] an array of roles.

See Also:

UserDetails.getAuthorities()

getVersion

public java.lang.Integer getVersion()

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface org.springframework.security.core.userdetails.UserDetails

isAccountExpired

public boolean isAccountExpired()

isAccountNonExpired

public boolean isAccountNonExpired()

Specified by:

isAccountNonExpired in interface org.springframework.security.core.userdetails.UserDetails

Returns:

true if account is still active

See Also:

UserDetails.isAccountNonExpired()

isAccountLocked

public boolean isAccountLocked()

isAccountNonLocked

public boolean isAccountNonLocked()

Specified by:

isAccountNonLocked in interface org.springframework.security.core.userdetails.UserDetails

Returns:

false if account is locked

See Also:

UserDetails.isAccountNonLocked()

isCredentialsExpired

public boolean isCredentialsExpired()

isCredentialsNonExpired

public boolean isCredentialsNonExpired()

Specified by:

isCredentialsNonExpired in interface org.springframework.security.core.userdetails.UserDetails

Returns:

true if credentials haven't expired

See Also:

UserDetails.isCredentialsNonExpired()

setId

public void setId(java.lang.Long id)

setUsername

public void setUsername(java.lang.String username)

setPassword

public void setPassword(java.lang.String password)

setConfirmPassword

public void setConfirmPassword(java.lang.String confirmPassword)

setPasswordHint

public void setPasswordHint(java.lang.String passwordHint)

setFirstName

public void setFirstName(java.lang.String firstName)

setLastName

public void setLastName(java.lang.String lastName)

setEmail

public void setEmail(java.lang.String email)

setPhoneNumber

public void setPhoneNumber(java.lang.String phoneNumber)

setWebsite

public void setWebsite(java.lang.String website)

setAddress

public void setAddress(Address address)

setRoles

public void setRoles(java.util.Set<Role> roles)

setVersion

public void setVersion(java.lang.Integer version)

setEnabled

public void setEnabled(boolean enabled)

setAccountExpired

public void setAccountExpired(boolean accountExpired)

setAccountLocked

public void setAccountLocked(boolean accountLocked)

setCredentialsExpired

public void setCredentialsExpired(boolean credentialsExpired)

equals

public boolean equals(java.lang.Object o)

Compares object equality. When using Hibernate, the primary key should not be a part of this comparison.

Specified by:

equals in class BaseObject

Parameters:

o - object to compare to

Returns:

true/false based on equality tests

hashCode

public int hashCode()

When you override equals, you should override hashCode. See "Why are equals() and hashCode() importation" for more information: http://www.hibernate.org/109.html

Specified by:

hashCode in class BaseObject

Returns:

hashCode

toString

public java.lang.String toString()

Returns a multi-line String with key=value pairs.

Specified by:

toString in class BaseObject

Returns:

a String representation of this class.