ibrokerkit.ibrokerstore.store
Interface Store

All Known Implementing Classes:

DatabaseStore

public interface Store

The Store is used for creating, retrieving and managing users.

Method Summary

User	checkUserPassword(java.lang.String identifier, java.lang.String pass) Check if the user's hashed password is correct.
void	close() Closes the Store.
User	createOrUpdateUser(java.lang.String identifier, java.lang.String pass, java.lang.String recovery, java.lang.String name, java.lang.String email, java.lang.Boolean openid)
Private	createPrivate()
PrivateAuthorization	createPrivateAuthorization()
PrivateSelector	createPrivateSelector()
void	deleteObject(java.lang.Object object) Deletes an object from the database.
boolean	existsUser(java.lang.String identifier, java.lang.String name) Check if a user with a given identifier or name exists already.
Private	findPrivate(java.lang.String qxri)
Private	findPrivateBySelector(java.lang.String selector)
Private[]	findPrivates(java.lang.String qxri)
User	findUser(java.lang.String identifier) Find a user by a given identifier.
User	findUserByRecovery(java.lang.String recovery) Find all users with a given recovery code.
User[]	findUsersByEmail(java.lang.String email) Find all users with a given email address.
Private	getPrivate(java.lang.Long id)
void	init() Initializes the Store.
boolean	isClosed() True, if the Store has been initialized.
boolean	isInitialized() True, if the Store has been initialized.
Private[]	listPrivates()
Private[]	listPrivatesByIndex(java.lang.String indx)
User[]	listUsers() List all users in the Store.
void	updateObject(java.lang.Object object) Updates an object in the database after modifications have been made.

Method Detail

init

void init()
          throws StoreException

Initializes the Store.

Throws:

StoreException

isInitialized

boolean isInitialized()

True, if the Store has been initialized.

close

void close()

Closes the Store.

isClosed

boolean isClosed()

True, if the Store has been initialized.

updateObject

void updateObject(java.lang.Object object)
                  throws StoreException

Updates an object in the database after modifications have been made.

Throws:

StoreException

deleteObject

void deleteObject(java.lang.Object object)
                  throws StoreException

Deletes an object from the database.

Throws:

StoreException

createOrUpdateUser

User createOrUpdateUser(java.lang.String identifier,
                        java.lang.String pass,
                        java.lang.String recovery,
                        java.lang.String name,
                        java.lang.String email,
                        java.lang.Boolean openid)
                        throws StoreException

Throws:

StoreException

listUsers

User[] listUsers()
                 throws StoreException

List all users in the Store.

Throws:

StoreException

findUser

User findUser(java.lang.String identifier)
              throws StoreException

Find a user by a given identifier.

Throws:

StoreException

findUsersByEmail

User[] findUsersByEmail(java.lang.String email)
                        throws StoreException

Find all users with a given email address.

Throws:

StoreException

findUserByRecovery

User findUserByRecovery(java.lang.String recovery)
                        throws StoreException

Find all users with a given recovery code.

Throws:

StoreException

existsUser

boolean existsUser(java.lang.String identifier,
                   java.lang.String name)
                   throws StoreException

Check if a user with a given identifier or name exists already. Both parameters may be null.

Throws:

StoreException

checkUserPassword

User checkUserPassword(java.lang.String identifier,
                       java.lang.String pass)
                       throws StoreException

Check if the user's hashed password is correct.

Throws:

StoreException

createPrivate

Private createPrivate()
                      throws StoreException

Throws:

StoreException

getPrivate

Private getPrivate(java.lang.Long id)
                   throws StoreException

Throws:

StoreException

listPrivates

Private[] listPrivates()
                       throws StoreException

Throws:

StoreException

listPrivatesByIndex

Private[] listPrivatesByIndex(java.lang.String indx)
                              throws StoreException

Throws:

StoreException

findPrivate

Private findPrivate(java.lang.String qxri)
                    throws StoreException

Throws:

StoreException

findPrivates

Private[] findPrivates(java.lang.String qxri)
                       throws StoreException

Throws:

StoreException

findPrivateBySelector

Private findPrivateBySelector(java.lang.String selector)
                              throws StoreException

Throws:

StoreException

createPrivateSelector

PrivateSelector createPrivateSelector()
                                      throws StoreException

Throws:

StoreException

createPrivateAuthorization

PrivateAuthorization createPrivateAuthorization()
                                                throws StoreException

Throws:

StoreException