Package tigase.db
Class DummyRepository
java.lang.Object
tigase.db.DummyRepository
- All Implemented Interfaces:
AuthRepository,DataSource,Repository,UserRepository
public class DummyRepository
extends Object
implements Repository, DataSource, 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
Created: Sat Nov 3 16:17:03 2007
- Author:
- Artur Hefczyc
-
Nested Class Summary
Nested classes/interfaces inherited from interface tigase.db.AuthRepository
AuthRepository.AccountStatus, AuthRepository.DefaultCredentials, AuthRepository.SingleCredentialNested classes/interfaces inherited from interface tigase.db.Repository
Repository.Meta, Repository.SchemaIdNested classes/interfaces inherited from interface tigase.db.UserRepository
UserRepository.UserBeforeRemovedEvent, 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_KEYFields inherited from interface tigase.db.DataSource
log -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddDataList(BareJID user, String subnode, String key, String[] list) addDataListmethod adds mode entries to existing data list associated with given key in repository under given node path.voidThisaddUsermethod allows to add new user to repository.voidgetAccountStatus(BareJID user) longgetActiveUsersCountIn(Duration duration) getDatamethod returns a value associated with given key for user repository in default subnode.getDatamethod returns a value associated with given key for user repository in given subnode.getDatamethod returns a value associated with given key for user repository in given subnode.String[]getDataList(BareJID user, String subnode, String key) getDataListmethod returns array of values associated with given key ornullif given key does not exist for given user ID in given node path.String[]getKeysmethod returns list of all keys stored in default user repository node.String[]getKeysmethod returns list of all keys stored in given subnode in user repository.getPassword(BareJID user) Returns a DB connection string or DB connection URI.getSchemaVersion(String component) Method obtains version of the schema for particular component stored in the database.String[]getSubnodes(BareJID user) getSubnodesmethod returns list of all root nodes for given user.String[]getSubnodes(BareJID user, String subnode) Deprecated.getUsers()This method is only used by the data conversion tools.longThis method is only used by the server statistics component to report number of registered users.longgetUsersCount(String domain) This method is only used by the server statistics component to report number of registered users for given domain.longgetUserUID(BareJID user) Returns a user unique ID number within the given repository.voidinitialize(String connStr) The method is called to initialize the data repository.voidinitRepository(String string, Map<String, String> params) Deprecated.booleanisUserDisabled(BareJID user) voidDo some actions on repository, when user logs in.voidbooleanvoidqueryAuthreturns mechanisms available for authentication.voidremoveData(BareJID user, String key) removeDatamethod removes pair (key, value) from user repository in default repository node.voidremoveData(BareJID user, String subnode, String key) removeDatamethod removes pair (key, value) from user repository in given subnode.voidremoveSubnode(BareJID user, String subnode) removeSubnodemethod removes given subnode with all subnodes in this node and all data stored in this node and in all subnodes.voidremoveUser(BareJID user) ThisremoveUsermethod allows to remove user and all his data from user repository.voidsetAccountStatus(BareJID user, AuthRepository.AccountStatus status) voidThissetDatamethod sets data value for given user ID associated with given key in default repository node.voidsetDatamethod sets data value for given user ID in repository under given node path and associates it with given key.voidsetDataList(BareJID user, String subnode, String key, String[] list) setDataListmethod sets list of values for given user associated given key in repository under given node path.voidsetUserDisabled(BareJID user, Boolean value) voidupdatePassword(BareJID user, String password) booleanuserExists(BareJID user) MethoduserExistschecks 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, waitMethods inherited from interface tigase.db.AuthRepository
getCredentialIds, getCredentials, getUsernames, isMechanismSupported, removeCredential, setCredentialsCodecs, updateCredential, updateCredentialMethods inherited from interface tigase.db.DataSource
automaticSchemaManagement, checkConnectivity, checkSchemaVersionMethods inherited from interface tigase.db.UserRepository
getDataMap, getDataMap, getDataMap
-
Constructor Details
-
DummyRepository
public DummyRepository()
-
-
Method Details
-
addDataList
Description copied from interface:UserRepositoryaddDataListmethod 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:
addDataListin interfaceUserRepository- Parameters:
user- aBareJIDvalue of user ID for which data must be stored. User ID consists of user name and domain name.subnode- aStringvalue is a node path where data is stored. Node path has the same form as directory path on file system:/root/subnode1/subnode2
.key- aStringwith which the specified values list is to be associated.list- aString[]is an array of values to be associated with the specified key.
-
addUser
Description copied from interface:UserRepositoryThisaddUsermethod allows to add new user to repository. It must throw en exceptionUserExistsExceptionif 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 thatuserid consists of user name and domain address: username@domain.address.net for example.- Specified by:
addUserin interfaceUserRepository- Parameters:
user- aBareJIDvalue of user id consisting of user name and domain address.
-
getActiveUsersCountIn
- Specified by:
getActiveUsersCountInin interfaceAuthRepository- Parameters:
duration- Time range within which active users should be counted. Method is only used by statistics.- Returns:
- number of active users in required range
-
addUser
- Specified by:
addUserin interfaceAuthRepository- Throws:
UserExistsExceptionTigaseDBException
-
getData
getDatamethod 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:
getDatain interfaceUserRepository- Parameters:
user- aBareJIDvalue of user ID for which data must be stored. User ID consists of user name and domain name.subnode- aStringvalue is a node path where data is stored. Node path has the same form as directory path on file system:/root/subnode1/subnode2
.key- aStringwith which the needed value is associated.def- aStringvalue which is returned in case if data for specified key does not exixist in repository.- Returns:
- a
Stringvalue of null always.
-
getData
getDatamethod returns a value associated with given key for user repository in given subnode. If key is not found in repositorynullvalue is returned.- Specified by:
getDatain interfaceUserRepository- Parameters:
user- aBareJIDvalue of user ID for which data must be stored. User ID consists of user name and domain name.subnode- aStringvalue is a node path where data is stored. Node path has the same form as directory path on file system:/root/subnode1/subnode2
.key- aStringwith which the needed value is associated.- Returns:
- a
Stringvalue of null always.
-
getData
getDatamethod returns a value associated with given key for user repository in default subnode. If key is not found in repositorynullvalue is returned.- Specified by:
getDatain interfaceUserRepository- Parameters:
user- aBareJIDvalue of user ID for which data must be stored. User ID consists of user name and domain name.key- aStringwith which the needed value is associated.- Returns:
- a
Stringvalue of null always.
-
getDataList
Description copied from interface:UserRepositorygetDataListmethod returns array of values associated with given key ornullif given key does not exist for given user ID in given node path.- Specified by:
getDataListin interfaceUserRepository- Parameters:
user- aBareJIDvalue of user ID for which data must be stored. User ID consists of user name and domain name.subnode- aStringvalue is a node path where data is stored. Node path has the same form as directory path on file system:/root/subnode1/subnode2
.key- aStringwith which the needed values list is associated.- Returns:
- a
String[]value
-
getKeys
Description copied from interface:UserRepositorygetKeysmethod 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:
getKeysin interfaceUserRepository- Parameters:
user- aBareJIDvalue of user ID for which data must be stored. User ID consists of user name and domain name.subnode- aStringvalue 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
Description copied from interface:UserRepositorygetKeysmethod 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:
getKeysin interfaceUserRepository- Parameters:
user- aBareJIDvalue of user ID for which data must be stored or retrieved. User ID consists of user name and domain name.- Returns:
- a
String[]value
-
getSchemaVersion
Description copied from interface:DataSourceMethod obtains version of the schema for particular component stored in the database.- Specified by:
getSchemaVersionin interfaceDataSource- Parameters:
component- name of the component for which we want to get the schema version- Returns:
- an optional value of the version.
-
getResourceUri
Description copied from interface:DataSourceReturns a DB connection string or DB connection URI.- Specified by:
getResourceUriin interfaceAuthRepository- Specified by:
getResourceUriin interfaceDataSource- Specified by:
getResourceUriin interfaceUserRepository- Returns:
- a
Stringvalue representing database connection string.
-
getSubnodes
Deprecated.Description copied from interface:UserRepositorygetSubnodesmethod returns list of all direct subnodes from given node.- Specified by:
getSubnodesin interfaceUserRepository- Parameters:
user- aBareJIDvalue of user ID for which data must be stored. User ID consists of user name and domain name.subnode- aStringvalue 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
Description copied from interface:UserRepositorygetSubnodesmethod returns list of all root nodes for given user.- Specified by:
getSubnodesin interfaceUserRepository- Parameters:
user- aBareJIDvalue 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
Description copied from interface:UserRepositoryReturns 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:
getUserUIDin interfaceUserRepository- Parameters:
user- aBareJIDvalue 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
Description copied from interface:UserRepositoryThis 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:
getUsersin interfaceUserRepository- Returns:
- returns a collection of all user IDs (Jabber IDs) stored in the user repository.
-
getUsersCount
public long getUsersCount()Description copied from interface:UserRepositoryThis method is only used by the server statistics component to report number of registered users.- Specified by:
getUsersCountin interfaceAuthRepository- Specified by:
getUsersCountin interfaceUserRepository- Returns:
- a
longnumber of registered users in the repository.
-
getUsersCount
Description copied from interface:UserRepositoryThis method is only used by the server statistics component to report number of registered users for given domain.- Specified by:
getUsersCountin interfaceAuthRepository- Specified by:
getUsersCountin interfaceUserRepository- Parameters:
domain- for which get the statistics- Returns:
- a
longnumber of registered users in the repository.
-
initialize
Description copied from interface:DataSourceThe method is called to initialize the data repository.- Specified by:
initializein interfaceDataSource- Parameters:
connStr- value in most cases representing the database connection string.- Throws:
RepositoryException- if there was an error during initialization of data source. Some implementations, though, perform so called lazy initialization so even though there is a problem with the underlying data source it may not be signaled through this method call.
-
initRepository
Deprecated.Description copied from interface:RepositoryMethod 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_uriparameter as the database connection string or viaparamsmap if the required repository parameters are more complex or both.- Specified by:
initRepositoryin interfaceRepository- Parameters:
string- value in most cases representing the database connection string.params- is aMapwith repository properties necessary to initialize and perform all the functions. The initialization parameters are implementation dependent.
-
loggedIn
Description copied from interface:AuthRepositoryDo some actions on repository, when user logs in. (for example updatelast_login_time)- Specified by:
loggedInin interfaceAuthRepository- Parameters:
jid- JID of logged user.- Throws:
TigaseDBException- if an error occurs
-
logout
- Specified by:
logoutin interfaceAuthRepository- Throws:
UserNotFoundExceptionTigaseDBException
-
otherAuth
public boolean otherAuth(Map<String, Object> authProps) throws UserNotFoundException, TigaseDBException, AuthorizationException- Specified by:
otherAuthin interfaceAuthRepository- Throws:
UserNotFoundExceptionTigaseDBExceptionAuthorizationException
-
queryAuth
Description copied from interface:AuthRepositoryqueryAuthreturns mechanisms available for authentication.- Specified by:
queryAuthin interfaceAuthRepository- Parameters:
authProps- aMapvalue with parameters for authentication.
-
removeData
Description copied from interface:UserRepositoryremoveDatamethod 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 thenullvalue is returned from repository backend or given default value.- Specified by:
removeDatain interfaceUserRepository- Parameters:
user- aBareJIDvalue of user ID for which data must be stored. User ID consists of user name and domain name.subnode- aStringvalue is a node path where data is stored. Node path has the same form as directory path on file system:/root/subnode1/subnode2
.key- aStringfor which the value is to be removed.
-
removeData
Description copied from interface:UserRepositoryremoveDatamethod 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 thenullvalue is returned from repository backend or given default value.- Specified by:
removeDatain interfaceUserRepository- Parameters:
user- aBareJIDvalue of user ID for which data must be stored. User ID consists of user name and domain name.key- aStringfor which the value is to be removed.
-
removeSubnode
Description copied from interface:UserRepositoryremoveSubnodemethod 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:
removeSubnodein interfaceUserRepository- Parameters:
user- aBareJIDvalue of user ID for which data must be stored. User ID consists of user name and domain name.subnode- aStringvalue 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
Description copied from interface:UserRepositoryThisremoveUsermethod allows to remove user and all his data from user repository. If given user id does not existUserNotFoundExceptionmust be thrown. As one XMPP server can support many virtual internet domains it is required thatuserid consists of user name and domain address: username@domain.address.net for example.- Specified by:
removeUserin interfaceAuthRepository- Specified by:
removeUserin interfaceUserRepository- Parameters:
user- aBareJIDvalue of user id consisting of user name and domain address.
-
setData
Description copied from interface:UserRepositorysetDatamethod 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:
setDatain interfaceUserRepository- Parameters:
user- aBareJIDvalue of user ID for which data must be stored. User ID consists of user name and domain name.subnode- aStringvalue is a node path where data is stored. Node path has the same form as directory path on file system:/root/subnode1/subnode2
.key- aStringwith which the specified value is to be associated.value- aStringvalue to be associated with the specified key.
-
setData
Description copied from interface:UserRepositoryThissetDatamethod 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:
setDatain interfaceUserRepository- Parameters:
user- aBareJIDvalue of user ID for which data must be stored. User ID consists of user name and domain name.key- aStringwith which the specified value is to be associated.value- aStringvalue to be associated with the specified key.
-
setDataList
Description copied from interface:UserRepositorysetDataListmethod 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:
setDataListin interfaceUserRepository- Parameters:
user- aBareJIDvalue of user ID for which data must be stored. User ID consists of user name and domain name.subnode- aStringvalue is a node path where data is stored. Node path has the same form as directory path on file system:/root/subnode1/subnode2
.key- aStringwith which the specified values list is to be associated.list- aString[]is an array of values to be associated with the specified key.
-
updatePassword
public void updatePassword(BareJID user, String password) throws UserNotFoundException, TigaseDBException - Specified by:
updatePasswordin interfaceAuthRepository- Throws:
UserNotFoundExceptionTigaseDBException
-
userExists
Description copied from interface:UserRepositoryMethoduserExistschecks 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 throwUserNotFoundExceptionexception in case the user is missing for which you executed the method. The exception is thrown unlessuserAutoCreateproperty 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:
userExistsin interfaceUserRepository- Parameters:
user- aBareJIDvalue- Returns:
- a
booleanvalue
-
getPassword
- Specified by:
getPasswordin interfaceAuthRepository- Throws:
UserNotFoundExceptionTigaseDBException
-
isUserDisabled
- Specified by:
isUserDisabledin interfaceAuthRepository- Throws:
UserNotFoundExceptionTigaseDBException
-
setUserDisabled
public void setUserDisabled(BareJID user, Boolean value) throws UserNotFoundException, TigaseDBException - Specified by:
setUserDisabledin interfaceAuthRepository- Throws:
UserNotFoundExceptionTigaseDBException
-
setAccountStatus
public void setAccountStatus(BareJID user, AuthRepository.AccountStatus status) throws TigaseDBException - Specified by:
setAccountStatusin interfaceAuthRepository- Throws:
TigaseDBException
-
getAccountStatus
- Specified by:
getAccountStatusin interfaceAuthRepository- Throws:
TigaseDBException
-