Class UserPrincipal

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 Principal can be associated with a particular Subject to augment that Subject with an additional identity. Authorization decisions can then be based upon the Principals that are associated with a Subject.

This class is immutable.

Since:

1.6

See Also:

Constructor Summary

Constructor	Description
`UserPrincipal(String name)`	Creates a principal.

Method Summary

Modifier and Type	Method	Description
`boolean`	`equals(Object object)`	Compares this principal to the specified object.
`String`	`getName()`	Returns the name of this principal.
`int`	`hashCode()`	Returns a hash code for this principal.
`String`	`toString()`	Returns a string representation of this principal.

Methods declared in class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Modifier and Type	Method	Description
`protected Object`	`clone()`	Creates and returns a copy of this object.
`protected void`	`finalize()`	Deprecated, for removal: This API element is subject to removal in a future version. Finalization is deprecated and subject to removal in a future release.
`final Class<?>`	`getClass()`	Returns the runtime class of this `Object`.
`final void`	`notify()`	Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()`	Wakes up all threads that are waiting on this object's monitor.
`final void`	`wait()`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
`final void`	`wait(long timeoutMillis)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis, int nanos)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

Methods declared in interface Principal

implies

Modifier and Type	Method	Description
`default boolean`	`implies(Subject subject)`	Returns `true` if the specified subject is implied by this `Principal`.

Constructor Details

UserPrincipal

public UserPrincipal(String name)

Creates a principal.

Parameters:: name - The principal's string name.
Throws:: NullPointerException - If the name is null.

Method Details

equals

public boolean equals(Object object)

Compares this principal to the specified object.

Specified by:

equals in interface Principal

Overrides:

equals in class Object

Parameters:

object - The object to compare this principal against.

Returns:

true if they are equal; false otherwise.

See Also:

hashCode

public int hashCode()

Returns a hash code for this principal.

Specified by:

hashCode in interface Principal

Overrides:

hashCode in class Object

Returns:

The principal's hash code.

See Also:

getName

public String getName()

Returns the name of this principal.

Specified by:: getName in interface Principal
Returns:: The principal's name.

toString

public String toString()

Returns a string representation of this principal.

Specified by:: toString in interface Principal
Overrides:: toString in class Object
Returns:: The principal's name.

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.