com.ibm.security.auth
Class LdapPrincipal
- java.lang.Object
com.ibm.security.auth.LdapPrincipal
All implemented interfaces:
java.io.Serializable, java.security.Principal
- public final class LdapPrincipal
- extends java.lang.Object
- implements java.security.Principal, java.io.Serializable
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
Principal
s that are associated with a Subject
.
This class is immutable.
Since:
1.6
See Also:
Constructor Summary
Constructor and Description |
---|
LdapPrincipal(java.lang.String name)
Creates an LDAP principal.
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
equals(java.lang.Object object)
Compares this principal to the specified object.
|
|
getName()
Returns the name originally used to create this principal.
|
|
hashCode()
Computes the hash code for this principal.
|
|
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(java.lang.String name)
- 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
- 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
- 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
- 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
- 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.