Package tigase.db.xml
Class XMLRepository
- java.lang.Object
-
- tigase.db.xml.XMLRepository
-
- All Implemented Interfaces:
AuthRepository
,DataSourceAware<XMLDataSource>
,Repository
,UserRepository
public class XMLRepository extends java.lang.Object implements Repository, DataSourceAware<XMLDataSource>, AuthRepository, UserRepository
ClassXMLRepository
is a XML implementation ofUserRepository
. It usestigase.xml.db
package as repository backend and uses Bridge design pattern to translateXMLDB
calls toUserRepository
functions.
Created: Tue Oct 26 15:27:33 2004
- Author:
- Artur Hefczyc
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface tigase.db.AuthRepository
AuthRepository.AccountStatus, AuthRepository.DefaultCredentials, AuthRepository.SingleCredential
-
Nested classes/interfaces inherited from interface tigase.db.Repository
Repository.Meta, Repository.SchemaId
-
Nested classes/interfaces inherited from interface tigase.db.UserRepository
UserRepository.UserRemovedEvent
-
-
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
-
-
Constructor Summary
Constructors Constructor Description XMLRepository()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addDataList(BareJID user, java.lang.String subnode, java.lang.String key, java.lang.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)
ThisaddUser
method allows to add new user to repository.void
addUser(BareJID user, java.lang.String password)
AuthRepository.AccountStatus
getAccountStatus(BareJID user)
java.lang.String
getData(BareJID user, java.lang.String key)
getData
method returns a value associated with given key for user repository in default subnode.java.lang.String
getData(BareJID user, java.lang.String subnode, java.lang.String key)
getData
method returns a value associated with given key for user repository in given subnode.java.lang.String
getData(BareJID user, java.lang.String subnode, java.lang.String key, java.lang.String def)
getData
method returns a value associated with given key for user repository in given subnode.java.lang.String[]
getDataList(BareJID user, java.lang.String subnode, java.lang.String key)
getDataList
method returns array of values associated with given key ornull
if given key does not exist for given user ID in given node path.java.lang.String[]
getKeys(BareJID user)
getKeys
method returns list of all keys stored in default user repository node.java.lang.String[]
getKeys(BareJID user, java.lang.String subnode)
getKeys
method returns list of all keys stored in given subnode in user repository.java.lang.String
getPassword(BareJID user)
java.lang.String
getResourceUri()
getResourceUri
method returns database connection string.java.lang.String[]
getSubnodes(BareJID user)
getSubnodes
method returns list of all root nodes for given user.java.lang.String[]
getSubnodes(BareJID user, java.lang.String subnode)
Deprecated.java.util.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(java.lang.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(java.lang.String file, java.util.Map<java.lang.String,java.lang.String> params)
Deprecated.boolean
isUserDisabled(BareJID user)
void
loggedIn(BareJID user)
Do some actions on repository, when user logs in.void
logout(BareJID user)
boolean
otherAuth(java.util.Map<java.lang.String,java.lang.Object> props)
void
queryAuth(java.util.Map<java.lang.String,java.lang.Object> authProps)
queryAuth
returns mechanisms available for authentication.void
removeData(BareJID user, java.lang.String key)
removeData
method removes pair (key, value) from user repository in default repository node.void
removeData(BareJID user, java.lang.String subnode, java.lang.String key)
removeData
method removes pair (key, value) from user repository in given subnode.void
removeSubnode(BareJID user, java.lang.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)
ThisremoveUser
method allows to remove user and all his data from user repository.void
setAccountStatus(BareJID user, AuthRepository.AccountStatus status)
void
setData(BareJID user, java.lang.String key, java.lang.String value)
ThissetData
method sets data value for given user ID associated with given key in default repository node.void
setData(BareJID user, java.lang.String subnode, java.lang.String key, java.lang.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, java.lang.String subnode, java.lang.String key, java.lang.String[] list)
setDataList
method sets list of values for given user associated given key in repository under given node path.void
setDataSource(XMLDataSource dataSource)
Method called to provide class with instance of a data source.void
setUserDisabled(BareJID user, java.lang.Boolean value)
void
updatePassword(BareJID user, java.lang.String password)
boolean
userExists(BareJID user)
MethoduserExists
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
-
Methods inherited from interface tigase.db.AuthRepository
getCredentialIds, getCredentials, getUsernames, isMechanismSupported, removeCredential, setCredentialsCodecs, updateCredential
-
Methods inherited from interface tigase.db.UserRepository
getDataMap, getDataMap
-
-
-
-
Method Detail
-
addDataList
public void addDataList(BareJID user, java.lang.String subnode, java.lang.String key, java.lang.String[] list) throws UserNotFoundException, TigaseDBException
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 tosetDataList(...)
except it doesn't remove existing data.- Specified by:
addDataList
in interfaceUserRepository
- Parameters:
user
- aBareJID
value of user ID for which data must be stored. User ID consists of user name and domain name.subnode
- aString
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
- aString
with which the specified values list is to be associated.list
- aString[]
is an array of values to be associated with the specified key.- Throws:
UserNotFoundException
- if user id hasn't been found in repository.TigaseDBException
- if database backend error occurs.
-
addUser
public void addUser(BareJID user) throws UserExistsException
Description copied from interface:UserRepository
ThisaddUser
method allows to add new user to repository. It must throw en exceptionUserExistsException
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 thatuser
id consists of user name and domain address: username@domain.address.net for example.- Specified by:
addUser
in interfaceUserRepository
- Parameters:
user
- aBareJID
value of user id consisting of user name and domain address.- Throws:
UserExistsException
- if user with the same id already exists.
-
addUser
public void addUser(BareJID user, java.lang.String password) throws UserExistsException, TigaseDBException
- Specified by:
addUser
in interfaceAuthRepository
- Throws:
UserExistsException
TigaseDBException
-
getData
public java.lang.String getData(BareJID user, java.lang.String subnode, java.lang.String key, java.lang.String def) throws UserNotFoundException, TigaseDBException
Description copied from interface:UserRepository
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 interfaceUserRepository
- Parameters:
user
- aBareJID
value of user ID for which data must be stored. User ID consists of user name and domain name.subnode
- aString
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
- aString
with which the needed value is associated.def
- aString
value which is returned in case if data for specified key does not exixist in repository.- Returns:
- a
String
value - Throws:
UserNotFoundException
- if user id hasn't been found in repository.TigaseDBException
- if database backend error occurs.
-
getData
public java.lang.String getData(BareJID user, java.lang.String subnode, java.lang.String key) throws UserNotFoundException, TigaseDBException
Description copied from interface:UserRepository
getData
method returns a value associated with given key for user repository in given subnode. If key is not found in repositorynull
value is returned.- Specified by:
getData
in interfaceUserRepository
- Parameters:
user
- aBareJID
value of user ID for which data must be stored. User ID consists of user name and domain name.subnode
- aString
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
- aString
with which the needed value is associated.- Returns:
- a
String
value - Throws:
UserNotFoundException
- if user id hasn't been found in repository.TigaseDBException
- if database backend error occurs.
-
getData
public java.lang.String getData(BareJID user, java.lang.String key) throws UserNotFoundException, TigaseDBException
Description copied from interface:UserRepository
getData
method returns a value associated with given key for user repository in default subnode. If key is not found in repositorynull
value is returned.- Specified by:
getData
in interfaceUserRepository
- Parameters:
user
- aBareJID
value of user ID for which data must be stored. User ID consists of user name and domain name.key
- aString
with which the needed value is associated.- Returns:
- a
String
value - Throws:
UserNotFoundException
- if user id hasn't been found in repository.TigaseDBException
- if database backend error occurs.
-
getDataList
public java.lang.String[] getDataList(BareJID user, java.lang.String subnode, java.lang.String key) throws UserNotFoundException, TigaseDBException
Description copied from interface:UserRepository
getDataList
method returns array of values associated with given key ornull
if given key does not exist for given user ID in given node path.- Specified by:
getDataList
in interfaceUserRepository
- Parameters:
user
- aBareJID
value of user ID for which data must be stored. User ID consists of user name and domain name.subnode
- aString
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
- aString
with which the needed values list is associated.- Returns:
- a
String[]
value - Throws:
UserNotFoundException
- if user id hasn't been found in repository.TigaseDBException
- if database backend error occurs.
-
getKeys
public java.lang.String[] getKeys(BareJID user, java.lang.String subnode) throws UserNotFoundException, TigaseDBException
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 interfaceUserRepository
- Parameters:
user
- aBareJID
value of user ID for which data must be stored. User ID consists of user name and domain name.subnode
- aString
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 - Throws:
UserNotFoundException
- if user id hasn't been found in repository.TigaseDBException
- if database backend error occurs.
-
getKeys
public java.lang.String[] getKeys(BareJID user) throws UserNotFoundException, TigaseDBException
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 interfaceUserRepository
- Parameters:
user
- aBareJID
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 - Throws:
UserNotFoundException
- if user id hasn't been found in repository.TigaseDBException
- if database backend error occurs.
-
getResourceUri
public java.lang.String getResourceUri()
Description copied from interface:AuthRepository
getResourceUri
method returns database connection string.- Specified by:
getResourceUri
in interfaceAuthRepository
- Specified by:
getResourceUri
in interfaceUserRepository
- Returns:
- a
String
value of database connection string.
-
getSubnodes
@Deprecated public java.lang.String[] getSubnodes(BareJID user, java.lang.String subnode) throws UserNotFoundException, TigaseDBException
Deprecated.Description copied from interface:UserRepository
getSubnodes
method returns list of all direct subnodes from given node.- Specified by:
getSubnodes
in interfaceUserRepository
- Parameters:
user
- aBareJID
value of user ID for which data must be stored. User ID consists of user name and domain name.subnode
- aString
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. - Throws:
UserNotFoundException
- if user id hasn't been found in repository.TigaseDBException
- if database backend error occurs.
-
getSubnodes
public java.lang.String[] getSubnodes(BareJID user) throws UserNotFoundException, TigaseDBException
Description copied from interface:UserRepository
getSubnodes
method returns list of all root nodes for given user.- Specified by:
getSubnodes
in interfaceUserRepository
- Parameters:
user
- aBareJID
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. - Throws:
UserNotFoundException
- if user id hasn't been found in repository.TigaseDBException
- if database backend error occurs.
-
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 interfaceUserRepository
- Parameters:
user
- aBareJID
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 java.util.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 interfaceUserRepository
- Returns:
- returns a collection of all user IDs (Jabber IDs) stored in the user repository.
-
getUsersCount
public long getUsersCount(java.lang.String domain)
Description copied from interface:AuthRepository
This method is only used by the server statistics component to report number of registered users for given domain.- Specified by:
getUsersCount
in interfaceAuthRepository
- Specified by:
getUsersCount
in interfaceUserRepository
- Parameters:
domain
- for which get the statistics- Returns:
- a
long
number of registered users in the repository.
-
getUsersCount
public long getUsersCount()
Description copied from interface:AuthRepository
This method is only used by the server statistics component to report number of registered users.- Specified by:
getUsersCount
in interfaceAuthRepository
- Specified by:
getUsersCount
in interfaceUserRepository
- Returns:
- a
long
number of registered users in the repository.
-
initRepository
@Deprecated public void initRepository(java.lang.String file, java.util.Map<java.lang.String,java.lang.String> params) throws DBInitException
Deprecated.Description copied from interface:Repository
Method is deprecated and should not be user any more.
The method is called to initialize the data repository. Depending on the implementation all the initialization parameters can be passed either viaresource_uri
parameter as the database connection string or viaparams
map if the required repository parameters are more complex or both.- Specified by:
initRepository
in interfaceRepository
- Parameters:
file
- value in most cases representing the database connection string.params
- is aMap
with repository properties necessary to initialize and perform all the functions. The initialization parameters are implementation dependent.- Throws:
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.
-
logout
public void logout(BareJID user) throws UserNotFoundException, TigaseDBException
- Specified by:
logout
in interfaceAuthRepository
- Throws:
UserNotFoundException
TigaseDBException
-
loggedIn
public void loggedIn(BareJID user) throws TigaseDBException
Description copied from interface:AuthRepository
Do some actions on repository, when user logs in. (for example updatelast_login_time
)- Specified by:
loggedIn
in interfaceAuthRepository
- Parameters:
user
- JID of logged user.- Throws:
TigaseDBException
- if an error occurs
-
otherAuth
public boolean otherAuth(java.util.Map<java.lang.String,java.lang.Object> props) throws UserNotFoundException, TigaseDBException, AuthorizationException
- Specified by:
otherAuth
in interfaceAuthRepository
- Throws:
UserNotFoundException
TigaseDBException
AuthorizationException
-
queryAuth
public void queryAuth(java.util.Map<java.lang.String,java.lang.Object> authProps)
Description copied from interface:AuthRepository
queryAuth
returns mechanisms available for authentication.- Specified by:
queryAuth
in interfaceAuthRepository
- Parameters:
authProps
- aMap
value with parameters for authentication.
-
removeData
public void removeData(BareJID user, java.lang.String subnode, java.lang.String key) throws UserNotFoundException
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 emptyString
. If key does not exist thenull
value is returned from repository backend or given default value.- Specified by:
removeData
in interfaceUserRepository
- Parameters:
user
- aBareJID
value of user ID for which data must be stored. User ID consists of user name and domain name.subnode
- aString
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
- aString
for which the value is to be removed.- Throws:
UserNotFoundException
- if user id hasn't been found in repository.
-
removeData
public void removeData(BareJID user, java.lang.String key) throws UserNotFoundException
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 emptyString
. If key does not exist thenull
value is returned from repository backend or given default value.- Specified by:
removeData
in interfaceUserRepository
- Parameters:
user
- aBareJID
value of user ID for which data must be stored. User ID consists of user name and domain name.key
- aString
for which the value is to be removed.- Throws:
UserNotFoundException
- if user id hasn't been found in repository.
-
removeSubnode
public void removeSubnode(BareJID user, java.lang.String subnode) throws UserNotFoundException
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 interfaceUserRepository
- Parameters:
user
- aBareJID
value of user ID for which data must be stored. User ID consists of user name and domain name.subnode
- aString
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
.- Throws:
UserNotFoundException
- if user id hasn't been found in repository.
-
removeUser
public void removeUser(BareJID user) throws UserNotFoundException
Description copied from interface:UserRepository
ThisremoveUser
method allows to remove user and all his data from user repository. If given user id does not existUserNotFoundException
must be thrown. As one XMPP server can support many virtual internet domains it is required thatuser
id consists of user name and domain address: username@domain.address.net for example.- Specified by:
removeUser
in interfaceAuthRepository
- Specified by:
removeUser
in interfaceUserRepository
- Parameters:
user
- aBareJID
value of user id consisting of user name and domain address.- Throws:
UserNotFoundException
- if user id hasn't been found in repository.
-
setData
public void setData(BareJID user, java.lang.String subnode, java.lang.String key, java.lang.String value) throws UserNotFoundException, TigaseDBException
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 interfaceUserRepository
- Parameters:
user
- aBareJID
value of user ID for which data must be stored. User ID consists of user name and domain name.subnode
- aString
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
- aString
with which the specified value is to be associated.value
- aString
value to be associated with the specified key.- Throws:
UserNotFoundException
- if user id hasn't been found in repository.TigaseDBException
- if database backend error occurs.
-
setData
public void setData(BareJID user, java.lang.String key, java.lang.String value) throws UserNotFoundException, TigaseDBException
Description copied from interface:UserRepository
ThissetData
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 interfaceUserRepository
- Parameters:
user
- aBareJID
value of user ID for which data must be stored. User ID consists of user name and domain name.key
- aString
with which the specified value is to be associated.value
- aString
value to be associated with the specified key.- Throws:
UserNotFoundException
- if user id hasn't been found in repository.TigaseDBException
- if database backend error occurs.
-
setDataList
public void setDataList(BareJID user, java.lang.String subnode, java.lang.String key, java.lang.String[] list) throws UserNotFoundException, TigaseDBException
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 interfaceUserRepository
- Parameters:
user
- aBareJID
value of user ID for which data must be stored. User ID consists of user name and domain name.subnode
- aString
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
- aString
with which the specified values list is to be associated.list
- aString[]
is an array of values to be associated with the specified key.- Throws:
UserNotFoundException
- if user id hasn't been found in repository.TigaseDBException
- if database backend error occurs.
-
updatePassword
public void updatePassword(BareJID user, java.lang.String password) throws UserExistsException, TigaseDBException
- Specified by:
updatePassword
in interfaceAuthRepository
- Throws:
UserExistsException
TigaseDBException
-
userExists
public boolean userExists(BareJID user)
Description copied from interface:UserRepository
MethoduserExists
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 throwUserNotFoundException
exception in case the user is missing for which you executed the method. The exception is thrown unlessuserAutoCreate
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 interfaceUserRepository
- Parameters:
user
- aBareJID
value- Returns:
- a
boolean
value
-
getPassword
public java.lang.String getPassword(BareJID user) throws UserNotFoundException, TigaseDBException
- Specified by:
getPassword
in interfaceAuthRepository
- Throws:
UserNotFoundException
TigaseDBException
-
isUserDisabled
public boolean isUserDisabled(BareJID user) throws UserNotFoundException, TigaseDBException
- Specified by:
isUserDisabled
in interfaceAuthRepository
- Throws:
UserNotFoundException
TigaseDBException
-
setUserDisabled
public void setUserDisabled(BareJID user, java.lang.Boolean value) throws UserNotFoundException, TigaseDBException
- Specified by:
setUserDisabled
in interfaceAuthRepository
- Throws:
UserNotFoundException
TigaseDBException
-
setAccountStatus
public void setAccountStatus(BareJID user, AuthRepository.AccountStatus status) throws TigaseDBException
- Specified by:
setAccountStatus
in interfaceAuthRepository
- Throws:
TigaseDBException
-
getAccountStatus
public AuthRepository.AccountStatus getAccountStatus(BareJID user) throws TigaseDBException
- Specified by:
getAccountStatus
in interfaceAuthRepository
- Throws:
TigaseDBException
-
setDataSource
public void setDataSource(XMLDataSource dataSource)
Description copied from interface:DataSourceAware
Method called to provide class with instance of a data source.- Specified by:
setDataSource
in interfaceDataSourceAware<XMLDataSource>
-
-