DummyRepository (Tigase XMPP Server 7.1.1 API)

java.lang.Object
- tigase.db.DummyRepository

All Implemented Interfaces:

AuthRepository, Repository, UserRepository
```
public class DummyRepository
extends Object
implements UserRepository, AuthRepository
```
DummyRepository is a class with all methods empty. They don't return anything and they don't throw exception. SessionManager requires a user repository to work properly but in some installations there is no need for user repository as authentication is done through external data source and user roster is pulled dynamically. Created: Sat Nov 3 16:17:03 2007

Version:

$Rev$

Author:

Artur Hefczyc

Nested Class Summary
- Nested classes/interfaces inherited from interface tigase.db.Repository
  Repository.Meta

Field Summary
- Fields inherited from interface tigase.db.AuthRepository
  DATA_KEY, DIGEST_ID_KEY, DIGEST_KEY, MACHANISM_KEY, PASSWORD_KEY, PROTOCOL_KEY, PROTOCOL_VAL_NONSASL, PROTOCOL_VAL_SASL, REALM_KEY, RESULT_KEY, SERVER_NAME_KEY, USER_ID_KEY, USERNAME_KEY

Constructor Summary

Constructors
Constructor and Description

DummyRepository()

Constructors
Constructor and Description
`DummyRepository()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addDataList(BareJID user, String subnode, String key, String[] list)` `addDataList` method adds mode entries to existing data list associated with given key in repository under given node path.
`void`	`addUser(BareJID user)` This `addUser` method allows to add new user to repository.
`void`	`addUser(BareJID user, String password)` Describe `addUser` method here.
`boolean`	`digestAuth(BareJID user, String digest, String id, String alg)` Deprecated.
`String`	`getData(BareJID user, String key)` `getData` method returns a value associated with given key for user repository in default subnode.
`String`	`getData(BareJID user, String subnode, String key)` `getData` method returns a value associated with given key for user repository in given subnode.
`String`	`getData(BareJID user, String subnode, String key, String def)` `getData` method returns a value associated with given key for user repository in given subnode.
`String[]`	`getDataList(BareJID user, String subnode, String key)` `getDataList` method returns array of values associated with given key or `null` if given key does not exist for given user ID in given node path.
`String[]`	`getKeys(BareJID user)` `getKeys` method returns list of all keys stored in default user repository node.
`String[]`	`getKeys(BareJID user, String subnode)` `getKeys` method returns list of all keys stored in given subnode in user repository.
`String`	`getPassword(BareJID user)`
`String`	`getResourceUri()` Returns a DB connection string or DB connection URI.
`String[]`	`getSubnodes(BareJID user)` `getSubnodes` method returns list of all root nodes for given user.
`String[]`	`getSubnodes(BareJID user, String subnode)` `getSubnodes` method returns list of all direct subnodes from given node.
`List<BareJID>`	`getUsers()` This method is only used by the data conversion tools.
`long`	`getUsersCount()` This method is only used by the server statistics component to report number of registered users.
`long`	`getUsersCount(String domain)` This method is only used by the server statistics component to report number of registered users for given domain.
`long`	`getUserUID(BareJID user)` Returns a user unique ID number within the given repository.
`void`	`initRepository(String string, Map<String,String> params)` The method is called to initialize the data repository.
`boolean`	`isUserDisabled(BareJID user)`
`void`	`logout(BareJID user)` Describe `logout` method here.
`boolean`	`otherAuth(Map<String,Object> authProps)` Describe `otherAuth` method here.
`boolean`	`plainAuth(BareJID user, String password)` Deprecated.
`void`	`queryAuth(Map<String,Object> authProps)` `queryAuth` returns mechanisms available for authentication.
`void`	`removeData(BareJID user, String key)` `removeData` method removes pair (key, value) from user repository in default repository node.
`void`	`removeData(BareJID user, String subnode, String key)` `removeData` method removes pair (key, value) from user repository in given subnode.
`void`	`removeSubnode(BareJID user, String subnode)` `removeSubnode` method removes given subnode with all subnodes in this node and all data stored in this node and in all subnodes.
`void`	`removeUser(BareJID user)` This `removeUser` method allows to remove user and all his data from user repository.
`void`	`setData(BareJID user, String key, String value)` This `setData` method sets data value for given user ID associated with given key in default repository node.
`void`	`setData(BareJID user, String subnode, String key, String value)` `setData` method sets data value for given user ID in repository under given node path and associates it with given key.
`void`	`setDataList(BareJID user, String subnode, String key, String[] list)` `setDataList` method sets list of values for given user associated given key in repository under given node path.
`void`	`setUserDisabled(BareJID user, Boolean value)`
`void`	`updatePassword(BareJID user, String password)` Describe `updatePassword` method here.
`boolean`	`userExists(BareJID user)` Method `userExists` checks whether the user (or repository top node) exists in the database.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DummyRepository
```
public DummyRepository()
```
- Method Detail
  - addDataList
