org.apache.directory.server.core.api

Class LdapPrincipal

java.lang.Object

org.apache.directory.server.core.api.LdapPrincipal

All Implemented Interfaces:

java.lang.Cloneable, java.security.Principal

public final class LdapPrincipal
extends java.lang.Object
implements java.security.Principal, java.lang.Cloneable

An alternative X500 user implementation that has access to the distinguished name of the principal as well as the String representation.

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.directory.api.ldap.model.constants.AuthenticationLevel	authenticationLevel the authentication level for this principal
private java.net.SocketAddress	clientAddress
private org.apache.directory.api.ldap.model.name.Dn	dn the normalized distinguished name of the principal
private org.apache.directory.api.ldap.model.schema.SchemaManager	schemaManager The SchemaManager
private static long	serialVersionUID
private java.net.SocketAddress	serverAddress
private byte[][]	userPasswords The userPassword

Constructor Summary

Constructors

Constructor and Description
LdapPrincipal() Creates a principal for the no name anonymous user whose Dn is the empty String.
LdapPrincipal(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager) Creates a principal for the no name anonymous user whose Dn is the empty String.
LdapPrincipal(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager, org.apache.directory.api.ldap.model.name.Dn dn, org.apache.directory.api.ldap.model.constants.AuthenticationLevel authenticationLevel) Creates a new LDAP/X500 principal without any group associations.
LdapPrincipal(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager, org.apache.directory.api.ldap.model.name.Dn dn, org.apache.directory.api.ldap.model.constants.AuthenticationLevel authenticationLevel, byte[] userPassword) Creates a new LDAP/X500 principal without any group associations.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Clone the object.
org.apache.directory.api.ldap.model.constants.AuthenticationLevel	getAuthenticationLevel() Gets the authentication level associated with this LDAP principle.
java.net.SocketAddress	getClientAddress()
org.apache.directory.api.ldap.model.name.Dn	getDn() Gets a cloned copy of the normalized distinguished name of this principal as a Dn.
java.lang.String	getName() Returns the normalized distinguished name of the principal as a String.
org.apache.directory.api.ldap.model.schema.SchemaManager	getSchemaManager()
java.net.SocketAddress	getServerAddress()
byte[][]	getUserPasswords()
void	setClientAddress(java.net.SocketAddress clientAddress)
void	setSchemaManager(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager)
void	setServerAddress(java.net.SocketAddress serverAddress)
void	setUserPassword(byte[]... userPasswords)
java.lang.String	toString() Returns string representation of the normalized distinguished name of this principal.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.security.Principal

equals, hashCode, implies

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

dn

private org.apache.directory.api.ldap.model.name.Dn dn

the normalized distinguished name of the principal

authenticationLevel

private org.apache.directory.api.ldap.model.constants.AuthenticationLevel authenticationLevel

the authentication level for this principal

userPasswords

private byte[][] userPasswords

The userPassword

schemaManager

private org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager

The SchemaManager

clientAddress

private java.net.SocketAddress clientAddress

serverAddress

private java.net.SocketAddress serverAddress

Constructor Detail

LdapPrincipal

public LdapPrincipal(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager,
                     org.apache.directory.api.ldap.model.name.Dn dn,
                     org.apache.directory.api.ldap.model.constants.AuthenticationLevel authenticationLevel)

Creates a new LDAP/X500 principal without any group associations. Keep this package friendly so only code in the package can create a trusted principal.

Parameters:

dn - the normalized distinguished name of the principal

authenticationLevel - the authentication level for this principal

LdapPrincipal

public LdapPrincipal(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager,
                     org.apache.directory.api.ldap.model.name.Dn dn,
                     org.apache.directory.api.ldap.model.constants.AuthenticationLevel authenticationLevel,
                     byte[] userPassword)

Creates a new LDAP/X500 principal without any group associations. Keep this package friendly so only code in the package can create a trusted principal.

Parameters:

dn - the normalized distinguished name of the principal

authenticationLevel - the authentication level for this principal

userPassword - The user password

LdapPrincipal

public LdapPrincipal()

Creates a principal for the no name anonymous user whose Dn is the empty String.

LdapPrincipal

public LdapPrincipal(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager)

Creates a principal for the no name anonymous user whose Dn is the empty String.

Method Detail

getDn

public org.apache.directory.api.ldap.model.name.Dn getDn()

Gets a cloned copy of the normalized distinguished name of this principal as a Dn.

Returns:

the cloned distinguished name of the principal as a Dn

getName

public java.lang.String getName()

Returns the normalized distinguished name of the principal as a String.

Specified by:

getName in interface java.security.Principal

getAuthenticationLevel

public org.apache.directory.api.ldap.model.constants.AuthenticationLevel getAuthenticationLevel()

Gets the authentication level associated with this LDAP principle.

Returns:

the authentication level

getUserPasswords

public byte[][] getUserPasswords()

setUserPassword

public void setUserPassword(byte[]... userPasswords)

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Clone the object. This is done so that we don't store the password in a LdapPrincipal more than necessary.

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

getSchemaManager

public org.apache.directory.api.ldap.model.schema.SchemaManager getSchemaManager()

Returns:

the schemaManager

setSchemaManager

public void setSchemaManager(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager)

Parameters:

schemaManager - the schemaManager to set

getClientAddress

public java.net.SocketAddress getClientAddress()

Returns:

the clientAddress

setClientAddress

public void setClientAddress(java.net.SocketAddress clientAddress)

Parameters:

clientAddress - the clientAddress to set

getServerAddress

public java.net.SocketAddress getServerAddress()

Returns:

the serverAddress

setServerAddress

public void setServerAddress(java.net.SocketAddress serverAddress)

Parameters:

serverAddress - the serverAddress to set

toString

public java.lang.String toString()

Returns string representation of the normalized distinguished name of this principal.

Specified by:

toString in interface java.security.Principal

Overrides:

toString in class java.lang.Object