- java.lang.Object
-
- com.sun.security.auth.UserPrincipal
-
- All Implemented Interfaces:
Serializable,Principal
public final class UserPrincipal extends Object implements Principal, Serializable
A user principal identified by a username or account name.After successful authentication, a user
Principalcan be associated with a particularSubjectto augment thatSubjectwith an additional identity. Authorization decisions can then be based upon thePrincipals that are associated with aSubject.This class is immutable.
- Since:
- 1.6
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description UserPrincipal(String name)Creates a principal.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object object)Compares this principal to the specified object.StringgetName()Returns the name of this principal.inthashCode()Returns a hash code for this principal.StringtoString()Returns a string representation of this principal.
-
-
-
Constructor Detail
-
UserPrincipal
public UserPrincipal(String name)
Creates a principal.- Parameters:
name- The principal's string name.- Throws:
NullPointerException- If thenameisnull.
-
-
Method Detail
-
equals
public boolean equals(Object object)
Compares this principal to the specified object.
-
hashCode
public int hashCode()
Returns a hash code for this principal.- Specified by:
hashCodein interfacePrincipal- Overrides:
hashCodein classObject- Returns:
- The principal's hash code.
- See Also:
Object.equals(java.lang.Object),System.identityHashCode(java.lang.Object)
-
getName
public String getName()
Returns the name of this principal.
-
-