```
public void addDataList(BareJID user,
                        String subnode,
                        String key,
                        String[] list)
```
    Description copied from interface: UserRepository
    
    addDataList method adds mode entries to existing data list associated with given key in repository under given node path. This method is very similar to setDataList(...) except it doesn't remove existing data.
    Specified by:
    
    addDataList in interface UserRepository
    
    Parameters:
    
    user - a BareJID value of user ID for which data must be stored. User ID consists of user name and domain name.
    subnode - a String value is a node path where data is stored. Node path has the same form as directory path on file system:
    /root/subnode1/subnode2
    .
    key - a String with which the specified values list is to be associated.
    
    list - a String[] is an array of values to be associated with the specified key.
  - addUser
```
public void addUser(BareJID user)
```
    Description copied from interface: UserRepository
    
    This addUser method allows to add new user to repository. It must throw en exception UserExistsException if such user already exists because user must be unique within user repository data base.
    As one XMPP server can support many virtual internet domains it is required that user id consists of user name and domain address: username@domain.address.net for example.
    
    Specified by:
    
    addUser in interface UserRepository
    
    Parameters:
    
    user - a BareJID value of user id consisting of user name and domain address.
  - addUser
```
public void addUser(BareJID user,
                    String password)
             throws UserExistsException,
                    TigaseDBException
```
    Description copied from interface: AuthRepository
    
    Describe addUser method here.
    
    Specified by:
    
    addUser in interface AuthRepository
    
    Parameters:
    
    user - a BareJID value
    
    password - a String value
    
    Throws:
    
    UserExistsException - if an error occurs
    
    TigaseDBException - if an error occurs
  - digestAuth
```
@Deprecated
public boolean digestAuth(BareJID user,
                                      String digest,
                                      String id,
                                      String alg)
                               throws UserNotFoundException,
                                      TigaseDBException,
                                      AuthorizationException
```
    Deprecated.
    
    Description copied from interface: AuthRepository
    
    digestAuth method performs non-sasl, digest authentication as described in non-sasl authentication XEP-0078 For now it is empty and always returns false as I don't have description for database with passwords.
    
    Specified by:
    
    digestAuth in interface AuthRepository
    
    Parameters:
    
    user - a BareJID value of user name
    
    digest - a String value password digest sum
    
    id - a String value session ID used for digest sum calculation.
    
    alg - a String value of algorithm ID used for digest sum calculation.
    
    Returns:
    
    a boolean value true on successful authentication, false on authentication failure.
    
    Throws:
    
    UserNotFoundException - if an given user name is not found in the authentication repository.
    
    TigaseDBException - if an error occurs during during accessing database;
    
    AuthorizationException - if an error occurs during authentication process.
  - getData
```
public String getData(BareJID user,
                      String subnode,
                      String key,
                      String def)
```
    getData method returns a value associated with given key for user repository in given subnode. If key is not found in repository given default value is returned.
    Specified by:
    
    getData in interface UserRepository
    
    Parameters:
    
    user - a BareJID value of user ID for which data must be stored. User ID consists of user name and domain name.
    subnode - a String value is a node path where data is stored. Node path has the same form as directory path on file system:
    /root/subnode1/subnode2
    .
    key - a String with which the needed value is associated.
    
    def - a String value which is returned in case if data for specified key does not exixist in repository.
    
    Returns:
    
    a String value of null always.
  - getData
