com.sun.identity.authentication.service

Class UserPrincipal

java.lang.Object

com.sun.identity.authentication.service.UserPrincipal

All Implemented Interfaces:

Serializable, Principal

public class UserPrincipal
extends Object
implements Principal, Serializable

This class represents the abstract notion of a user which can be used to represent any entity, such as an individual, a corporation, and a login id.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UserPrincipal(String name) Creates UserPrincipal object.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Compares the specified Object with this LDAPPrincipal for equality.
String	getName() Return the user name for this UserPrincipal.
int	hashCode() Returns a hash code for this UserPrincipal.
String	toString() Returns a string representation of this UserPrincipal.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.security.Principal

implies

Constructor Detail

UserPrincipal

public UserPrincipal(String name)

Creates UserPrincipal object.

Parameters:

name - representing pricipal for user.

Method Detail

getName

public String getName()

Return the user name for this UserPrincipal.

Specified by:

getName in interface Principal

Returns:

the user name for this UserPrincipal.

toString

public String toString()

Returns a string representation of this UserPrincipal.

Specified by:

toString in interface Principal

Overrides:

toString in class Object

Returns:

a string representation of this UserPrincipal.

equals

public boolean equals(Object o)

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

Specified by:

equals in interface Principal

Overrides:

equals in class Object

Parameters:

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

Returns:

true if the specified Object is equal equal to this UserPrincipal.

hashCode

public int hashCode()

Returns a hash code for this UserPrincipal.

Specified by:

hashCode in interface Principal

Overrides:

hashCode in class Object

Returns:

a hash code for this UserPrincipal.