com.jivesoftware.spi.user
Class UserTemplate

java.lang.Object
  com.jivesoftware.spi.user.UserTemplate

All Implemented Interfaces:

User, java.io.Serializable

public class UserTemplate
extends java.lang.Object
implements User, java.io.Serializable

See Also:

Serialized Form

Constructor Summary

UserTemplate()

UserTemplate(java.lang.String username, java.lang.String id, char[] password, java.lang.String email)

UserTemplate(java.lang.String username, java.lang.String id, java.lang.String email)

Method Summary

boolean	authenticate(char[] password) Authenticate the user with the given password
static UserTemplate	create(User user)
java.lang.String	getEmail() User's email address
java.lang.String	getID() Returns the unique identifier for this user.
char[]	getPassword() return user's password
java.lang.String	getPasswordHash() return user's password hash
java.lang.String	getUsername() returns the username
void	setEmail(java.lang.String email) Set user's email address
void	setId(java.lang.String id) Sets the user's unique id.
void	setPassword(char[] password) Set the password
void	setPasswordHash(java.lang.String hash) Set the password hash
void	setUsername(java.lang.String username) Sets the username.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

UserTemplate

public UserTemplate()

UserTemplate

public UserTemplate(java.lang.String username,
                    java.lang.String id,
                    java.lang.String email)

UserTemplate

public UserTemplate(java.lang.String username,
                    java.lang.String id,
                    char[] password,
                    java.lang.String email)

Method Detail

getID

public java.lang.String getID()

Description copied from interface: User

Returns the unique identifier for this user.

Specified by:

getID in interface User

Returns:

id

setId

public void setId(java.lang.String id)

Description copied from interface: User

Sets the user's unique id.

Specified by:

setId in interface User

Parameters:

id - user's id

getUsername

public java.lang.String getUsername()

Description copied from interface: User

returns the username

Specified by:

getUsername in interface User

Returns:

username username

setUsername

public void setUsername(java.lang.String username)

Description copied from interface: User

Sets the username.

Specified by:

setUsername in interface User

Parameters:

username - username

getEmail

public java.lang.String getEmail()

Description copied from interface: User

User's email address

Specified by:

getEmail in interface User

Returns:

email email address

setEmail

public void setEmail(java.lang.String email)

Description copied from interface: User

Set user's email address

Specified by:

setEmail in interface User

Parameters:

email - email address

authenticate

public boolean authenticate(char[] password)

Description copied from interface: User

Authenticate the user with the given password

Specified by:

authenticate in interface User

Parameters:

password - password

Returns:

true if the password matches

getPassword

public char[] getPassword()

Description copied from interface: User

return user's password

Specified by:

getPassword in interface User

Returns:

password passwords

setPassword

public void setPassword(char[] password)

Description copied from interface: User

Set the password

Specified by:

setPassword in interface User

Parameters:

password - new password

getPasswordHash

public java.lang.String getPasswordHash()
                                 throws java.lang.UnsupportedOperationException

Description copied from interface: User

return user's password hash

Specified by:

getPasswordHash in interface User

Returns:

hash password hash

Throws:

java.lang.UnsupportedOperationException - the operation is not implemented

setPasswordHash

public void setPasswordHash(java.lang.String hash)
                     throws java.lang.UnsupportedOperationException

Description copied from interface: User

Set the password hash

Specified by:

setPasswordHash in interface User

Parameters:

hash - password hash

Throws:

java.lang.UnsupportedOperationException - the operation is not implemented

create

public static UserTemplate create(User user)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object