com.ibm.security.auth

Class LdapPrincipal

  1. java.lang.Object
  2. extended bycom.ibm.security.auth.LdapPrincipal
All implemented interfaces:
java.io.Serializable, java.security.Principal

  1. public final class LdapPrincipal
  2. extends java.lang.Object
  3. implements java.security.Principal, java.io.Serializable
A principal identified by a distinguished name as specified by RFC 2253.

After successful authentication, a user Principal can be associated with a particular Subject to augment that Subject with an additional identity. Authorization decisions can then be based upon the Principals that are associated with a Subject.

This class is immutable.

Since:
1.6
See Also:
Serialized Form

Constructor Summary

Constructor and Description
LdapPrincipal(java.lang.String name)
Creates an LDAP principal.

Method Summary

Modifier and Type Method and Description
  1. boolean
equals(java.lang.Object object)
Compares this principal to the specified object.
  1. java.lang.String
getName()
Returns the name originally used to create this principal.
  1. int
hashCode()
Computes the hash code for this principal.
  1. java.lang.String
toString()
Creates a string representation of this principal's name in the format defined by RFC 2253.
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LdapPrincipal

  1. public LdapPrincipal(java.lang.String name)
  2. throws javax.naming.InvalidNameException
Creates an LDAP principal.
Parameters:
name - The principal's string distinguished name.
Throws:
javax.naming.InvalidNameException - If a syntax violation is detected.
java.lang.NullPointerException - If the name is null.

Method Detail

equals

  1. public boolean equals(java.lang.Object object)
Compares this principal to the specified object.
Specified by:
equals in interface java.security.Principal
Overrides:
equals in class java.lang.Object
Parameters:
object - The object to compare this principal against.
Returns:
true if they are equal; false otherwise.

hashCode

  1. public int hashCode()
Computes the hash code for this principal.
Specified by:
hashCode in interface java.security.Principal
Overrides:
hashCode in class java.lang.Object
Returns:
The principal's hash code.

getName

  1. public java.lang.String getName( )
Returns the name originally used to create this principal.
Specified by:
getName in interface java.security.Principal
Returns:
The principal's string name.

toString

  1. public java.lang.String toString( )
Creates a string representation of this principal's name in the format defined by RFC 2253. If the name has zero components an empty string is returned.
Specified by:
toString in interface java.security.Principal
Overrides:
toString in class java.lang.Object
Returns:
The principal's string name.