Package org.apache.catalina.users

Class AbstractUser

  • All Implemented Interfaces:
    java.security.Principal, User
    Direct Known Subclasses:
    GenericUser
    public abstract class AbstractUser
extends java.lang.Object
implements User

    Convenience base class for User implementations.

    Since:
    4.1

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.lang.String fullName
      The full name of this user.
      protected java.lang.String password
      The logon password of this user.
      protected java.lang.String username
      The logon username of this user.

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected AbstractUser()
      Constructs a new AbstractUser.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getFullName()
      Returns the full name of this user.
      java.lang.String getName()
      Make the principal name the same as the user name.
      java.lang.String getPassword()
      Returns the logon password of this user.
      java.lang.String getUsername()
      Returns the logon username of this user.
      void setFullName​(java.lang.String fullName)
      Set the full name of this user.
      void setPassword​(java.lang.String password)
      Set the logon password of this user, optionally prefixed with the identifier of an encoding scheme surrounded by curly braces, such as {md5}xxxxx.
      void setUsername​(java.lang.String username)
      Set the logon username of this user, which must be unique within the scope of a UserDatabase.

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface java.security.Principal

        equals, hashCode, implies, toString

    • Field Detail

      • fullName

        protected java.lang.String fullName
        The full name of this user.

      • password

        protected java.lang.String password
        The logon password of this user.

      • username

        protected java.lang.String username
        The logon username of this user.

    • Constructor Detail

      • AbstractUser

        protected AbstractUser()
        Constructs a new AbstractUser.

    • Method Detail

      • getFullName

        public java.lang.String getFullName()
        Description copied from interface: User
        Returns the full name of this user.
        Specified by:
        getFullName in interface User
        Returns:
        the full name of this user.

      • setFullName

        public void setFullName​(java.lang.String fullName)
        Description copied from interface: User
        Set the full name of this user.
        Specified by:
        setFullName in interface User
        Parameters:
        fullName - The new full name

      • getPassword

        public java.lang.String getPassword()
        Description copied from interface: User
        Returns the logon password of this user.
        Specified by:
        getPassword in interface User
        Returns:
        the logon password of this user, optionally prefixed with the identifier of an encoding scheme surrounded by curly braces, such as {md5}xxxxx.

      • setPassword

        public void setPassword​(java.lang.String password)
        Description copied from interface: User
        Set the logon password of this user, optionally prefixed with the identifier of an encoding scheme surrounded by curly braces, such as {md5}xxxxx.
        Specified by:
        setPassword in interface User
        Parameters:
        password - The new logon password

      • getUsername

        public java.lang.String getUsername()
        Description copied from interface: User
        Returns the logon username of this user.
        Specified by:
        getUsername in interface User
        Returns:
        the logon username of this user, which must be unique within the scope of a UserDatabase.

      • setUsername

        public void setUsername​(java.lang.String username)
        Description copied from interface: User
        Set the logon username of this user, which must be unique within the scope of a UserDatabase.
        Specified by:
        setUsername in interface User
        Parameters:
        username - The new logon username

      • getName

        public java.lang.String getName()
        Make the principal name the same as the user name.
        Specified by:
        getName in interface java.security.Principal
        Returns:
        the user name