```
public String getData(BareJID user,
                      String subnode,
                      String key)
```
    getData method returns a value associated with given key for user repository in given subnode. If key is not found in repository null value is returned.
    Specified by:
    
    getData in interface UserRepository
    
    Parameters:
    
    user - a BareJID value of user ID for which data must be stored. User ID consists of user name and domain name.
    subnode - a String value is a node path where data is stored. Node path has the same form as directory path on file system:
    /root/subnode1/subnode2
    .
    key - a String with which the needed value is associated.
    
    Returns:
    
    a String value of null always.
  - getData
```
public String getData(BareJID user,
                      String key)
```
    getData method returns a value associated with given key for user repository in default subnode. If key is not found in repository null value is returned.
    
    Specified by:
    
    getData in interface UserRepository
    
    Parameters:
    
    user - a BareJID value of user ID for which data must be stored. User ID consists of user name and domain name.
    
    key - a String with which the needed value is associated.
    
    Returns:
    
    a String value of null always.
  - getDataList
```
public String[] getDataList(BareJID user,
                            String subnode,
                            String key)
```
    Description copied from interface: UserRepository
    
    getDataList method returns array of values associated with given key or null if given key does not exist for given user ID in given node path.
    Specified by:
    
    getDataList in interface UserRepository
    
    Parameters:
    
    user - a BareJID value of user ID for which data must be stored. User ID consists of user name and domain name.
    subnode - a String value is a node path where data is stored. Node path has the same form as directory path on file system:
    /root/subnode1/subnode2
    .
    key - a String with which the needed values list is associated.
    
    Returns:
    
    a String[] value
  - getKeys
```
public String[] getKeys(BareJID user,
                        String subnode)
```
    Description copied from interface: UserRepository
    
    getKeys method returns list of all keys stored in given subnode in user repository. There is a value (or list of values) associated with each key. It is up to user (developer) to know what key keeps one value and what key keeps list of values.
    Specified by:
    
    getKeys in interface UserRepository
    
    Parameters:
    
    user - a BareJID value of user ID for which data must be stored. User ID consists of user name and domain name.
    subnode - a String value is a node path where data is stored. Node path has the same form as directory path on file system:
    /root/subnode1/subnode2
    .
    Returns:
    
    a String[] value
  - getKeys
```
public String[] getKeys(BareJID user)
```
    Description copied from interface: UserRepository
    
    getKeys method returns list of all keys stored in default user repository node. There is some a value (or list of values) associated with each key. It is up to user (developer) to know what key keeps one value and what key keeps list of values.
    
    Specified by:
    
    getKeys in interface UserRepository
    
    Parameters:
    
    user - a BareJID value of user ID for which data must be stored or retrieved. User ID consists of user name and domain name.
    
    Returns:
    
    a String[] value
  - getResourceUri
```
public String getResourceUri()
```
    Description copied from interface: UserRepository
    
    Returns a DB connection string or DB connection URI.
    
    Specified by:
    
    getResourceUri in interface AuthRepository
    
    Specified by:
    
    getResourceUri in interface UserRepository
    
    Returns:
    
    a String value representing database connection string.
  - getSubnodes
```
public String[] getSubnodes(BareJID user,
                            String subnode)
```
    Description copied from interface: UserRepository
    
    getSubnodes method returns list of all direct subnodes from given node.
    Specified by:
    
    getSubnodes in interface UserRepository
    
    Parameters:
    
    user - a BareJID value of user ID for which data must be stored. User ID consists of user name and domain name.
    subnode - a String value is a node path where data is stored. Node path has the same form as directory path on file system:
    /root/subnode1/subnode2
    .
    Returns:
    
    a String[] value is an array of all direct subnodes.
  - getSubnodes
