APIdia Launch Partner
Top Description Fields Constructors Methods
com.sun.security.auth

public Class NTUserPrincipal

extends Object
implements Principal, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, java.security.Principal
Imports
java.io.IOException, .InvalidObjectException, .ObjectInputStream, java.security.Principal

This class implements the Principal interface and represents a Windows NT user.

Principals such as this NTUserPrincipal may be associated with a particular Subject to augment that Subject with an additional identity. Refer to the Subject class for more information on how to achieve this. Authorization decisions can then be based upon the Principals associated with a Subject.

Since
1.4
See Also
java.security.Principal, javax.security.auth.Subject

Field Summary

Modifier and TypeField and Description
private String
private static final long

Constructor Summary

AccessConstructor and Description
public
NTUserPrincipal(String
the Windows NT username for this user.
name
)

Create an NTUserPrincipal with a Windows NT username.

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if the specified Object is equal to this NTPrincipal.
equals
(Object
Object to be compared for equality with this NTPrincipal.
o
)

Overrides java.lang.Object.equals.

Implements java.security.Principal.equals.

Compares the specified Object with this NTUserPrincipal for equality.

public String

Returns:

the Windows NT username for this NTPrincipal
getName
()

Implements java.security.Principal.getName.

Return the Windows NT username for this NTPrincipal.

public int

Returns:

a hash code for this NTUserPrincipal.
hashCode
()

Overrides java.lang.Object.hashCode.

Implements java.security.Principal.hashCode.

Return a hash code for this NTUserPrincipal.

private void
readObject(ObjectInputStream
the ObjectInputStream from which data is read
stream
)

Restores the state of this object from the stream.

public String

Returns:

a string representation of this NTPrincipal.
toString
()

Overrides java.lang.Object.toString.

Implements java.security.Principal.toString.

Return a string representation of this NTPrincipal.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

nameback to summary
private String name
serialVersionUIDback to summary
private static final long serialVersionUID
Annotations
@Serial

Constructor Detail

NTUserPrincipalback to summary
public NTUserPrincipal(String name)

Create an NTUserPrincipal with a Windows NT username.

Parameters
name:String

the Windows NT username for this user.

Exceptions
NullPointerException:
if the name is null.

Method Detail

equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Implements java.security.Principal.equals.

Compares the specified Object with this NTUserPrincipal for equality. Returns true if the given object is also a NTUserPrincipal and the two NTUserPrincipals have the same name.

Parameters
o:Object

Object to be compared for equality with this NTPrincipal.

Returns:boolean

true if the specified Object is equal to this NTPrincipal.

getNameback to summary
public String getName()

Implements java.security.Principal.getName.

Return the Windows NT username for this NTPrincipal.

Returns:String

the Windows NT username for this NTPrincipal

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Implements java.security.Principal.hashCode.

Return a hash code for this NTUserPrincipal.

Returns:int

a hash code for this NTUserPrincipal.

readObjectback to summary
private void readObject(ObjectInputStream stream) throws IOException, ClassNotFoundException

Restores the state of this object from the stream.

Parameters
stream:ObjectInputStream

the ObjectInputStream from which data is read

Annotations
@Serial
Exceptions
IOException:
if an I/O error occurs
ClassNotFoundException:
if a serialized class cannot be loaded
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Implements java.security.Principal.toString.

Return a string representation of this NTPrincipal.

Returns:String

a string representation of this NTPrincipal.