Class HttpPrincipal

  • All Implemented Interfaces:
    Principal

    public class HttpPrincipal
    extends Object
    implements Principal
    Represents a user authenticated by HTTP Basic or Digest authentication.
    • Constructor Detail

      • HttpPrincipal

        public HttpPrincipal​(String username,
                             String realm)
        creates a HttpPrincipal from the given username and realm
        Parameters:
        username - The name of the user within the realm
        realm - The realm.
        Throws:
        NullPointerException - if either username or realm are null
    • Method Detail

      • equals

        public boolean equals​(Object another)
        Compares two HttpPrincipal. Returns true if another is an instance of HttpPrincipal, and its username and realm are equal to this object's username and realm. Returns false otherwise.
        Specified by:
        equals in interface Principal
        Overrides:
        equals in class Object
        Parameters:
        another - the reference object with which to compare.
        Returns:
        true if this object is the same as the obj argument; false otherwise.
        See Also:
        Object.hashCode(), HashMap
      • getName

        public String getName()
        returns the contents of this principal in the form realm:username
        Specified by:
        getName in interface Principal
        Returns:
        the name of this principal.
      • getUsername

        public String getUsername()
        returns the username this object was created with.
      • getRealm

        public String getRealm()
        returns the realm this object was created with.
      • toString

        public String toString()
        returns the same string as getName()
        Specified by:
        toString in interface Principal
        Overrides:
        toString in class Object
        Returns:
        a string representation of the object.