public interface UserRepository extends Repository
UserRepository
interface defines all functionalities required to store user data. It contains adding,
removing and searching methods. User repository is organized as hierarchical data base. It means you can add items to
repository on different levels like files in file systems. Instead, however of working with directories you work with
nodes. You can create many levels of nodes and store data on any level. It helps to organize data in more logical
order.
Created: Tue Oct 26 15:09:28 2004
Modifier and Type | Interface and Description |
---|---|
static class |
UserRepository.UserRemovedEvent |
Repository.Meta, Repository.SchemaId
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. |
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. |
default Map<String,String> |
getDataMap(BareJID user,
String subnode)
getDataMap method returns a values associated with each key for user repository in given subnode. |
default <T> Map<String,T> |
getDataMap(BareJID user,
String subnode,
Function<String,T> converter)
getDataMap method returns a values associated with each key for user repository in given subnode. |
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 |
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)
Deprecated.
|
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. |
boolean |
userExists(BareJID user)
Method
userExists checks whether the user (or repository top node) exists in the database. |
initRepository
void addDataList(BareJID user, String subnode, String key, String[] list) throws UserNotFoundException, TigaseDBException
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.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.UserNotFoundException
- if user id hasn't been found in repository.TigaseDBException
- if database backend error occurs.void addUser(BareJID user) throws UserExistsException, TigaseDBException
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.user
id consists of user name and domain address: username@domain.address.net for
example.user
- a BareJID
value of user id consisting of user name and domain address.UserExistsException
- if user with the same id already exists.TigaseDBException
- if database backend error occurs.String getData(BareJID user, String subnode, String key, String def) throws UserNotFoundException, TigaseDBException
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.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.String
valueUserNotFoundException
- if user id hasn't been found in repository.TigaseDBException
- if database backend error occurs.String getData(BareJID user, String subnode, String key) throws UserNotFoundException, TigaseDBException
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.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.String
valueUserNotFoundException
- if user id hasn't been found in repository.TigaseDBException
- if database backend error occurs.String getData(BareJID user, String key) throws UserNotFoundException, TigaseDBException
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.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.String
valueUserNotFoundException
- if user id hasn't been found in repository.TigaseDBException
- if database backend error occurs.default Map<String,String> getDataMap(BareJID user, String subnode) throws UserNotFoundException, TigaseDBException
getDataMap
method returns a values associated with each key for user repository in given subnode.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.
Map
with valuesUserNotFoundException
- if user id hasn't been found in repository.TigaseDBException
- if database backend error occurs.default <T> Map<String,T> getDataMap(BareJID user, String subnode, Function<String,T> converter) throws UserNotFoundException, TigaseDBException
getDataMap
method returns a values associated with each key for user repository in given subnode.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.
converter
- a Function
which takes value for a key and converts to expected value typeMap
with valuesUserNotFoundException
- if user id hasn't been found in repository.TigaseDBException
- if database backend error occurs.String[] getDataList(BareJID user, String subnode, String key) throws UserNotFoundException, TigaseDBException
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.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.String[]
valueUserNotFoundException
- if user id hasn't been found in repository.TigaseDBException
- if database backend error occurs.String[] getKeys(BareJID user, String subnode) throws UserNotFoundException, TigaseDBException
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.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.
String[]
valueUserNotFoundException
- if user id hasn't been found in repository.TigaseDBException
- if database backend error occurs.String[] getKeys(BareJID user) throws UserNotFoundException, TigaseDBException
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.user
- a BareJID
value of user ID for which data must be stored or retrieved. User ID consists
of user name and domain name.String[]
valueUserNotFoundException
- if user id hasn't been found in repository.TigaseDBException
- if database backend error occurs.String getResourceUri()
String
value representing database connection string.String[] getSubnodes(BareJID user, String subnode) throws UserNotFoundException, TigaseDBException
getSubnodes
method returns list of all direct subnodes from given node.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.
String[]
value is an array of all direct subnodes.UserNotFoundException
- if user id hasn't been found in repository.TigaseDBException
- if database backend error occurs.String[] getSubnodes(BareJID user) throws UserNotFoundException, TigaseDBException
getSubnodes
method returns list of all root nodes for given user.user
- a BareJID
value of user ID for which data must be stored. User ID consists of user name
and domain name.String[]
value is an array of all root nodes for given user.UserNotFoundException
- if user id hasn't been found in repository.TigaseDBException
- if database backend error occurs.@Deprecated long getUserUID(BareJID user) throws TigaseDBException
user
- a BareJID
value of user ID for which data must be stored or retrieved. User ID consists
of user name and domain name.TigaseDBException
- if there is a problem with accessing user repository.List<BareJID> getUsers() throws TigaseDBException
TigaseDBException
long getUsersCount()
long
number of registered users in the repository.long getUsersCount(String domain)
long
number of registered users in the repository.void removeData(BareJID user, String subnode, String key) throws UserNotFoundException, TigaseDBException
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.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.UserNotFoundException
- if user id hasn't been found in repository.TigaseDBException
- if database backend error occurs.void removeData(BareJID user, String key) throws UserNotFoundException, TigaseDBException
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.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.UserNotFoundException
- if user id hasn't been found in repository.TigaseDBException
- if database backend error occurs.void removeSubnode(BareJID user, String subnode) throws UserNotFoundException, TigaseDBException
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.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.
UserNotFoundException
- if user id hasn't been found in repository.TigaseDBException
- if database backend error occurs.void removeUser(BareJID user) throws UserNotFoundException, TigaseDBException
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.user
- a BareJID
value of user id consisting of user name and domain address.UserNotFoundException
- if user id hasn't been found in repository.TigaseDBException
- if database backend error occurs.void setData(BareJID user, String subnode, String key, String value) throws UserNotFoundException, TigaseDBException
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.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.UserNotFoundException
- if user id hasn't been found in repository.TigaseDBException
- if database backend error occurs.void setData(BareJID user, String key, String value) throws UserNotFoundException, TigaseDBException
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.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.UserNotFoundException
- if user id hasn't been found in repository.TigaseDBException
- if database backend error occurs.void setDataList(BareJID user, String subnode, String key, String[] list) throws UserNotFoundException, TigaseDBException
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.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.UserNotFoundException
- if user id hasn't been found in repository.TigaseDBException
- if database backend error occurs.boolean userExists(BareJID user)
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.
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.
user
- a BareJID
valueboolean
valueCopyright © 2004–2021 "Tigase, Inc.". All rights reserved.