Package org.apache.turbine.om.security

Interface User

    • Method Detail

      • getAccessCounter

        int getAccessCounter()
        Gets the access counter for a user from perm storage.
        Returns:
        The access counter for the user.

      • getAccessCounterForSession

        int getAccessCounterForSession()
        Gets the access counter for a user during a session.
        Returns:
        The access counter for the user for the session.

      • getLastAccessDate

        Date getLastAccessDate()
        Gets the last access date for this User. This is the last time that the user object was referenced.
        Returns:
        A Java Date with the last access date for the user.

      • getCreateDate

        Date getCreateDate()
        Gets the create date for this User. This is the time at which the user object was created.
        Returns:
        A Java Date with the date of creation for the user.

      • getLastLogin

        Date getLastLogin()
        Returns the user's last login date.
        Returns:
        A Java Date with the last login date for the user.

      • getPerm

        Object getPerm​(String name)
        Get an object from permanent storage.
        Parameters:
        name - The object's name.
        Returns:
        An Object with the given name.

      • getPerm

        Object getPerm​(String name,
               Object def)
        Get an object from permanent storage; return default if value is null.
        Parameters:
        name - The object's name.
        def - A default value to return.
        Returns:
        An Object with the given name.

      • getPermStorage

        Map<String,​Object> getPermStorage()
        This should only be used in the case where we want to save the data to the database.
        Returns:
        A Map.

      • getTempStorage

        Map<String,​Object> getTempStorage()
        This should only be used in the case where we want to save the data to the database.
        Returns:
        A Map.

      • getTemp

        Object getTemp​(String name)
        Get an object from temporary storage.
        Parameters:
        name - The object's name.
        Returns:
        An Object with the given name.

      • getTemp

        Object getTemp​(String name,
               Object def)
        Get an object from temporary storage; return default if value is null.
        Parameters:
        name - The object's name.
        def - A default value to return.
        Returns:
        An Object with the given name.

      • setHasLoggedIn

        void setHasLoggedIn​(Boolean value)
        This sets whether or not someone has logged in. hasLoggedIn() returns this value.
        Parameters:
        value - Whether someone has logged in or not.

      • hasLoggedIn

        boolean hasLoggedIn()
        The user is considered logged in if they have not timed out.
        Returns:
        True if the user has logged in.

      • removeTemp

        Object removeTemp​(String name)
        Remove an object from temporary storage and return the object.
        Parameters:
        name - The name of the object to remove.
        Returns:
        An Object.

      • setAccessCounter

        void setAccessCounter​(int cnt)
        Sets the access counter for a user, saved in perm storage.
        Parameters:
        cnt - The new count.

      • setAccessCounterForSession

        void setAccessCounterForSession​(int cnt)
        Sets the session access counter for a user, saved in temp storage.
        Parameters:
        cnt - The new count.

      • setLastAccessDate

        void setLastAccessDate()
        Sets the last access date for this User. This is the last time that the user object was referenced.

      • setLastLogin

        void setLastLogin​(Date lastLogin)
        Set last login date/time.
        Parameters:
        lastLogin - The last login date.

      • setPerm

        void setPerm​(String name,
             Object value)
        Put an object into permanent storage.
        Parameters:
        name - The object's name.
        value - The object.

      • setPermStorage

        void setPermStorage​(Map<String,​Object> storage)
        This should only be used in the case where we want to save the data to the database.
        Parameters:
        storage - A Map.

      • setTempStorage

        void setTempStorage​(Map<String,​Object> storage)
        This should only be used in the case where we want to save the data to the database.
        Parameters:
        storage - A Map.

      • setTemp

        void setTemp​(String name,
             Object value)
        Put an object into temporary storage.
        Parameters:
        name - The object's name.
        value - The object.

      • setCreateDate

        void setCreateDate​(Date date)
        Sets the creation date for this user.
        Parameters:
        date - Creation date

      • isConfirmed

        boolean isConfirmed()
        This method reports whether or not the user has been confirmed in the system by checking the TurbineUserPeer.CONFIRM_VALUE column to see if it is equal to CONFIRM_DATA.
        Returns:
        True if the user has been confirmed.

      • setConfirmed

        void setConfirmed​(String value)
        Sets the confirmation value.
        Parameters:
        value - The confirmation key value.

      • getConfirmed

        String getConfirmed()
        Gets the confirmation value.
        Returns:
        The confirmed value