Package com.priint.pubserver.usermanager

Class PubServerUser

  • All Implemented Interfaces:
    java.io.Serializable
    public class PubServerUser
extends java.lang.Object
implements java.io.Serializable
    Class representing a user of pubserver kernel, authenticated by some internal or external realm.
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  PubServerUser.LoginToken
      Simple data object for parsing and formatting qualified login strings.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ADMIN_LOGIN
      Default admin login name
      static java.lang.String CONFIG_TYPE_NAME
      Default user config type name

    • Constructor Summary

      Constructors 
      Constructor Description
      PubServerUser()
      Default constructor
      PubServerUser​(java.lang.String loginName)
      Constructor with login name.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static java.lang.String decryptSalt​(java.lang.String encryptedSalt)  
      static java.lang.String encryptSalt​(java.lang.String salt)
      This method return encrypted salt
      static java.lang.String generateHashPassword​(java.lang.String password, java.lang.String encryptedPasswordSalt)
      Generate a hash for password string
      static java.lang.String generateNewSalt()  
      java.util.List<java.lang.String> getClients()  
      java.util.Date getCreated()  
      java.lang.String getEmail()  
      java.util.Date getExpiryDate()  
      java.lang.String getFirstName()  
      java.lang.String getIdentifier()  
      java.lang.String getLastName()  
      java.lang.String getLoginName()  
      java.lang.String getPasswordHash()  
      java.lang.String getPasswordSalt()  
      java.lang.String getPluginConfigName()
      Gets the name of entity for the given login to use in plug-in configuration objects.
      java.lang.String getPluginConfigPath()
      Gets the path of entity for the given login to use in plug-in configuration objects.
      static java.lang.String getPluginConfigPath​(java.lang.String loginName)
      Gets the path of entity for the given login to use in plug-in configuration objects.
      boolean isActive()  
      boolean isShouldChangePassword()  
      void setActive​(boolean active)
      Set information about whether the account is active
      void setClients​(java.util.List<java.lang.String> clients)  
      void setCreated​(java.util.Date created)
      Set value when user was created in application
      void setEmail​(java.lang.String email)
      Set user email
      void setExpiryDate​(java.util.Date expiryDate)
      Set expiry date to user account
      void setFirstName​(java.lang.String firstName)
      Set user first name
      void setIdentifier​(java.lang.String identifier)
      Set user identifier
      void setLastName​(java.lang.String lastName)
      Set user last name
      void setLoginName​(java.lang.String loginName)
      Set user login name
      void setPasswordHash​(java.lang.String passwordHash)
      Set encrypte user password
      void setPasswordSalt​(java.lang.String passwordSalt)
      Salt password parameter
      void setShouldChangePassword​(boolean shouldChangePassword)
      Set information about whether the user should change password

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • ADMIN_LOGIN

        public static final java.lang.String ADMIN_LOGIN
        Default admin login name
        See Also:
        Constant Field Values

      • CONFIG_TYPE_NAME

        public static final java.lang.String CONFIG_TYPE_NAME
        Default user config type name
        See Also:
        Constant Field Values

    • Constructor Detail

      • PubServerUser

        public PubServerUser()
        Default constructor

      • PubServerUser

        public PubServerUser​(java.lang.String loginName)
        Constructor with login name. When login name is null then the IllegalArgumentException will be thrown
        Parameters:
        loginName - User loign name

    • Method Detail

      • getIdentifier

        public java.lang.String getIdentifier()
        Returns:
        User identifier

      • setIdentifier

        public void setIdentifier​(java.lang.String identifier)
        Set user identifier

      • getLoginName

        public java.lang.String getLoginName()
        Returns:
        User login name

      • setLoginName

        public void setLoginName​(java.lang.String loginName)
        Set user login name

      • getFirstName

        public java.lang.String getFirstName()
        Returns:
        User first name

      • setFirstName

        public void setFirstName​(java.lang.String firstName)
        Set user first name

      • getLastName

        public java.lang.String getLastName()
        Returns:
        User last name

      • setLastName

        public void setLastName​(java.lang.String lastName)
        Set user last name

      • getEmail

        public java.lang.String getEmail()
        Returns:
        User email

      • setEmail

        public void setEmail​(java.lang.String email)
        Set user email

      • getCreated

        public java.util.Date getCreated()
        Returns:
        Info when user was created in application

      • setCreated

        public void setCreated​(java.util.Date created)
        Set value when user was created in application

      • getExpiryDate

        public java.util.Date getExpiryDate()
        Returns:
        User account expiry date

      • setExpiryDate

        public void setExpiryDate​(java.util.Date expiryDate)
        Set expiry date to user account

      • getPasswordSalt

        public java.lang.String getPasswordSalt()
        Returns:
        User passowrd salt

      • setPasswordSalt

        public void setPasswordSalt​(java.lang.String passwordSalt)
        Salt password parameter

      • getPasswordHash

        public java.lang.String getPasswordHash()
        Returns:
        Encrypted user password

      • setPasswordHash

        public void setPasswordHash​(java.lang.String passwordHash)
        Set encrypte user password

      • isActive

        public boolean isActive()
        Returns:
        Information about whether the account is active

      • setActive

        public void setActive​(boolean active)
        Set information about whether the account is active

      • isShouldChangePassword

        public boolean isShouldChangePassword()
        Returns:
        Information about whether the user should change password

      • setShouldChangePassword

        public void setShouldChangePassword​(boolean shouldChangePassword)
        Set information about whether the user should change password

      • getClients

        public java.util.List<java.lang.String> getClients()

      • setClients

        public void setClients​(java.util.List<java.lang.String> clients)

      • generateHashPassword

        public static final java.lang.String generateHashPassword​(java.lang.String password,
                                                          java.lang.String encryptedPasswordSalt)
        Generate a hash for password string
        Parameters:
        password -
        encryptedPasswordSalt -
        Returns:
        hashed password

      • encryptSalt

        public static final java.lang.String encryptSalt​(java.lang.String salt)
        This method return encrypted salt
        Parameters:
        salt -
        Returns:
        encrypted salt

      • decryptSalt

        public static final java.lang.String decryptSalt​(java.lang.String encryptedSalt)
        Parameters:
        encryptedSalt -
        Returns:
        decrypted salt

      • generateNewSalt

        public static final java.lang.String generateNewSalt()
        Returns:
        new randomly generated salt

      • getPluginConfigName

        public java.lang.String getPluginConfigName()
        Gets the name of entity for the given login to use in plug-in configuration objects. E.g. "johndoe.xml"
        Returns:
        string containing repository path

      • getPluginConfigPath

        public java.lang.String getPluginConfigPath()
        Gets the path of entity for the given login to use in plug-in configuration objects.
        Returns:
        string containing repository path

      • getPluginConfigPath

        public static java.lang.String getPluginConfigPath​(java.lang.String loginName)
        Gets the path of entity for the given login to use in plug-in configuration objects.
        Returns:
        string containing repository path