LdapPrincipal (Java Authentication and Authorization Service ) - JDK 5 Documentation v6.0, Java 2 SDK 英文文档

Overview

Package

Class

Use

Tree

Index

Help

JAAS

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.sun.security.auth
Class LdapPrincipal

java.lang.Object
  com.sun.security.auth.LdapPrincipal

All Implemented Interfaces:: Serializable, Principal

public final class LdapPrincipal
extends Object
implements Principal, Serializable
extends Object
implements Principal, 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

LdapPrincipal(String name)
          Creates an LDAP principal.

Method Summary

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.

Methods inherited from class java.lang.Object

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

Constructor Summary
`LdapPrincipal(String name)` Creates an LDAP principal.

Method Summary
`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.

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

Constructor Detail

LdapPrincipal

public LdapPrincipal(String name)
              throws InvalidNameException

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.

Method Detail

equals

public boolean equals(Object object)

Compares this principal to the specified object.

Specified by:: equals in interface Principal
Overrides:: equals in class Object

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

hashCode

public int hashCode()

Computes the hash code for this principal.

Specified by:: hashCode in interface Principal
Overrides:: hashCode in class Object

Returns:: The principal's hash code.

getName

public String getName()

Returns the name originally used to create this principal.

Specified by:: getName in interface Principal

Returns:: The principal's string name.

toString

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.

Specified by:: toString in interface Principal
Overrides:: toString in class Object

Returns:: The principal's string name.