com.ibm.security.auth
Class LinuxNumericUserPrincipal

java.lang.Object
  extended by com.ibm.security.auth.LinuxNumericUserPrincipal
All Implemented Interfaces:
java.io.Serializable, java.security.Principal

public class LinuxNumericUserPrincipal
extends java.lang.Object
implements java.security.Principal, java.io.Serializable

This class represents a user's Linux identification number (UID).

Principals such as this LinuxNumericUserPrincipal 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.

This class will be replaced by < UserIDPrincipal in future releases of JAAS.

Author:
D. Kent Soper
See Also:
Principal, Subject, UserIDPrincipal, Serialized Form

Constructor Summary
LinuxNumericUserPrincipal(long name)
          Create a LinuxNumericUserPrincipal using a long representation of the user's identification number (UID).
LinuxNumericUserPrincipal(java.lang.String name)
          Create a LinuxNumericUserPrincipal using a String representation of the user's identification number (UID).
 
Method Summary
 boolean equals(java.lang.Object o)
          Compares the specified Object with this LinuxNumericUserPrincipal for equality.
 java.lang.String getName()
          Return the user identification number (UID) for this LinuxNumericUserPrincipal.
 int hashCode()
          Return a hash code for this LinuxNumericUserPrincipal.
 long longValue()
          Return the user identification number (UID) for this LinuxNumericUserPrincipal as a long.
 java.lang.String toString()
          Return a string representation of this LinuxNumericUserPrincipal.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

LinuxNumericUserPrincipal

public LinuxNumericUserPrincipal(java.lang.String name)
Create a LinuxNumericUserPrincipal using a String representation of the user's identification number (UID).

Parameters:
name - the user identification number (UID) for this user.
Throws:
java.lang.NullPointerException - if the name is null.

LinuxNumericUserPrincipal

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

Parameters:
name - the user identification number (UID) for this user represented as a long.
Method Detail

getName

public java.lang.String getName()
Return the user identification number (UID) for this LinuxNumericUserPrincipal.

Specified by:
getName in interface java.security.Principal
Returns:
the user identification number (UID) for this LinuxNumericUserPrincipal

longValue

public long longValue()
Return the user identification number (UID) for this LinuxNumericUserPrincipal as a long.

Returns:
the user identification number (UID) for this LinuxNumericUserPrincipal as a long.

toString

public java.lang.String toString()
Return a string representation of this LinuxNumericUserPrincipal.

Specified by:
toString in interface java.security.Principal
Overrides:
toString in class java.lang.Object
Returns:
a string representation of this LinuxNumericUserPrincipal.

equals

public boolean equals(java.lang.Object o)
Compares the specified Object with this LinuxNumericUserPrincipal for equality. Returns true if the given object is also a LinuxNumericUserPrincipal and the two LinuxNumericUserPrincipals have the same user identification number (UID).

Specified by:
equals in interface java.security.Principal
Overrides:
equals in class java.lang.Object
Parameters:
o - Object to be compared for equality with this LinuxNumericUserPrincipal.
Returns:
true if the specified Object is equal to this LinuxNumericUserPrincipal.

hashCode

public int hashCode()
Return a hash code for this LinuxNumericUserPrincipal.

Specified by:
hashCode in interface java.security.Principal
Overrides:
hashCode in class java.lang.Object
Returns:
a hash code for this LinuxNumericUserPrincipal.