ibrokerkit.ibrokerstore.store
Interface User

All Superinterfaces:
java.lang.Comparable<User>, java.io.Serializable
All Known Implementing Classes:
AbstractUser, DbUser

public interface User
extends java.io.Serializable, java.lang.Comparable<User>

A user. In ibrokerKit, each user has a main identifier as well as a password. - The main identifier normally is the first i-name they register. It can also be an external OpenID, if the user signs in with one. - The password is used for signing in to the i-broker. Each user can have multiple i-names and i-services associated with their account.


Method Summary
 java.util.Map<java.lang.String,java.lang.String> getAttributes()
          Get arbitrary key/value pairs.
 java.lang.String getEmail()
          Get the e-mail address of this user.
 java.lang.Long getId()
          Get the internal ID of this user.
 java.lang.String getIdentifier()
          Get the main identifier of this user.
 java.lang.String getName()
          Get the name of this user.
 java.lang.Boolean getOpenid()
          Get a flag whether a user is an OpenID user.
 java.lang.String getPass()
          Get the hashed password of this user.
 java.lang.String getRecovery()
          Get the recovery code of this user.
 java.util.Date getTimestamp()
          Get the internal timestamp of this user.
 void setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)
          Set arbitrary key/value pairs.
 void setEmail(java.lang.String email)
          Set the e-mail address of this user.
 void setIdentifier(java.lang.String identifier)
          Set the main identifier of this user.
 void setName(java.lang.String name)
          Set the name of this user.
 void setOpenid(java.lang.Boolean openid)
          Set a flag whether a user is an OpenID user.
 void setPass(java.lang.String pass)
          Set the hashed password of this user
 void setRecovery(java.lang.String recovery)
          Set the recovery code of this user.
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

getId

java.lang.Long getId()
Get the internal ID of this user.

Returns:
ID.

getTimestamp

java.util.Date getTimestamp()
Get the internal timestamp of this user.

Returns:
Timestamp.

getIdentifier

java.lang.String getIdentifier()
Get the main identifier of this user. This is normally the first i-name they register.

Returns:
Identifier.

setIdentifier

void setIdentifier(java.lang.String identifier)
Set the main identifier of this user. This is normally the first i-name they register.

Parameters:
identifier - Identifier.

getName

java.lang.String getName()
Get the name of this user. This is not used by ibrokerKit internally.

Returns:
Name.

setName

void setName(java.lang.String name)
Set the name of this user. This is not used by ibrokerKit internally.

Parameters:
name - Name.

getEmail

java.lang.String getEmail()
Get the e-mail address of this user. This can be used for looking up a user if they forget the password.

Returns:
Email.

setEmail

void setEmail(java.lang.String email)
Set the e-mail address of this user. This can be used for looking up a user if they forget the password.

Parameters:
email - Email.

getPass

java.lang.String getPass()
Get the hashed password of this user.

Returns:
Pass.

setPass

void setPass(java.lang.String pass)
Set the hashed password of this user

Parameters:
pass - Pass.

getRecovery

java.lang.String getRecovery()
Get the recovery code of this user. This can be used for resetting the password.

Returns:
Recovery.

setRecovery

void setRecovery(java.lang.String recovery)
Set the recovery code of this user. This can be used for resetting the password.

Parameters:
recovery - Recovery.

getOpenid

java.lang.Boolean getOpenid()
Get a flag whether a user is an OpenID user.

Returns:
Openid.

setOpenid

void setOpenid(java.lang.Boolean openid)
Set a flag whether a user is an OpenID user.

Parameters:
openid - Openid.

getAttributes

java.util.Map<java.lang.String,java.lang.String> getAttributes()
Get arbitrary key/value pairs. These attributes are not used internally.

Returns:
Attributes.

setAttributes

void setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)
Set arbitrary key/value pairs. These attributes are not used internally.

Parameters:
attributes - Attributes.


Copyright © 2009. All Rights Reserved.