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:

• Serialized Form

Constructor Summary

Constructors

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()	Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. May cause performance issues, deadlocks and hangs.
final Class<? extends Object>	getClass()	Answers the unique instance of java.lang.Class which represents the class of the receiver.
final void	notify()	Causes one thread which is waiting on the receiver to be made ready to run.
final void	notifyAll()	Causes all threads which are waiting on the receiver to be made ready to run.
final void	wait()	Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
final void	wait(long time)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
final void	wait(long time, int frac)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

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:

• Object.hashCode()

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:

• Object.equals(Object)

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.