Package tigase.db

Interface UserRepository

  • All Superinterfaces:
    Repository
    All Known Implementing Classes:
    DummyRepository, JDBCRepository, UserRepositoryMDImpl, UserRepositoryMDPoolBean, UserRepositoryPool, XMLRepository

    public interface UserRepository
    extends Repository
    UserRepository interface defines all functionalities required to store user data. It contains adding, removing and searching methods. User repository is organized as hierarchical data base. It means you can add items to repository on different levels like files in file systems. Instead, however of working with directories you work with nodes. You can create many levels of nodes and store data on any level. It helps to organize data in more logical order.

    Created: Tue Oct 26 15:09:28 2004

    Author:
    Artur Hefczyc
    • Method Summary

      All Methods Instance Methods Abstract Methods Default 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)
      This addUser method allows to add new user to repository.
      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 or null if given key does not exist for given user ID in given node path.
      default java.util.Map<java.lang.String,​java.lang.String> getDataMap​(BareJID user, java.lang.String subnode)
      getDataMap method returns a values associated with each key for user repository in given subnode.
      default <T> java.util.Map<java.lang.String,​T> getDataMap​(BareJID user, java.lang.String subnode, java.util.function.Function<java.lang.String,​T> converter)
      getDataMap method returns a values associated with each key for user repository in given subnode.
      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 getResourceUri()
      Returns a DB connection string or DB connection URI.
      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)
      getSubnodes method returns list of all direct subnodes from given node.
      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)
      Deprecated.
      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)
      This removeUser method allows to remove user and all his data from user repository.
      void setData​(BareJID user, java.lang.String key, java.lang.String value)
      This setData 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.
      boolean userExists​(BareJID user)
      Method userExists checks whether the user (or repository top node) exists in the database.
    • Method Detail

      • addDataList

        void addDataList​(BareJID user,
                         java.lang.String subnode,
                         java.lang.String key,
                         java.lang.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.
        Parameters:
        user - a BareJID value of user ID for which data must be stored. User ID consists of user name and domain name.
        subnode - a String value is a node path where data is stored. Node path has the same form as directory path on file system:
        /root/subnode1/subnode2
        .
        key - a String with which the specified values list is to be associated.
        list - a String[] is an array of values to be associated with the specified key.
        Throws:
        UserNotFoundException - if user id hasn't been found in repository.
        TigaseDBException - if database backend error occurs.
      • addUser

        void addUser​(BareJID user)
              throws UserExistsException,
                     TigaseDBException
        This 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.
        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.
        Parameters:
        user - a BareJID value of user id consisting of user name and domain address.
        Throws:
        UserExistsException - if user with the same id already exists.
        TigaseDBException - if database backend error occurs.
      • getData

        java.lang.String getData​(BareJID user,
                                 java.lang.String subnode,
                                 java.lang.String key,
                                 java.lang.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.
        Parameters:
        user - a BareJID value of user ID for which data must be stored. User ID consists of user name and domain name.
        subnode - a String value is a node path where data is stored. Node path has the same form as directory path on file system:
        /root/subnode1/subnode2
        .
        key - a String with which the needed value is associated.
        def - a String value which is returned in case if data for specified key does not exixist in repository.
        Returns:
        a String value
        Throws:
        UserNotFoundException - if user id hasn't been found in repository.
        TigaseDBException - if database backend error occurs.
      • getData

        java.lang.String getData​(BareJID user,
                                 java.lang.String subnode,
                                 java.lang.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.
        Parameters:
        user - a BareJID value of user ID for which data must be stored. User ID consists of user name and domain name.
        subnode - a String value is a node path where data is stored. Node path has the same form as directory path on file system:
        /root/subnode1/subnode2
        .
        key - a String with which the needed value is associated.
        Returns:
        a String value
        Throws:
        UserNotFoundException - if user id hasn't been found in repository.
        TigaseDBException - if database backend error occurs.
      • getData

        java.lang.String getData​(BareJID user,
                                 java.lang.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.
        Parameters:
        user - a BareJID value of user ID for which data must be stored. User ID consists of user name and domain name.
        key - a String with which the needed value is associated.
        Returns:
        a String value
        Throws:
        UserNotFoundException - if user id hasn't been found in repository.
        TigaseDBException - if database backend error occurs.
      • getDataMap

        default java.util.Map<java.lang.String,​java.lang.String> getDataMap​(BareJID user,
                                                                                  java.lang.String subnode)
                                                                           throws UserNotFoundException,
                                                                                  TigaseDBException
        getDataMap method returns a values associated with each key for user repository in given subnode.
        Parameters:
        user - a BareJID value of user ID for which data must be stored. User ID consists of user name and domain name.
        subnode - a String value is a node path where data is stored. Node path has the same form as directory path on file system:
        /root/subnode1/subnode2
        .
        Returns:
        a Map with values
        Throws:
        UserNotFoundException - if user id hasn't been found in repository.
        TigaseDBException - if database backend error occurs.
      • getDataMap

        default <T> java.util.Map<java.lang.String,​T> getDataMap​(BareJID user,
                                                                       java.lang.String subnode,
                                                                       java.util.function.Function<java.lang.String,​T> converter)
                                                                throws UserNotFoundException,
                                                                       TigaseDBException
        getDataMap method returns a values associated with each key for user repository in given subnode.
        Parameters:
        user - a BareJID value of user ID for which data must be stored. User ID consists of user name and domain name.
        subnode - a String value is a node path where data is stored. Node path has the same form as directory path on file system:
        /root/subnode1/subnode2
        .
        converter - a Function which takes value for a key and converts to expected value type
        Returns:
        a Map with values
        Throws:
        UserNotFoundException - if user id hasn't been found in repository.
        TigaseDBException - if database backend error occurs.
      • getDataList

        java.lang.String[] getDataList​(BareJID user,
                                       java.lang.String subnode,
                                       java.lang.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.
        Parameters:
        user - a BareJID value of user ID for which data must be stored. User ID consists of user name and domain name.
        subnode - a String value is a node path where data is stored. Node path has the same form as directory path on file system:
        /root/subnode1/subnode2
        .
        key - a String with which the needed values list is associated.
        Returns:
        a String[] value
        Throws:
        UserNotFoundException - if user id hasn't been found in repository.
        TigaseDBException - if database backend error occurs.
      • getKeys

        java.lang.String[] getKeys​(BareJID user,
                                   java.lang.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.
        Parameters:
        user - a BareJID value of user ID for which data must be stored. User ID consists of user name and domain name.
        subnode - a String value is a node path where data is stored. Node path has the same form as directory path on file system:
        /root/subnode1/subnode2
        .
        Returns:
        a String[] value
        Throws:
        UserNotFoundException - if user id hasn't been found in repository.
        TigaseDBException - if database backend error occurs.
      • getKeys

        java.lang.String[] getKeys​(BareJID user)
                            throws UserNotFoundException,
                                   TigaseDBException
        getKeys method returns list of all keys stored in default user repository node. There is some a value (or list of values) associated with each key. It is up to user (developer) to know what key keeps one value and what key keeps list of values.
        Parameters:
        user - a BareJID 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

        java.lang.String getResourceUri()
        Returns a DB connection string or DB connection URI.
        Returns:
        a String value representing database connection string.
      • getSubnodes

        java.lang.String[] getSubnodes​(BareJID user,
                                       java.lang.String subnode)
                                throws UserNotFoundException,
                                       TigaseDBException
        getSubnodes method returns list of all direct subnodes from given node.
        Parameters:
        user - a BareJID value of user ID for which data must be stored. User ID consists of user name and domain name.
        subnode - a String value is a node path where data is stored. Node path has the same form as directory path on file system:
        /root/subnode1/subnode2
        .
        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

        java.lang.String[] getSubnodes​(BareJID user)
                                throws UserNotFoundException,
                                       TigaseDBException
        getSubnodes method returns list of all root nodes for given user.
        Parameters:
        user - a BareJID 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

        @Deprecated
        long getUserUID​(BareJID user)
                 throws TigaseDBException
        Deprecated.
        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.
        Parameters:
        user - a BareJID 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

        java.util.List<BareJID> getUsers()
                                  throws TigaseDBException
        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.
        Returns:
        returns a collection of all user IDs (Jabber IDs) stored in the user repository.
        Throws:
        TigaseDBException
      • getUsersCount

        long getUsersCount()
        This method is only used by the server statistics component to report number of registered users.
        Returns:
        a long number of registered users in the repository.
      • getUsersCount

        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.
        Returns:
        a long number of registered users in the repository.
      • removeData

        void removeData​(BareJID user,
                        java.lang.String subnode,
                        java.lang.String key)
                 throws UserNotFoundException,
                        TigaseDBException
        removeData method removes pair (key, value) from user repository in given subnode. If the key exists in user repository there is always a value associated with this key - even empty String. If key does not exist the null value is returned from repository backend or given default value.
        Parameters:
        user - a BareJID value of user ID for which data must be stored. User ID consists of user name and domain name.
        subnode - a String value is a node path where data is stored. Node path has the same form as directory path on file system:
        /root/subnode1/subnode2
        .
        key - a String for which the value is to be removed.
        Throws:
        UserNotFoundException - if user id hasn't been found in repository.
        TigaseDBException - if database backend error occurs.
      • removeData

        void removeData​(BareJID user,
                        java.lang.String key)
                 throws UserNotFoundException,
                        TigaseDBException
        removeData method removes pair (key, value) from user repository in default repository node. If the key exists in user repository there is always a value associated with this key - even empty String. If key does not exist the null value is returned from repository backend or given default value.
        Parameters:
        user - a BareJID value of user ID for which data must be stored. User ID consists of user name and domain name.
        key - a String for which the value is to be removed.
        Throws:
        UserNotFoundException - if user id hasn't been found in repository.
        TigaseDBException - if database backend error occurs.
      • removeSubnode

        void removeSubnode​(BareJID user,
                           java.lang.String subnode)
                    throws UserNotFoundException,
                           TigaseDBException
        removeSubnode method removes given subnode with all subnodes in this node and all data stored in this node and in all subnodes. Effectively it removes entire repository tree starting from given node.
        Parameters:
        user - a BareJID value of user ID for which data must be stored. User ID consists of user name and domain name.
        subnode - a String value is a node path to subnode which has to be removed. Node path has the same form as directory path on file system:
        /root/subnode1/subnode2
        .
        Throws:
        UserNotFoundException - if user id hasn't been found in repository.
        TigaseDBException - if database backend error occurs.
      • removeUser

        void removeUser​(BareJID user)
                 throws UserNotFoundException,
                        TigaseDBException
        This 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.
        Parameters:
        user - a BareJID value of user id consisting of user name and domain address.
        Throws:
        UserNotFoundException - if user id hasn't been found in repository.
        TigaseDBException - if database backend error occurs.
      • setData

        void setData​(BareJID user,
                     java.lang.String subnode,
                     java.lang.String key,
                     java.lang.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.
        Parameters:
        user - a BareJID value of user ID for which data must be stored. User ID consists of user name and domain name.
        subnode - a String value is a node path where data is stored. Node path has the same form as directory path on file system:
        /root/subnode1/subnode2
        .
        key - a String with which the specified value is to be associated.
        value - a String value to be associated with the specified key.
        Throws:
        UserNotFoundException - if user id hasn't been found in repository.
        TigaseDBException - if database backend error occurs.
      • setData

        void setData​(BareJID user,
                     java.lang.String key,
                     java.lang.String value)
              throws UserNotFoundException,
                     TigaseDBException
        This 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.
        Parameters:
        user - a BareJID value of user ID for which data must be stored. User ID consists of user name and domain name.
        key - a String with which the specified value is to be associated.
        value - a String value to be associated with the specified key.
        Throws:
        UserNotFoundException - if user id hasn't been found in repository.
        TigaseDBException - if database backend error occurs.
      • setDataList

        void setDataList​(BareJID user,
                         java.lang.String subnode,
                         java.lang.String key,
                         java.lang.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.
        Parameters:
        user - a BareJID value of user ID for which data must be stored. User ID consists of user name and domain name.
        subnode - a String value is a node path where data is stored. Node path has the same form as directory path on file system:
        /root/subnode1/subnode2
        .
        key - a String with which the specified values list is to be associated.
        list - a String[] is an array of values to be associated with the specified key.
        Throws:
        UserNotFoundException - if user id hasn't been found in repository.
        TigaseDBException - if database backend error occurs.
      • userExists

        boolean userExists​(BareJID user)
        Method userExists checks whether the user (or repository top node) exists in the database. The method doesn't throw any exception nor it creates the user in case it is missing. It just checks whether the user is already in the database.
        Please don't overuse this method. All other methods throw 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.
        Therefore this method should be used only to check whether the account exists without creating it.
        Parameters:
        user - a BareJID value
        Returns:
        a boolean value