public abstract class UserRepositoryMDImpl extends MDPoolBeanWithStatistics<UserRepository,UserRepositoryMDPoolBean.UserRepositoryConfigBean> implements UserRepository
UserRepository.UserRemovedEventRepository.Meta, Repository.SchemaIdPOOL_CLASS, POOL_SIZE, REPO_CLASS, REPO_URI| Constructor and Description |
|---|
UserRepositoryMDImpl() |
| 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. |
Map<String,String> |
getDataMap(BareJID user,
String subnode)
getDataMap method returns a values associated with each key for user repository in given subnode. |
<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)
Returns a user unique ID number within the given repository.
|
void |
initRepository(String resource_uri,
Map<String,String> params)
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. |
addRepo, everyHour, everyMinute, everySecond, getDefaultRepository, getDomainsList, getRepo, getStatistics, removeRepo, repositoriesStream, setDefault, setStatisticsEnabled, wrapInProxygetConfigClass, getDefaultAlias, getName, register, registerConfigBean, unregisterclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitbelongsTogetDefaultBeanClasspublic void addDataList(BareJID user, String subnode, String key, String[] list) throws UserNotFoundException, TigaseDBException
UserRepositoryaddDataList 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.addDataList in interface UserRepositoryuser - 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.public void addUser(BareJID user) throws UserExistsException, TigaseDBException
UserRepositoryaddUser 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.addUser in interface UserRepositoryuser - 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.public String getData(BareJID user, String subnode, String key, String def) throws UserNotFoundException, TigaseDBException
UserRepositorygetData 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.getData in interface UserRepositoryuser - 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.public String getData(BareJID user, String subnode, String key) throws UserNotFoundException, TigaseDBException
UserRepositorygetData 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.getData in interface UserRepositoryuser - 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.public String getData(BareJID user, String key) throws UserNotFoundException, TigaseDBException
UserRepositorygetData 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.getData in interface UserRepositoryuser - 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.public Map<String,String> getDataMap(BareJID user, String subnode) throws TigaseDBException
UserRepositorygetDataMap method returns a values associated with each key for user repository in given subnode.getDataMap in interface UserRepositoryuser - 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.public <T> Map<String,T> getDataMap(BareJID user, String subnode, Function<String,T> converter) throws TigaseDBException
UserRepositorygetDataMap method returns a values associated with each key for user repository in given subnode.getDataMap in interface UserRepositoryuser - 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.public String[] getDataList(BareJID user, String subnode, String key) throws UserNotFoundException, TigaseDBException
UserRepositorygetDataList 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.getDataList in interface UserRepositoryuser - 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.public String[] getKeys(BareJID user, String subnode) throws UserNotFoundException, TigaseDBException
UserRepositorygetKeys 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.getKeys in interface UserRepositoryuser - 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.public String[] getKeys(BareJID user) throws UserNotFoundException, TigaseDBException
UserRepositorygetKeys 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.getKeys in interface UserRepositoryuser - 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.public String getResourceUri()
UserRepositorygetResourceUri in interface UserRepositoryString value representing database connection string.public String[] getSubnodes(BareJID user, String subnode) throws UserNotFoundException, TigaseDBException
UserRepositorygetSubnodes method returns list of all direct subnodes from given node.getSubnodes in interface UserRepositoryuser - 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.public String[] getSubnodes(BareJID user) throws UserNotFoundException, TigaseDBException
UserRepositorygetSubnodes method returns list of all root nodes for given user.getSubnodes in interface UserRepositoryuser - 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.public long getUserUID(BareJID user) throws TigaseDBException
UserRepositorygetUserUID in interface UserRepositoryuser - 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.public List<BareJID> getUsers() throws TigaseDBException
UserRepositorygetUsers in interface UserRepositoryTigaseDBExceptionpublic long getUsersCount()
UserRepositorygetUsersCount in interface UserRepositorylong number of registered users in the repository.public long getUsersCount(String domain)
UserRepositorygetUsersCount in interface UserRepositorylong number of registered users in the repository.@Deprecated public void initRepository(String resource_uri, Map<String,String> params) throws DBInitException
Repositoryresource_uri parameter as the database connection string or via
params map if the required repository parameters are more complex or both.initRepository in interface Repositoryresource_uri - 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.DBInitException - if there was an error during repository initialization. Some implementations,
though, perform so called lazy initialization so even though there is a problem with the underlying repository it
may not be signaled through this method call.public void removeData(BareJID user, String subnode, String key) throws UserNotFoundException, TigaseDBException
UserRepositoryremoveData 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.removeData in interface UserRepositoryuser - 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.public void removeData(BareJID user, String key) throws UserNotFoundException, TigaseDBException
UserRepositoryremoveData 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.removeData in interface UserRepositoryuser - 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.public void removeSubnode(BareJID user, String subnode) throws UserNotFoundException, TigaseDBException
UserRepositoryremoveSubnode 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.removeSubnode in interface UserRepositoryuser - 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.public void removeUser(BareJID user) throws UserNotFoundException, TigaseDBException
UserRepositoryremoveUser 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.removeUser in interface UserRepositoryuser - 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.public void setData(BareJID user, String subnode, String key, String value) throws UserNotFoundException, TigaseDBException
UserRepositorysetData 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.setData in interface UserRepositoryuser - 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.public void setData(BareJID user, String key, String value) throws UserNotFoundException, TigaseDBException
UserRepositorysetData 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.setData in interface UserRepositoryuser - 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.public void setDataList(BareJID user, String subnode, String key, String[] list) throws UserNotFoundException, TigaseDBException
UserRepositorysetDataList 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.setDataList in interface UserRepositoryuser - 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.public boolean userExists(BareJID user)
UserRepositoryuserExists 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.
userExists in interface UserRepositoryuser - a BareJID valueboolean valueCopyright © 2004–2021 "Tigase, Inc.". All rights reserved.