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

public Class UnixNumericUserPrincipal

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 user's Unix identification number (UID).

Principals such as this UnixNumericUserPrincipal 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
UnixNumericUserPrincipal(String
the user identification number (UID) for this user.
name
)

Create a UnixNumericUserPrincipal using a String representation of the user's identification number (UID).

public
UnixNumericUserPrincipal(long
the user identification number (UID) for this user represented as a long.
name
)

Create a UnixNumericUserPrincipal using a long representation of the user's identification number (UID).

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

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

Overrides java.lang.Object.equals.

Implements java.security.Principal.equals.

Compares the specified Object with this UnixNumericUserPrincipal for equality.

public String

Returns:

the user identification number (UID) for this UnixNumericUserPrincipal
getName
()

Implements java.security.Principal.getName.

Return the user identification number (UID) for this UnixNumericUserPrincipal.

public int

Returns:

a hash code for this UnixNumericUserPrincipal.
hashCode
()

Overrides java.lang.Object.hashCode.

Implements java.security.Principal.hashCode.

Return a hash code for this UnixNumericUserPrincipal.

public long

Returns:

the user identification number (UID) for this UnixNumericUserPrincipal as a long.
longValue
()

Return the user identification number (UID) for this UnixNumericUserPrincipal as a long.

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 UnixNumericUserPrincipal.
toString
()

Overrides java.lang.Object.toString.

Implements java.security.Principal.toString.

Return a string representation of this UnixNumericUserPrincipal.

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

UnixNumericUserPrincipalback to summary
public UnixNumericUserPrincipal(String name)

Create a UnixNumericUserPrincipal using a String representation of the user's identification number (UID).

Parameters
name:String

the user identification number (UID) for this user.

Exceptions
NullPointerException:
if the name is null.
UnixNumericUserPrincipalback to summary
public UnixNumericUserPrincipal(long name)

Create a UnixNumericUserPrincipal using a long representation of the user's identification number (UID).

Parameters
name:long

the user identification number (UID) for this user represented as a long.

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 UnixNumericUserPrincipal for equality. Returns true if the given object is also a UnixNumericUserPrincipal and the two UnixNumericUserPrincipals have the same user identification number (UID).

Parameters
o:Object

Object to be compared for equality with this UnixNumericUserPrincipal.

Returns:boolean

true if the specified Object is equal to this UnixNumericUserPrincipal.

getNameback to summary
public String getName()

Implements java.security.Principal.getName.

Return the user identification number (UID) for this UnixNumericUserPrincipal.

Returns:String

the user identification number (UID) for this UnixNumericUserPrincipal

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Implements java.security.Principal.hashCode.

Return a hash code for this UnixNumericUserPrincipal.

Returns:int

a hash code for this UnixNumericUserPrincipal.

longValueback to summary
public long longValue()

Return the user identification number (UID) for this UnixNumericUserPrincipal as a long.

Returns:long

the user identification number (UID) for this UnixNumericUserPrincipal as a long.

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 UnixNumericUserPrincipal.

Returns:String

a string representation of this UnixNumericUserPrincipal.