```
public String[] getSubnodes(BareJID user)
```
    Description copied from interface: UserRepository
    
    getSubnodes method returns list of all root nodes for given user.
    
    Specified by:
    
    getSubnodes in interface UserRepository
    
    Parameters:
    
    user - a BareJID value of user ID for which data must be stored. User ID consists of user name and domain name.
    
    Returns:
    
    a String[] value is an array of all root nodes for given user.
  - getUserUID
```
public long getUserUID(BareJID user)
                throws TigaseDBException
```
    Description copied from interface: UserRepository
    
    Returns a user unique ID number within the given repository. Please note it is also possible that the ID number is unique only for the user domain. The ID is a positive number if the user exists and negative if the user was not found in the repository.
    
    Specified by:
    
    getUserUID in interface UserRepository
    
    Parameters:
    
    user - a BareJID value of user ID for which data must be stored or retrieved. User ID consists of user name and domain name.
    
    Returns:
    
    a user inique ID number within the repository or domain. The ID is a positive number if the user exists and negative if the user was not found in the repository.
    
    Throws:
    
    TigaseDBException - if there is a problem with accessing user repository.
  - getUsers
```
public List<BareJID> getUsers()
```
    Description copied from interface: UserRepository
    
    This method is only used by the data conversion tools. They attempt to copy whole user repositories from one to another database. Databases might not be compatible but as long as the API is implemented and they support adding user the user database can be copied to a different data source.
    
    Specified by:
    
    getUsers in interface UserRepository
    
    Returns:
    
    returns a collection of all user IDs (Jabber IDs) stored in the user repository.
  - getUsersCount
```
public long getUsersCount()
```
    Description copied from interface: UserRepository
    
    This method is only used by the server statistics component to report number of registered users.
    
    Specified by:
    
    getUsersCount in interface AuthRepository
    
    Specified by:
    
    getUsersCount in interface UserRepository
    
    Returns:
    
    a long number of registered users in the repository.
  - getUsersCount
```
public long getUsersCount(String domain)
```
    Description copied from interface: UserRepository
    
    This method is only used by the server statistics component to report number of registered users for given domain.
    
    Specified by:
    
    getUsersCount in interface AuthRepository
    
    Specified by:
    
    getUsersCount in interface UserRepository
    
    Returns:
    
    a long number of registered users in the repository.
  - initRepository
```
public void initRepository(String string,
                           Map<String,String> params)
```
    Description copied from interface: Repository
    
    The method is called to initialize the data repository. Depending on the implementation all the initialization parameters can be passed either via resource_uri parameter as the database connection string or via params map if the required repository parameters are more complex or both.
    
    Specified by:
    
    initRepository in interface Repository
    
    Parameters:
    
    string - value in most cases representing the database connection string.
    
    params - is a Map with repository properties necessary to initialize and perform all the functions. The initialization parameters are implementation dependent.
  - logout
```
public void logout(BareJID user)
            throws UserNotFoundException,
                   TigaseDBException
```
    Description copied from interface: AuthRepository
    
    Describe logout method here.
    
    Specified by:
    
    logout in interface AuthRepository
    
    Parameters:
    
    user - a BareJID value
    
    Throws:
    
    UserNotFoundException - if an error occurs
    
    TigaseDBException - if an error occurs
  - otherAuth
```
public boolean otherAuth(Map<String,Object> authProps)
                  throws UserNotFoundException,
                         TigaseDBException,
                         AuthorizationException
```
    Description copied from interface: AuthRepository
    
    Describe otherAuth method here.
    
    Specified by:
    
    otherAuth in interface AuthRepository
    
    Parameters:
    
    authProps - a Map value
    
    Returns:
    
    a boolean value
    
    Throws:
    
    UserNotFoundException - if an error occurs
    
    TigaseDBException - if an error occurs
    
    AuthorizationException - if an error occurs
  - plainAuth
