com.ibm.security.auth
Class UsernamePrincipal

java.lang.Object
  |
  +--com.ibm.security.auth.JAASPrincipal
        |
        +--com.ibm.security.auth.UsernamePrincipal

All Implemented Interfaces:

java.security.Principal, java.io.Serializable

public class UsernamePrincipal

extends JAASPrincipal

This class extends the JAASPrincipal class and represents the username provided when logging onto a system or server.

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

Author:

D. Kent Soper, Andrew Gotte

See Also:

Principal, Subject, Serialized Form

Constructor Summary

java.lang.String)">UsernamePrincipal(java.lang.String name)
Create an UsernamePrincipal with a provided username.

Method Summary

boolean	java.lang.Object)">equals(java.lang.Object o) Compares the specified Object with this UsernamePrincipal for equality.
java.lang.String	toString() Return a string representation of this UsernamePrincipal.

Methods inherited from class com.ibm.security.auth.JAASPrincipal

getName, hashCode

Methods inherited from class java.lang.Object

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

Constructor Detail

java.lang.String)">

UsernamePrincipal

public UsernamePrincipal(java.lang.String name)

Create an UsernamePrincipal with a provided username.

Parameters:

name - the provided username for this user.

Throws:

NullPointerException - if the name is null.

java.lang.RuntimeException - if the name has zero length.

Method Detail

toString

public java.lang.String toString()

Return a string representation of this UsernamePrincipal.

Overrides:

toString in class JAASPrincipal

Returns:

a string representation of this UsernamePrincipal.

java.lang.Object)">

equals

public boolean equals(java.lang.Object o)

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

Overrides:

java.lang.Object)">equals in class JAASPrincipal

Parameters:

o - Object to be compared for equality with this UsernamePrincipal.

Returns:

true if the specified Object is equal to this UsernamePrincipal.