public class XMLRepository extends Object implements AuthRepository, UserRepository
XMLRepository
is a XML implementation of
UserRepository
.
It uses tigase.xml.db
package as repository backend and uses
Bridge design pattern to translate XMLDB
calls to
UserRepository
functions.
Created: Tue Oct 26 15:27:33 2004
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 and Description |
---|
XMLRepository() |
Modifier and Type | Method and Description |
---|---|
void |
addDataList(tigase.xmpp.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(tigase.xmpp.BareJID user)
This
addUser method allows to add new user to repository. |
void |
addUser(tigase.xmpp.BareJID user,
String password)
Describe
addUser method here. |
boolean |
digestAuth(tigase.xmpp.BareJID user,
String digest,
String id,
String alg)
Deprecated.
|
String |
getData(tigase.xmpp.BareJID user,
String key)
getData method returns a value associated with given key for
user repository in default subnode. |
String |
getData(tigase.xmpp.BareJID user,
String subnode,
String key)
getData method returns a value associated with given key for
user repository in given subnode. |
String |
getData(tigase.xmpp.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(tigase.xmpp.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(tigase.xmpp.BareJID user)
getKeys method returns list of all keys stored in default user
repository node. |
String[] |
getKeys(tigase.xmpp.BareJID user,
String subnode)
getKeys method returns list of all keys stored in given
subnode in user repository. |
String |
getResourceUri()
Method description
|
String[] |
getSubnodes(tigase.xmpp.BareJID user)
getSubnodes method returns list of all root nodes for
given user. |
String[] |
getSubnodes(tigase.xmpp.BareJID user,
String subnode)
getSubnodes method returns list of all direct subnodes from
given node. |
List<tigase.xmpp.BareJID> |
getUsers()
Method description
|
long |
getUsersCount()
Method description
|
long |
getUsersCount(String domain)
Method description
|
long |
getUserUID(tigase.xmpp.BareJID user)
Method description
|
void |
initRepository(String file,
Map<String,String> params)
Method description
|
void |
logout(tigase.xmpp.BareJID user)
Method description
|
boolean |
otherAuth(Map<String,Object> props)
Describe
otherAuth method here. |
boolean |
plainAuth(tigase.xmpp.BareJID user,
String password)
Deprecated.
|
void |
queryAuth(Map<String,Object> authProps)
Method description
|
void |
removeData(tigase.xmpp.BareJID user,
String key)
removeData method removes pair (key, value) from user
repository in default repository node. |
void |
removeData(tigase.xmpp.BareJID user,
String subnode,
String key)
removeData method removes pair (key, value) from user
repository in given subnode. |
void |
removeSubnode(tigase.xmpp.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(tigase.xmpp.BareJID user)
This
removeUser method allows to remove user and all his data
from user repository. |
void |
setData(tigase.xmpp.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(tigase.xmpp.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(tigase.xmpp.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 |
updatePassword(tigase.xmpp.BareJID user,
String password)
Method description
|
boolean |
userExists(tigase.xmpp.BareJID user)
Method description
|
public void addDataList(tigase.xmpp.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.addDataList
in interface UserRepository
user
- a String
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.TigaseDBException
UserNotFoundException
- if user id hasn't been found in repository.public void addUser(tigase.xmpp.BareJID user) throws UserExistsException
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.addUser
in interface UserRepository
user
- a String
value of user id consisting of user name
and domain address.UserExistsException
- if user with the same id already exists.public void addUser(tigase.xmpp.BareJID user, String password) throws UserExistsException, TigaseDBException
addUser
method here.addUser
in interface AuthRepository
user
- a String
valuepassword
- a String
valueUserExistsException
- if an error occursTigaseDBException
- if an error occurs@Deprecated public boolean digestAuth(tigase.xmpp.BareJID user, String digest, String id, String alg) throws UserNotFoundException, TigaseDBException, AuthorizationException
digestAuth
method here.digestAuth
in interface AuthRepository
user
- a String
valuedigest
- a String
valueid
- a String
valuealg
- a String
valueboolean
valueAuthorizationException
UserNotFoundException
- if an error occursTigaseDBException
- if an error occurspublic String getData(tigase.xmpp.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.getData
in interface UserRepository
user
- a String
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 exist in repository.String
valueTigaseDBException
UserNotFoundException
- if user id hasn't been found in repository.public String getData(tigase.xmpp.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.getData
in interface UserRepository
user
- a String
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
valueTigaseDBException
UserNotFoundException
- if user id hasn't been found in repository.public String getData(tigase.xmpp.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.getData
in interface UserRepository
user
- a String
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
valueTigaseDBException
UserNotFoundException
- if user id hasn't been found in repository.public String[] getDataList(tigase.xmpp.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.getDataList
in interface UserRepository
user
- a String
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[]
valueTigaseDBException
UserNotFoundException
- if user id hasn't been found in repository.public String[] getKeys(tigase.xmpp.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.getKeys
in interface UserRepository
user
- a String
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[]
valueTigaseDBException
UserNotFoundException
- if user id hasn't been found in repository.public String[] getKeys(tigase.xmpp.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.getKeys
in interface UserRepository
user
- a String
value of user ID for which data must be
stored. User ID consists of user name and domain name.String[]
valueTigaseDBException
UserNotFoundException
- if user id hasn't been found in repository.public String getResourceUri()
getResourceUri
in interface AuthRepository
getResourceUri
in interface UserRepository
String
value of database connection string.public String[] getSubnodes(tigase.xmpp.BareJID user, String subnode) throws UserNotFoundException, TigaseDBException
getSubnodes
method returns list of all direct subnodes from
given node.getSubnodes
in interface UserRepository
user
- a String
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.TigaseDBException
UserNotFoundException
- if user id hasn't been found in repository.public String[] getSubnodes(tigase.xmpp.BareJID user) throws UserNotFoundException, TigaseDBException
getSubnodes
method returns list of all root nodes for
given user.getSubnodes
in interface UserRepository
user
- a String
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.TigaseDBException
UserNotFoundException
- if user id hasn't been found in repository.public long getUserUID(tigase.xmpp.BareJID user) throws TigaseDBException
getUserUID
in interface UserRepository
user
- TigaseDBException
public List<tigase.xmpp.BareJID> getUsers()
getUsers
in interface UserRepository
public long getUsersCount(String domain)
getUsersCount
in interface AuthRepository
getUsersCount
in interface UserRepository
domain
- long
number of registered users in the repository.public long getUsersCount()
getUsersCount
in interface AuthRepository
getUsersCount
in interface UserRepository
long
number of registered users in the repository.public void initRepository(String file, Map<String,String> params)
initRepository
in interface AuthRepository
initRepository
in interface UserRepository
file
- params
- public void logout(tigase.xmpp.BareJID user) throws UserNotFoundException, TigaseDBException
logout
in interface AuthRepository
user
- TigaseDBException
UserNotFoundException
public boolean otherAuth(Map<String,Object> props) throws UserNotFoundException, TigaseDBException, AuthorizationException
otherAuth
method here.otherAuth
in interface AuthRepository
props
- a Map
valueboolean
valueUserNotFoundException
- if an error occursTigaseDBException
- if an error occursAuthorizationException
- if an error occurs@Deprecated public boolean plainAuth(tigase.xmpp.BareJID user, String password) throws UserNotFoundException, TigaseDBException, AuthorizationException
plainAuth
method here.plainAuth
in interface AuthRepository
user
- a String
valuepassword
- a String
valueboolean
valueAuthorizationException
UserNotFoundException
- if an error occursTigaseDBException
- if an error occurspublic void queryAuth(Map<String,Object> authProps)
queryAuth
in interface AuthRepository
authProps
- public void removeData(tigase.xmpp.BareJID user, String subnode, String key) throws UserNotFoundException
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.removeData
in interface UserRepository
user
- a String
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.public void removeData(tigase.xmpp.BareJID user, String key) throws UserNotFoundException
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.removeData
in interface UserRepository
user
- a String
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.public void removeSubnode(tigase.xmpp.BareJID user, String subnode) throws UserNotFoundException
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.removeSubnode
in interface UserRepository
user
- a String
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.public void removeUser(tigase.xmpp.BareJID user) throws UserNotFoundException
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.removeUser
in interface AuthRepository
removeUser
in interface UserRepository
user
- a String
value of user id consisting of user name
and domain address.UserNotFoundException
- if user id hasn't been found in repository.public void setData(tigase.xmpp.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.setData
in interface UserRepository
user
- a String
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.TigaseDBException
UserNotFoundException
- if user id hasn't been found in repository.public void setData(tigase.xmpp.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.setData
in interface UserRepository
user
- a String
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.TigaseDBException
UserNotFoundException
- if user id hasn't been found in repository.public void setDataList(tigase.xmpp.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.setDataList
in interface UserRepository
user
- a String
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.TigaseDBException
UserNotFoundException
- if user id hasn't been found in repository.public void updatePassword(tigase.xmpp.BareJID user, String password) throws UserExistsException, TigaseDBException
updatePassword
in interface AuthRepository
user
- password
- TigaseDBException
UserExistsException
UserNotFoundException
public boolean userExists(tigase.xmpp.BareJID user)
userExists
in interface UserRepository
user
- boolean
valueCopyright © 2013 Tigase. All rights reserved.