```
@Deprecated
public boolean plainAuth(BareJID user,
                                     String password)
                              throws UserNotFoundException,
                                     TigaseDBException,
                                     AuthorizationException
```
    Deprecated.
    
    Description copied from interface: AuthRepository
    
    plainAuth method performs non-sasl, plain authentication as described in non-sasl authentication XEP-0078.
    
    Specified by:
    
    plainAuth in interface AuthRepository
    
    Parameters:
    
    user - a BareJID value of user name
    
    password - a String value of plain user password.
    
    Returns:
    
    a boolean value true on successful authentication, false on authentication failure.
    
    Throws:
    
    UserNotFoundException - if an given user name is not found in the authentication repository.
    
    TigaseDBException - if an error occurs during during accessing database;
    
    AuthorizationException - if an error occurs during authentication process.
  - queryAuth
```
public void queryAuth(Map<String,Object> authProps)
```
    Description copied from interface: AuthRepository
    
    queryAuth returns mechanisms available for authentication.
    
    Specified by:
    
    queryAuth in interface AuthRepository
    
    Parameters:
    
    authProps - a Map value with parameters for authentication.
  - removeData
```
public void removeData(BareJID user,
                       String subnode,
                       String key)
```
    Description copied from interface: UserRepository
    
    removeData method removes pair (key, value) from user repository in given subnode. If the key exists in user repository there is always a value associated with this key - even empty String. If key does not exist the null value is returned from repository backend or given default value.
    Specified by:
    
    removeData in interface UserRepository
    
    Parameters:
    
    user - a BareJID value of user ID for which data must be stored. User ID consists of user name and domain name.
    subnode - a String value is a node path where data is stored. Node path has the same form as directory path on file system:
    /root/subnode1/subnode2
    .
    key - a String for which the value is to be removed.
  - removeData
```
public void removeData(BareJID user,
                       String key)
```
    Description copied from interface: UserRepository
    
    removeData method removes pair (key, value) from user repository in default repository node. If the key exists in user repository there is always a value associated with this key - even empty String. If key does not exist the null value is returned from repository backend or given default value.
    
    Specified by:
    
    removeData in interface UserRepository
    
    Parameters:
    
    user - a BareJID value of user ID for which data must be stored. User ID consists of user name and domain name.
    
    key - a String for which the value is to be removed.
  - removeSubnode
```
public void removeSubnode(BareJID user,
                          String subnode)
```
    Description copied from interface: UserRepository
    
    removeSubnode method removes given subnode with all subnodes in this node and all data stored in this node and in all subnodes. Effectively it removes entire repository tree starting from given node.
    Specified by:
    
    removeSubnode in interface UserRepository
    
    Parameters:
    
    user - a BareJID value of user ID for which data must be stored. User ID consists of user name and domain name.
    subnode - a String value is a node path to subnode which has to be removed. Node path has the same form as directory path on file system:
    /root/subnode1/subnode2
    .
  - removeUser
```
public void removeUser(BareJID user)
```
    Description copied from interface: UserRepository
    
    This removeUser method allows to remove user and all his data from user repository. If given user id does not exist UserNotFoundException must be thrown. As one XMPP server can support many virtual internet domains it is required that user id consists of user name and domain address: username@domain.address.net for example.
    
    Specified by:
    
    removeUser in interface AuthRepository
    
    Specified by:
    
    removeUser in interface UserRepository
    
    Parameters:
    
    user - a BareJID value of user id consisting of user name and domain address.
  - setData
```
public void setData(BareJID user,
                    String subnode,
                    String key,
                    String value)
```
    Description copied from interface: UserRepository
    
    setData method sets data value for given user ID in repository under given node path and associates it with given key. If there already exists value for given key in given node, old value is replaced with new value. No warning or exception is thrown in case if methods overwrites old value.
    Specified by:
    
    setData in interface UserRepository
    
    Parameters:
    
    user - a BareJID value of user ID for which data must be stored. User ID consists of user name and domain name.
    subnode - a String value is a node path where data is stored. Node path has the same form as directory path on file system:
    /root/subnode1/subnode2
    .
    key - a String with which the specified value is to be associated.
    
    value - a String value to be associated with the specified key.
  - setData
