public final class

LdapPrincipal

extends Object
implements Serializable Principal
java.lang.Object
   ↳ com.sun.security.auth.LdapPrincipal

Class Overview

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.

Summary

Public Constructors
LdapPrincipal(String name)
Creates an LDAP principal.
Public Methods
boolean equals(Object object)
Compares this principal to the specified object.
String getName()
Returns the name originally used to create this principal.
int hashCode()
Computes the hash code for this principal.
String toString()
Creates a string representation of this principal's name in the format defined by RFC 2253.
[Expand]
Inherited Methods
From class java.lang.Object
From interface java.security.Principal

Public Constructors

public LdapPrincipal (String name)

Creates an LDAP principal.

Parameters
name The principal's string distinguished name.
Throws
InvalidNameException If a syntax violation is detected.
NullPointerException If the name is null.

Public Methods

public boolean equals (Object object)

Compares this principal to the specified object.

Parameters
object The object to compare this principal against.
Returns
  • true if they are equal; false otherwise.

public String getName ()

Returns the name originally used to create this principal.

Returns
  • The principal's string name.

public int hashCode ()

Computes the hash code for this principal.

Returns
  • The principal's hash code.

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

Returns
  • The principal's string name.