```
public void setData(BareJID user,
                    String key,
                    String value)
```
    Description copied from interface: UserRepository
    
    This setData method sets data value for given user ID associated with given key in default repository node. Default node is dependent on implementation and usually it is root user node. If there already exists value for given key in given node, old value is replaced with new value. No warning or exception is thrown in case if methods overwrites old value.
    
    Specified by:
    
    setData in interface UserRepository
    
    Parameters:
    
    user - a BareJID value of user ID for which data must be stored. User ID consists of user name and domain name.
    
    key - a String with which the specified value is to be associated.
    
    value - a String value to be associated with the specified key.
  - setDataList
```
public void setDataList(BareJID user,
                        String subnode,
                        String key,
                        String[] list)
```
    Description copied from interface: UserRepository
    
    setDataList method sets list of values for given user associated given key in repository under given node path. If there already exist values for given key in given node, all old values are replaced with new values. No warning or exception is thrown in case if methods overwrites old value.
    Specified by:
    
    setDataList in interface UserRepository
    
    Parameters:
    
    user - a BareJID value of user ID for which data must be stored. User ID consists of user name and domain name.
    subnode - a String value is a node path where data is stored. Node path has the same form as directory path on file system:
    /root/subnode1/subnode2
    .
    key - a String with which the specified values list is to be associated.
    
    list - a String[] is an array of values to be associated with the specified key.
  - updatePassword
```
public void updatePassword(BareJID user,
                           String password)
                    throws UserNotFoundException,
                           TigaseDBException
```
    Description copied from interface: AuthRepository
    
    Describe updatePassword method here.
    
    Specified by:
    
    updatePassword in interface AuthRepository
    
    Parameters:
    
    user - a BareJID value
    
    password - a String value
    
    Throws:
    
    UserNotFoundException
    
    TigaseDBException - if an error occurs
  - userExists
```
public boolean userExists(BareJID user)
```
    Description copied from interface: UserRepository
    
    Method userExists checks whether the user (or repository top node) exists in the database. The method doesn't throw any exception nor it creates the user in case it is missing. It just checks whether the user is already in the database. Please don't overuse this method. All other methods throw UserNotFoundException exception in case the user is missing for which you executed the method. The exception is thrown unless userAutoCreate property is set to true. In such case the exception is never thrown and the methods are executed for given parameters prior to creating user entry if it is missing. Therefore this method should be used only to check whether the account exists without creating it.
    
    Specified by:
    
    userExists in interface UserRepository
    
    Parameters:
    
    user - a BareJID value
    
    Returns:
    
    a boolean value
  - getPassword
```
public String getPassword(BareJID user)
                   throws UserNotFoundException,
                          TigaseDBException
```
    Specified by:
    
    getPassword in interface AuthRepository
    
    Throws:
    
    UserNotFoundException
    
    TigaseDBException
  - isUserDisabled
```
public boolean isUserDisabled(BareJID user)
                       throws UserNotFoundException,
                              TigaseDBException
```
    Specified by:
    
    isUserDisabled in interface AuthRepository
    
    Throws:
    
    UserNotFoundException
    
    TigaseDBException
  - setUserDisabled
```
public void setUserDisabled(BareJID user,
                            Boolean value)
                     throws UserNotFoundException,
                            TigaseDBException
```
    Specified by:
    
    setUserDisabled in interface AuthRepository
    
    Throws:
    
    UserNotFoundException
    
    TigaseDBException

Class DummyRepository

Nested Class Summary

Nested classes/interfaces inherited from interface tigase.db.Repository

Field Summary

Fields inherited from interface tigase.db.AuthRepository

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DummyRepository

Method Detail

addDataList

addUser

addUser

digestAuth

getData

getData

getData

getDataList

getKeys

getKeys

getResourceUri

getSubnodes

getSubnodes

getUserUID

getUsers

getUsersCount

getUsersCount

initRepository

logout

otherAuth

plainAuth

queryAuth

removeData

removeData

removeSubnode

removeUser

setData

setData

setDataList

updatePassword

userExists

getPassword

isUserDisabled

setUserDisabled