org.apache.directory.server.core.shared

Class DefaultCoreSession

java.lang.Object

org.apache.directory.server.core.shared.DefaultCoreSession

All Implemented Interfaces:

CoreSession

public class DefaultCoreSession
extends Object
implements CoreSession

The default CoreSession implementation. TODO - has not been completed yet TODO - need to supply controls and other parameters to setup opContexts

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.directory.api.ldap.model.schema.AttributeType	objectClassAT A reference to the ObjectClass AT

Constructor Summary

Constructors

Constructor and Description
DefaultCoreSession(LdapPrincipal principal, DirectoryService directoryService) Creates a new instance of a DefaultCoreSession

Method Summary

Modifier and Type	Method and Description
void	add(org.apache.directory.api.ldap.model.message.AddRequest addRequest) Adds an entry into the DirectoryService associated with this CoreSession.
void	add(org.apache.directory.api.ldap.model.message.AddRequest addRequest, LogChange log) Adds an entry into the DirectoryService associated with this CoreSession.
void	add(org.apache.directory.api.ldap.model.entry.Entry entry) Adds an entry into the DirectoryService associated with this CoreSession.
void	add(org.apache.directory.api.ldap.model.entry.Entry entry, boolean ignoreReferral) Adds an entry into the DirectoryService associated with this CoreSession.
void	add(org.apache.directory.api.ldap.model.entry.Entry entry, boolean ignoreReferral, LogChange log) Adds an entry into the DirectoryService associated with this CoreSession.
void	add(org.apache.directory.api.ldap.model.entry.Entry entry, LogChange log) Adds an entry into the DirectoryService associated with this CoreSession.
boolean	compare(org.apache.directory.api.ldap.model.message.CompareRequest compareRequest) Checks to see if an attribute in an entry contains a value.
boolean	compare(org.apache.directory.api.ldap.model.name.Dn dn, String oid, Object value) Checks to see if an attribute in an entry contains a value.
boolean	compare(org.apache.directory.api.ldap.model.name.Dn dn, String oid, Object value, boolean ignoreReferral) Checks to see if an attribute in an entry contains a value.
void	delete(org.apache.directory.api.ldap.model.message.DeleteRequest deleteRequest) Deletes an entry in the server.
void	delete(org.apache.directory.api.ldap.model.message.DeleteRequest deleteRequest, LogChange log) Deletes an entry in the server.
void	delete(org.apache.directory.api.ldap.model.name.Dn dn) Deletes an entry in the server.
void	delete(org.apache.directory.api.ldap.model.name.Dn dn, boolean ignoreReferral) Deletes an entry in the server.
void	delete(org.apache.directory.api.ldap.model.name.Dn dn, boolean ignoreReferral, LogChange log) Deletes an entry in the server.
void	delete(org.apache.directory.api.ldap.model.name.Dn dn, LogChange log) Deletes an entry in the server.
boolean	exists(org.apache.directory.api.ldap.model.name.Dn dn) Checks to see if an entry exists.
boolean	exists(String dn) Checks to see if an entry exists.
LdapPrincipal	getAnonymousPrincipal() Gets the anonymous LDAP principal used to authenticate.
LdapPrincipal	getAuthenticatedPrincipal() Gets the LDAP principal used to authenticate.
org.apache.directory.api.ldap.model.constants.AuthenticationLevel	getAuthenticationLevel() Gets the authentication level associated with this session.
SocketAddress	getClientAddress() Gets the socket address of the LDAP client or null if there is no LDAP client associated with the session.
Set<org.apache.directory.api.ldap.model.message.Control>	getControls() Gets the controls enabled for this session.
DirectoryService	getDirectoryService() Gets the DirectoryService this session is bound to.
LdapPrincipal	getEffectivePrincipal() Gets the LDAP principal used for the effective identity associated with this session which may not be the same as the authenticated principal.
Set<OperationContext>	getOutstandingOperations() Gets all outstanding operations currently being performed that have yet to be completed.
SocketAddress	getServiceAddress() Gets the socket address of the LDAP server or null if there is no LDAP service associated with the session.
boolean	isAdministrator() TODO - perhaps we should just use a flag that is calculated on creation of this session
boolean	isAnAdministrator() TODO - this method impl does not check to see if the principal is in the administrators group - it only returns true of the principal is the actual admin user.
boolean	isAnonymous() Gets whether or not this user is anonymous.
boolean	isConfidential() Gets whether or not confidentiality is enabled for this session.
boolean	isPwdMustChange()
boolean	isVirtual() Gets whether or not this session is virtual.
org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>	list(org.apache.directory.api.ldap.model.name.Dn dn, org.apache.directory.api.ldap.model.message.AliasDerefMode aliasDerefMode, String... returningAttributes) An optimized search operation using one level search scope which returns all the children of an entry specified by distinguished name.
org.apache.directory.api.ldap.model.entry.Entry	lookup(org.apache.directory.api.ldap.model.name.Dn dn, org.apache.directory.api.ldap.model.message.Control[] controls, String... attrIds) Looks up an entry in the server returning all attributes: both user and operational attributes.
org.apache.directory.api.ldap.model.entry.Entry	lookup(org.apache.directory.api.ldap.model.name.Dn dn, String... attrIds) Looks up an entry in the server returning all attributes: both user and operational attributes.
void	modify(org.apache.directory.api.ldap.model.name.Dn dn, List<org.apache.directory.api.ldap.model.entry.Modification> mods) Modifies an entry within the server by applying a list of modifications to the entry.
void	modify(org.apache.directory.api.ldap.model.name.Dn dn, List<org.apache.directory.api.ldap.model.entry.Modification> mods, boolean ignoreReferral) Modifies an entry within the server by applying a list of modifications to the entry.
void	modify(org.apache.directory.api.ldap.model.name.Dn dn, List<org.apache.directory.api.ldap.model.entry.Modification> mods, boolean ignoreReferral, LogChange log) Modifies an entry within the server by applying a list of modifications to the entry.
void	modify(org.apache.directory.api.ldap.model.name.Dn dn, List<org.apache.directory.api.ldap.model.entry.Modification> mods, LogChange log) Modifies an entry within the server by applying a list of modifications to the entry.
void	modify(org.apache.directory.api.ldap.model.name.Dn dn, org.apache.directory.api.ldap.model.entry.Modification... mods) Modifies an entry within the server by applying a list of modifications to the entry.
void	modify(org.apache.directory.api.ldap.model.message.ModifyRequest modifyRequest)
void	modify(org.apache.directory.api.ldap.model.message.ModifyRequest modifyRequest, LogChange log)
void	move(org.apache.directory.api.ldap.model.name.Dn dn, org.apache.directory.api.ldap.model.name.Dn newParent) Moves an entry or a branch of entries at a specified distinguished name to a position under a new parent.
void	move(org.apache.directory.api.ldap.model.name.Dn dn, org.apache.directory.api.ldap.model.name.Dn newParent, boolean ignoreReferral) Moves an entry or a branch of entries at a specified distinguished name to a position under a new parent.
void	move(org.apache.directory.api.ldap.model.name.Dn dn, org.apache.directory.api.ldap.model.name.Dn newParent, boolean ignoreReferral, LogChange log) Moves an entry or a branch of entries at a specified distinguished name to a position under a new parent.
void	move(org.apache.directory.api.ldap.model.name.Dn dn, org.apache.directory.api.ldap.model.name.Dn newParent, LogChange log) Moves an entry or a branch of entries at a specified distinguished name to a position under a new parent.
void	move(org.apache.directory.api.ldap.model.message.ModifyDnRequest modifyDnRequest) Move an entry by changing its superior.
void	move(org.apache.directory.api.ldap.model.message.ModifyDnRequest modifyDnRequest, LogChange log) Move an entry by changing its superior.
void	moveAndRename(org.apache.directory.api.ldap.model.name.Dn dn, org.apache.directory.api.ldap.model.name.Dn newParent, org.apache.directory.api.ldap.model.name.Rdn newRdn, boolean deleteOldRdn) Moves and renames (the relative distinguished name of) an entry (or a branch if the entry has children) at a specified distinguished name to a position under a new parent.
void	moveAndRename(org.apache.directory.api.ldap.model.name.Dn dn, org.apache.directory.api.ldap.model.name.Dn newParent, org.apache.directory.api.ldap.model.name.Rdn newRdn, boolean deleteOldRdn, boolean ignoreReferral) Moves and renames (the relative distinguished name of) an entry (or a branch if the entry has children) at a specified distinguished name to a position under a new parent.
void	moveAndRename(org.apache.directory.api.ldap.model.name.Dn dn, org.apache.directory.api.ldap.model.name.Dn newParent, org.apache.directory.api.ldap.model.name.Rdn newRdn, boolean deleteOldRdn, boolean ignoreReferral, LogChange log) Moves and renames (the relative distinguished name of) an entry (or a branch if the entry has children) at a specified distinguished name to a position under a new parent.
void	moveAndRename(org.apache.directory.api.ldap.model.name.Dn dn, org.apache.directory.api.ldap.model.name.Dn newSuperiorDn, org.apache.directory.api.ldap.model.name.Rdn newRdn, boolean deleteOldRdn, LogChange log) Moves and renames (the relative distinguished name of) an entry (or a branch if the entry has children) at a specified distinguished name to a position under a new parent.
void	moveAndRename(org.apache.directory.api.ldap.model.message.ModifyDnRequest modifyDnRequest) Move and rename an entry.
void	moveAndRename(org.apache.directory.api.ldap.model.message.ModifyDnRequest modifyDnRequest, LogChange log) Move and rename an entry.
void	rename(org.apache.directory.api.ldap.model.name.Dn dn, org.apache.directory.api.ldap.model.name.Rdn newRdn, boolean deleteOldRdn) Renames an entry by changing it's relative distinguished name.
void	rename(org.apache.directory.api.ldap.model.name.Dn dn, org.apache.directory.api.ldap.model.name.Rdn newRdn, boolean deleteOldRdn, boolean ignoreReferral) Renames an entry by changing it's relative distinguished name.
void	rename(org.apache.directory.api.ldap.model.name.Dn dn, org.apache.directory.api.ldap.model.name.Rdn newRdn, boolean deleteOldRdn, boolean ignoreReferral, LogChange log) Renames an entry by changing it's relative distinguished name.
void	rename(org.apache.directory.api.ldap.model.name.Dn dn, org.apache.directory.api.ldap.model.name.Rdn newRdn, boolean deleteOldRdn, LogChange log) Renames an entry by changing it's relative distinguished name.
void	rename(org.apache.directory.api.ldap.model.message.ModifyDnRequest modifyDnRequest) Rename an entry applying the ModifyDN request
void	rename(org.apache.directory.api.ldap.model.message.ModifyDnRequest modifyDnRequest, LogChange log) Rename an entry applying the ModifyDN request
org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>	search(org.apache.directory.api.ldap.model.name.Dn dn, org.apache.directory.api.ldap.model.message.SearchScope scope, org.apache.directory.api.ldap.model.filter.ExprNode filter, org.apache.directory.api.ldap.model.message.AliasDerefMode aliasDerefMode, String... returningAttributes) Searches the directory using a specified search scope and filter.
org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>	search(org.apache.directory.api.ldap.model.name.Dn dn, String filter) Searches the directory using a specified filter.
org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>	search(org.apache.directory.api.ldap.model.name.Dn dn, String filter, boolean ignoreReferrals) Searches the directory using a specified filter.
org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>	search(org.apache.directory.api.ldap.model.message.SearchRequest searchRequest)
void	setIoSession(org.apache.mina.core.session.IoSession ioSession) Stores the IoSession into the CoreSession.
void	setPwdMustChange(boolean pwdMustChange) Sets if the passwords must be changed.
void	unbind() Unbind from the current LdapSession.
void	unbind(org.apache.directory.api.ldap.model.message.UnbindRequest unbindRequest) Unbind from the current LdapSession.

Methods inherited from class java.lang.Object

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

Field Detail

objectClassAT

protected org.apache.directory.api.ldap.model.schema.AttributeType objectClassAT

A reference to the ObjectClass AT

Constructor Detail

DefaultCoreSession

public DefaultCoreSession(LdapPrincipal principal,
                          DirectoryService directoryService)

Creates a new instance of a DefaultCoreSession

Parameters:

principal - The principal to use to process operation for this session

directoryService - The DirectoryService to which we will send requests

Method Detail

setIoSession

public void setIoSession(org.apache.mina.core.session.IoSession ioSession)

Stores the IoSession into the CoreSession. This is only useful when the server is not embedded.

Parameters:

ioSession - The IoSession for this CoreSession

add

public void add(org.apache.directory.api.ldap.model.entry.Entry entry)
         throws org.apache.directory.api.ldap.model.exception.LdapException

Adds an entry into the DirectoryService associated with this CoreSession.

Specified by:

add in interface CoreSession

Parameters:

entry - the entry to add

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

add

public void add(org.apache.directory.api.ldap.model.entry.Entry entry,
                boolean ignoreReferral)
         throws org.apache.directory.api.ldap.model.exception.LdapException

Adds an entry into the DirectoryService associated with this CoreSession. The flag is used to tell the server to ignore the referrals and manipulate them as if they were normal entries.

Specified by:

add in interface CoreSession

Parameters:

entry - the entry to add

ignoreReferral - a flag to tell the server to ignore referrals

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

add

public void add(org.apache.directory.api.ldap.model.entry.Entry entry,
                LogChange log)
         throws org.apache.directory.api.ldap.model.exception.LdapException

Adds an entry into the DirectoryService associated with this CoreSession.

Specified by:

add in interface CoreSession

Parameters:

entry - the entry to add

log - a flag set if the added entry should be stored in the changeLog

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

add

public void add(org.apache.directory.api.ldap.model.entry.Entry entry,
                boolean ignoreReferral,
                LogChange log)
         throws org.apache.directory.api.ldap.model.exception.LdapException

Adds an entry into the DirectoryService associated with this CoreSession. The flag is used to tell the server to ignore the referrals and manipulate them as if they were normal entries.

Specified by:

add in interface CoreSession

Parameters:

entry - the entry to add

ignoreReferral - a flag to tell the server to ignore referrals

log - a flag set if the added entry should be stored in the changeLog

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

add

public void add(org.apache.directory.api.ldap.model.message.AddRequest addRequest)
         throws org.apache.directory.api.ldap.model.exception.LdapException

Adds an entry into the DirectoryService associated with this CoreSession. The entry is built using the received AddRequest.

Specified by:

add in interface CoreSession

Parameters:

addRequest - the request to execute

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

add

public void add(org.apache.directory.api.ldap.model.message.AddRequest addRequest,
                LogChange log)
         throws org.apache.directory.api.ldap.model.exception.LdapException

Adds an entry into the DirectoryService associated with this CoreSession. The entry is built using the received AddRequest.

Specified by:

add in interface CoreSession

Parameters:

addRequest - the request to execute

log - a flag set if the added entry should be stored in the changeLog

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

compare

public boolean compare(org.apache.directory.api.ldap.model.name.Dn dn,
                       String oid,
                       Object value)
                throws org.apache.directory.api.ldap.model.exception.LdapException

Checks to see if an attribute in an entry contains a value.

Specified by:

compare in interface CoreSession

Parameters:

dn - the distinguished name of the entry to check

oid - the OID of the attribute to check for the value

value - the value to check for

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

compare

public boolean compare(org.apache.directory.api.ldap.model.name.Dn dn,
                       String oid,
                       Object value,
                       boolean ignoreReferral)
                throws org.apache.directory.api.ldap.model.exception.LdapException

Checks to see if an attribute in an entry contains a value. The flag is used to tell the server to ignore the referrals and manipulate them as if they were normal entries.

Specified by:

compare in interface CoreSession

Parameters:

dn - the distinguished name of the entry to check

oid - the OID of the attribute to check for the value

value - the value to check for

ignoreReferral - a flag to tell the server to ignore referrals

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

delete

public void delete(org.apache.directory.api.ldap.model.name.Dn dn)
            throws org.apache.directory.api.ldap.model.exception.LdapException

Deletes an entry in the server.

Specified by:

delete in interface CoreSession

Parameters:

dn - the distinguished name of the entry to delete

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

delete

public void delete(org.apache.directory.api.ldap.model.name.Dn dn,
                   LogChange log)
            throws org.apache.directory.api.ldap.model.exception.LdapException

Deletes an entry in the server.

Specified by:

delete in interface CoreSession

Parameters:

dn - the distinguished name of the entry to delete

log - a flag set if the added entry should be stored in the changeLog

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

delete

public void delete(org.apache.directory.api.ldap.model.name.Dn dn,
                   boolean ignoreReferral)
            throws org.apache.directory.api.ldap.model.exception.LdapException

Deletes an entry in the server. The flag is used to tell the server to ignore the referrals and manipulate them as if they were normal entries.

Specified by:

delete in interface CoreSession

Parameters:

dn - the distinguished name of the entry to delete

ignoreReferral - a flag to tell the server to ignore referrals

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

delete

public void delete(org.apache.directory.api.ldap.model.name.Dn dn,
                   boolean ignoreReferral,
                   LogChange log)
            throws org.apache.directory.api.ldap.model.exception.LdapException

Deletes an entry in the server. The flag is used to tell the server to ignore the referrals and manipulate them as if they were normal entries.

Specified by:

delete in interface CoreSession

Parameters:

dn - the distinguished name of the entry to delete

ignoreReferral - a flag to tell the server to ignore referrals

log - a flag set if the added entry should be stored in the changeLog

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

getAnonymousPrincipal

public LdapPrincipal getAnonymousPrincipal()

Description copied from interface: CoreSession

Gets the anonymous LDAP principal used to authenticate.

Specified by:

getAnonymousPrincipal in interface CoreSession

Returns:

the LdapPrincipal used to authenticate.

getAuthenticatedPrincipal

public LdapPrincipal getAuthenticatedPrincipal()

Description copied from interface: CoreSession

Gets the LDAP principal used to authenticate. This is the identity used to establish this session on authentication.

Specified by:

getAuthenticatedPrincipal in interface CoreSession

Returns:

the LdapPrincipal used to authenticate.

getAuthenticationLevel

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

Description copied from interface: CoreSession

Gets the authentication level associated with this session.

Specified by:

getAuthenticationLevel in interface CoreSession

Returns:

the authentication level associated with the session

getClientAddress

public SocketAddress getClientAddress()

Gets the socket address of the LDAP client or null if there is no LDAP client associated with the session. Some calls to the core can be made by embedding applications or by non-LDAP services using a programmatic (virtual) session. In these cases no client address is available.

Specified by:

getClientAddress in interface CoreSession

Returns:

null if the session is virtual, non-null when the session is associated with a real LDAP client

getControls

public Set<org.apache.directory.api.ldap.model.message.Control> getControls()

Description copied from interface: CoreSession

Gets the controls enabled for this session.

Specified by:

getControls in interface CoreSession

Returns:

the session controls as a Set

getDirectoryService

public DirectoryService getDirectoryService()

Description copied from interface: CoreSession

Gets the DirectoryService this session is bound to.

Specified by:

getDirectoryService in interface CoreSession

Returns:

the DirectoryService associated with this session

getEffectivePrincipal

public LdapPrincipal getEffectivePrincipal()

Description copied from interface: CoreSession

Gets the LDAP principal used for the effective identity associated with this session which may not be the same as the authenticated principal. This principal is often the same as the authenticated principal. Sometimes however, a user authenticating as one principal, may request to have all operations performed in the session as if they were another principal. The SASL mechanism allows setting an authorized principal which is in effect for the duration of the session. In this case all operations are performed as if they are being performed by this principal. This method will then return the authorized principal which will be different from the authenticated principal. Implementations of this interface may have a means to set the authorized principal which may or may not be the same as the authenticated principal. Implementations should default to return the authenticated principal when an authorized principal is not provided.

Specified by:

getEffectivePrincipal in interface CoreSession

Returns:

the LdapPrincipal to use as the effective principal

getOutstandingOperations

public Set<OperationContext> getOutstandingOperations()

Description copied from interface: CoreSession

Gets all outstanding operations currently being performed that have yet to be completed.

Specified by:

getOutstandingOperations in interface CoreSession

Returns:

the set of outstanding operations

getServiceAddress

public SocketAddress getServiceAddress()

Gets the socket address of the LDAP server or null if there is no LDAP service associated with the session. Some calls to the core can be made by embedding applications or by non-LDAP services using a programmatic (virtual) session. In these cases no service address is available.

Specified by:

getServiceAddress in interface CoreSession

Returns:

null if the session is virtual, non-null when the session is associated with a real LDAP service

isConfidential

public boolean isConfidential()

Description copied from interface: CoreSession

Gets whether or not confidentiality is enabled for this session.

Specified by:

isConfidential in interface CoreSession

Returns:

true if confidentiality is enabled, false otherwise

isVirtual

public boolean isVirtual()

Description copied from interface: CoreSession

Gets whether or not this session is virtual. Virtual sessions verses real sessions represent logical sessions established by non-LDAP services or embedding applications which do not expose the LDAP access.

Specified by:

isVirtual in interface CoreSession

Returns:

true if the session is virtual, false otherwise

isAdministrator

public boolean isAdministrator()

TODO - perhaps we should just use a flag that is calculated on creation of this session

Specified by:

isAdministrator in interface CoreSession

Returns:

true if authorized as the administrator, false otherwise

See Also:

CoreSession.isAdministrator()

isAnAdministrator

public boolean isAnAdministrator()

TODO - this method impl does not check to see if the principal is in the administrators group - it only returns true of the principal is the actual admin user. need to make it check groups. TODO - perhaps we should just use a flag that is calculated on creation of this session

Specified by:

isAnAdministrator in interface CoreSession

Returns:

true if authorized as an administrator, false otherwise

See Also:

CoreSession.isAnAdministrator()

list

public org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry> list(org.apache.directory.api.ldap.model.name.Dn dn,
                                                                                                               org.apache.directory.api.ldap.model.message.AliasDerefMode aliasDerefMode,
                                                                                                               String... returningAttributes)
                                                                                                        throws org.apache.directory.api.ldap.model.exception.LdapException

Description copied from interface: CoreSession

An optimized search operation using one level search scope which returns all the children of an entry specified by distinguished name. This is equivalent to a search operation with one level scope using the (objectClass=*) filter.

Specified by:

list in interface CoreSession

Parameters:

dn - the distinguished name of the entry to list the children of

aliasDerefMode - the alias dereferencing mode used

returningAttributes - the attributes to return

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

lookup

public org.apache.directory.api.ldap.model.entry.Entry lookup(org.apache.directory.api.ldap.model.name.Dn dn,
                                                              String... attrIds)
                                                       throws org.apache.directory.api.ldap.model.exception.LdapException

Looks up an entry in the server returning all attributes: both user and operational attributes.

Specified by:

lookup in interface CoreSession

Parameters:

dn - the name of the entry to lookup

attrIds - The list of attributes to return

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

lookup

public org.apache.directory.api.ldap.model.entry.Entry lookup(org.apache.directory.api.ldap.model.name.Dn dn,
                                                              org.apache.directory.api.ldap.model.message.Control[] controls,
                                                              String... attrIds)
                                                       throws org.apache.directory.api.ldap.model.exception.LdapException

Looks up an entry in the server returning all attributes: both user and operational attributes.

Specified by:

lookup in interface CoreSession

Parameters:

dn - the name of the entry to lookup

controls - the Controls to use

attrIds - The list of attributes to return

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

modify

public void modify(org.apache.directory.api.ldap.model.name.Dn dn,
                   org.apache.directory.api.ldap.model.entry.Modification... mods)
            throws org.apache.directory.api.ldap.model.exception.LdapException

Modifies an entry within the server by applying a list of modifications to the entry.

Specified by:

modify in interface CoreSession

Parameters:

dn - the distinguished name of the entry to modify

mods - the list of modifications to apply

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

modify

public void modify(org.apache.directory.api.ldap.model.name.Dn dn,
                   List<org.apache.directory.api.ldap.model.entry.Modification> mods)
            throws org.apache.directory.api.ldap.model.exception.LdapException

Modifies an entry within the server by applying a list of modifications to the entry.

Specified by:

modify in interface CoreSession

Parameters:

dn - the distinguished name of the entry to modify

mods - the list of modifications to apply

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

modify

public void modify(org.apache.directory.api.ldap.model.name.Dn dn,
                   List<org.apache.directory.api.ldap.model.entry.Modification> mods,
                   LogChange log)
            throws org.apache.directory.api.ldap.model.exception.LdapException

Modifies an entry within the server by applying a list of modifications to the entry.

Specified by:

modify in interface CoreSession

Parameters:

dn - the distinguished name of the entry to modify

mods - the list of modifications to apply

log - a flag set if the added entry should be stored in the changeLog

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

modify

public void modify(org.apache.directory.api.ldap.model.name.Dn dn,
                   List<org.apache.directory.api.ldap.model.entry.Modification> mods,
                   boolean ignoreReferral)
            throws org.apache.directory.api.ldap.model.exception.LdapException

Modifies an entry within the server by applying a list of modifications to the entry. The flag is used to tell the server to ignore the referrals and manipulate them as if they were normal entries.

Specified by:

modify in interface CoreSession

Parameters:

dn - the distinguished name of the entry to modify

mods - the list of modifications to apply

ignoreReferral - a flag to tell the server to ignore referrals

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

modify

public void modify(org.apache.directory.api.ldap.model.name.Dn dn,
                   List<org.apache.directory.api.ldap.model.entry.Modification> mods,
                   boolean ignoreReferral,
                   LogChange log)
            throws org.apache.directory.api.ldap.model.exception.LdapException

Modifies an entry within the server by applying a list of modifications to the entry. The flag is used to tell the server to ignore the referrals and manipulate them as if they were normal entries.

Specified by:

modify in interface CoreSession

Parameters:

dn - the distinguished name of the entry to modify

mods - the list of modifications to apply

ignoreReferral - a flag to tell the server to ignore referrals

log - a flag set if the added entry should be stored in the changeLog

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

move

public void move(org.apache.directory.api.ldap.model.name.Dn dn,
                 org.apache.directory.api.ldap.model.name.Dn newParent)
          throws org.apache.directory.api.ldap.model.exception.LdapException

Moves an entry or a branch of entries at a specified distinguished name to a position under a new parent.

Specified by:

move in interface CoreSession

Parameters:

dn - the distinguished name of the entry/branch to move

newParent - the new parent under which the entry/branch is moved

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

move

public void move(org.apache.directory.api.ldap.model.name.Dn dn,
                 org.apache.directory.api.ldap.model.name.Dn newParent,
                 LogChange log)
          throws org.apache.directory.api.ldap.model.exception.LdapException

Moves an entry or a branch of entries at a specified distinguished name to a position under a new parent.

Specified by:

move in interface CoreSession

Parameters:

dn - the distinguished name of the entry/branch to move

newParent - the new parent under which the entry/branch is moved

log - a flag set if the added entry should be stored in the changeLog

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

move

public void move(org.apache.directory.api.ldap.model.name.Dn dn,
                 org.apache.directory.api.ldap.model.name.Dn newParent,
                 boolean ignoreReferral)
          throws Exception

Moves an entry or a branch of entries at a specified distinguished name to a position under a new parent.

Specified by:

move in interface CoreSession

Parameters:

dn - the distinguished name of the entry/branch to move

newParent - the new parent under which the entry/branch is moved

ignoreReferral - a flag to tell the server to ignore referrals

Throws:

Exception

move

public void move(org.apache.directory.api.ldap.model.name.Dn dn,
                 org.apache.directory.api.ldap.model.name.Dn newParent,
                 boolean ignoreReferral,
                 LogChange log)
          throws org.apache.directory.api.ldap.model.exception.LdapException

Moves an entry or a branch of entries at a specified distinguished name to a position under a new parent.

Specified by:

move in interface CoreSession

Parameters:

dn - the distinguished name of the entry/branch to move

newParent - the new parent under which the entry/branch is moved

ignoreReferral - a flag to tell the server to ignore referrals

log - a flag set if the added entry should be stored in the changeLog

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

moveAndRename

public void moveAndRename(org.apache.directory.api.ldap.model.name.Dn dn,
                          org.apache.directory.api.ldap.model.name.Dn newParent,
                          org.apache.directory.api.ldap.model.name.Rdn newRdn,
                          boolean deleteOldRdn)
                   throws org.apache.directory.api.ldap.model.exception.LdapException

Moves and renames (the relative distinguished name of) an entry (or a branch if the entry has children) at a specified distinguished name to a position under a new parent.

Specified by:

moveAndRename in interface CoreSession

Parameters:

dn - the distinguished name of the entry/branch to move

newParent - the new parent under which the entry/branch is moved

newRdn - the new relative distinguished name of the entry at the root of the branch

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

moveAndRename

public void moveAndRename(org.apache.directory.api.ldap.model.name.Dn dn,
                          org.apache.directory.api.ldap.model.name.Dn newSuperiorDn,
                          org.apache.directory.api.ldap.model.name.Rdn newRdn,
                          boolean deleteOldRdn,
                          LogChange log)
                   throws org.apache.directory.api.ldap.model.exception.LdapException

Moves and renames (the relative distinguished name of) an entry (or a branch if the entry has children) at a specified distinguished name to a position under a new parent.

Specified by:

moveAndRename in interface CoreSession

Parameters:

dn - the distinguished name of the entry/branch to move

newSuperiorDn - the new parent under which the entry/branch is moved

newRdn - the new relative distinguished name of the entry at the root of the branch

log - a flag set if the added entry should be stored in the changeLog

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

moveAndRename

public void moveAndRename(org.apache.directory.api.ldap.model.name.Dn dn,
                          org.apache.directory.api.ldap.model.name.Dn newParent,
                          org.apache.directory.api.ldap.model.name.Rdn newRdn,
                          boolean deleteOldRdn,
                          boolean ignoreReferral)
                   throws org.apache.directory.api.ldap.model.exception.LdapException

Moves and renames (the relative distinguished name of) an entry (or a branch if the entry has children) at a specified distinguished name to a position under a new parent.

Specified by:

moveAndRename in interface CoreSession

Parameters:

dn - the distinguished name of the entry/branch to move

newParent - the new parent under which the entry/branch is moved

newRdn - the new relative distinguished name of the entry at the root of the branch

ignoreReferral - a flag to tell the server to ignore referrals

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

moveAndRename

public void moveAndRename(org.apache.directory.api.ldap.model.name.Dn dn,
                          org.apache.directory.api.ldap.model.name.Dn newParent,
                          org.apache.directory.api.ldap.model.name.Rdn newRdn,
                          boolean deleteOldRdn,
                          boolean ignoreReferral,
                          LogChange log)
                   throws org.apache.directory.api.ldap.model.exception.LdapException

Moves and renames (the relative distinguished name of) an entry (or a branch if the entry has children) at a specified distinguished name to a position under a new parent.

Specified by:

moveAndRename in interface CoreSession

Parameters:

dn - the distinguished name of the entry/branch to move

newParent - the new parent under which the entry/branch is moved

newRdn - the new relative distinguished name of the entry at the root of the branch

ignoreReferral - a flag to tell the server to ignore referrals

log - a flag set if the added entry should be stored in the changeLog

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

rename

public void rename(org.apache.directory.api.ldap.model.name.Dn dn,
                   org.apache.directory.api.ldap.model.name.Rdn newRdn,
                   boolean deleteOldRdn)
            throws org.apache.directory.api.ldap.model.exception.LdapException

Renames an entry by changing it's relative distinguished name. This has the side effect of changing the distinguished name of all entries directly or indirectly subordinate to the named entry if it has descendants.

Specified by:

rename in interface CoreSession

Parameters:

dn - the distinguished name of the entry to rename

newRdn - the new relative distinguished name for the entry

deleteOldRdn - whether or not the old value for the relative distinguished name is to be deleted from the entry

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

rename

public void rename(org.apache.directory.api.ldap.model.name.Dn dn,
                   org.apache.directory.api.ldap.model.name.Rdn newRdn,
                   boolean deleteOldRdn,
                   LogChange log)
            throws org.apache.directory.api.ldap.model.exception.LdapException

Renames an entry by changing it's relative distinguished name. This has the side effect of changing the distinguished name of all entries directly or indirectly subordinate to the named entry if it has descendants.

Specified by:

rename in interface CoreSession

Parameters:

dn - the distinguished name of the entry to rename

newRdn - the new relative distinguished name for the entry

deleteOldRdn - whether or not the old value for the relative distinguished name is to be deleted from the entry

log - a flag set if the added entry should be stored in the changeLog

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

rename

public void rename(org.apache.directory.api.ldap.model.name.Dn dn,
                   org.apache.directory.api.ldap.model.name.Rdn newRdn,
                   boolean deleteOldRdn,
                   boolean ignoreReferral)
            throws org.apache.directory.api.ldap.model.exception.LdapException

Renames an entry by changing it's relative distinguished name. This has the side effect of changing the distinguished name of all entries directly or indirectly subordinate to the named entry if it has descendants.

Specified by:

rename in interface CoreSession

Parameters:

dn - the distinguished name of the entry to rename

newRdn - the new relative distinguished name for the entry

deleteOldRdn - whether or not the old value for the relative distinguished name is to be deleted from the entry

ignoreReferral - a flag to tell the server to ignore referrals

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

rename

public void rename(org.apache.directory.api.ldap.model.name.Dn dn,
                   org.apache.directory.api.ldap.model.name.Rdn newRdn,
                   boolean deleteOldRdn,
                   boolean ignoreReferral,
                   LogChange log)
            throws org.apache.directory.api.ldap.model.exception.LdapException

Renames an entry by changing it's relative distinguished name. This has the side effect of changing the distinguished name of all entries directly or indirectly subordinate to the named entry if it has descendants.

Specified by:

rename in interface CoreSession

Parameters:

dn - the distinguished name of the entry to rename

newRdn - the new relative distinguished name for the entry

deleteOldRdn - whether or not the old value for the relative distinguished name is to be deleted from the entry

ignoreReferral - a flag to tell the server to ignore referrals

log - a flag set if the added entry should be stored in the changeLog

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

search

public org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry> search(org.apache.directory.api.ldap.model.name.Dn dn,
                                                                                                                 String filter)
                                                                                                          throws org.apache.directory.api.ldap.model.exception.LdapException

Searches the directory using a specified filter. The scope is defaulting to 'base'. The alias dereferencing default to 'always'. the returned attributes defaults to 'all the user attributes)

Specified by:

search in interface CoreSession

Parameters:

dn - the distinguished name of the entry to list the children of

filter - the search filter

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

search

public org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry> search(org.apache.directory.api.ldap.model.name.Dn dn,
                                                                                                                 String filter,
                                                                                                                 boolean ignoreReferrals)
                                                                                                          throws org.apache.directory.api.ldap.model.exception.LdapException

Searches the directory using a specified filter. The scope is defaulting to 'base'. The alias dereferencing default to 'always'. the returned attributes defaults to 'all the user attributes)

Specified by:

search in interface CoreSession

Parameters:

dn - the distinguished name of the entry to list the children of

filter - the search filter

ignoreReferrals - a flag to tell the server to ignore referrals

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

search

public org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry> search(org.apache.directory.api.ldap.model.name.Dn dn,
                                                                                                                 org.apache.directory.api.ldap.model.message.SearchScope scope,
                                                                                                                 org.apache.directory.api.ldap.model.filter.ExprNode filter,
                                                                                                                 org.apache.directory.api.ldap.model.message.AliasDerefMode aliasDerefMode,
                                                                                                                 String... returningAttributes)
                                                                                                          throws org.apache.directory.api.ldap.model.exception.LdapException

Description copied from interface: CoreSession

Searches the directory using a specified search scope and filter.

Specified by:

search in interface CoreSession

Parameters:

dn - the distinguished name of the entry to list the children of

scope - the search scope to apply

filter - the search filter

aliasDerefMode - the alias dereferencing mode used

returningAttributes - the attributes to return

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

isAnonymous

public boolean isAnonymous()

Description copied from interface: CoreSession

Gets whether or not this user is anonymous.

Specified by:

isAnonymous in interface CoreSession

Returns:

true if the identity is anonymous false otherwise

compare

public boolean compare(org.apache.directory.api.ldap.model.message.CompareRequest compareRequest)
                throws org.apache.directory.api.ldap.model.exception.LdapException

Checks to see if an attribute in an entry contains a value.

Specified by:

compare in interface CoreSession

Parameters:

compareRequest - the received request

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

delete

public void delete(org.apache.directory.api.ldap.model.message.DeleteRequest deleteRequest)
            throws org.apache.directory.api.ldap.model.exception.LdapException

Deletes an entry in the server.

Specified by:

delete in interface CoreSession

Parameters:

deleteRequest - the delete request containing all the informations necessary to delete the entry

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

delete

public void delete(org.apache.directory.api.ldap.model.message.DeleteRequest deleteRequest,
                   LogChange log)
            throws org.apache.directory.api.ldap.model.exception.LdapException

Deletes an entry in the server. The operation can be logged if requested

Specified by:

delete in interface CoreSession

Parameters:

deleteRequest - the delete request containing all the informations necessary to delete the entry

log - Tells if we should log the deletion in the ChangeLog interceptor

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

exists

public boolean exists(String dn)
               throws org.apache.directory.api.ldap.model.exception.LdapException

Checks to see if an entry exists.

Specified by:

exists in interface CoreSession

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

exists

public boolean exists(org.apache.directory.api.ldap.model.name.Dn dn)
               throws org.apache.directory.api.ldap.model.exception.LdapException

Checks to see if an entry exists.

Specified by:

exists in interface CoreSession

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

modify

public void modify(org.apache.directory.api.ldap.model.message.ModifyRequest modifyRequest)
            throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

modify in interface CoreSession

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

modify

public void modify(org.apache.directory.api.ldap.model.message.ModifyRequest modifyRequest,
                   LogChange log)
            throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

modify in interface CoreSession

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

move

public void move(org.apache.directory.api.ldap.model.message.ModifyDnRequest modifyDnRequest)
          throws org.apache.directory.api.ldap.model.exception.LdapException

Move an entry by changing its superior.

Specified by:

move in interface CoreSession

Parameters:

modifyDnRequest - The ModifyDN request

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

move

public void move(org.apache.directory.api.ldap.model.message.ModifyDnRequest modifyDnRequest,
                 LogChange log)
          throws org.apache.directory.api.ldap.model.exception.LdapException

Move an entry by changing its superior.

Specified by:

move in interface CoreSession

Parameters:

modifyDnRequest - The ModifyDN request

log - a flag set if the added entry should be stored in the changeLog

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

moveAndRename

public void moveAndRename(org.apache.directory.api.ldap.model.message.ModifyDnRequest modifyDnRequest)
                   throws org.apache.directory.api.ldap.model.exception.LdapException

Move and rename an entry. We change the Rdn and the superior.

Specified by:

moveAndRename in interface CoreSession

Parameters:

modifyDnRequest - The move and rename request

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

moveAndRename

public void moveAndRename(org.apache.directory.api.ldap.model.message.ModifyDnRequest modifyDnRequest,
                          LogChange log)
                   throws org.apache.directory.api.ldap.model.exception.LdapException

Move and rename an entry. We change the Rdn and the superior.

Specified by:

moveAndRename in interface CoreSession

Parameters:

modifyDnRequest - The move and rename request

log - a flag set if the added entry should be stored in the changeLog

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

rename

public void rename(org.apache.directory.api.ldap.model.message.ModifyDnRequest modifyDnRequest)
            throws org.apache.directory.api.ldap.model.exception.LdapException

Rename an entry applying the ModifyDN request

Specified by:

rename in interface CoreSession

Parameters:

modifyDnRequest - The requested modification

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

rename

public void rename(org.apache.directory.api.ldap.model.message.ModifyDnRequest modifyDnRequest,
                   LogChange log)
            throws org.apache.directory.api.ldap.model.exception.LdapException

Rename an entry applying the ModifyDN request

Specified by:

rename in interface CoreSession

Parameters:

modifyDnRequest - The requested modification

log - a flag set if the added entry should be stored in the changeLog

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

search

public org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry> search(org.apache.directory.api.ldap.model.message.SearchRequest searchRequest)
                                                                                                          throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

search in interface CoreSession

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

unbind

public void unbind()
            throws org.apache.directory.api.ldap.model.exception.LdapException

Unbind from the current LdapSession.

Specified by:

unbind in interface CoreSession

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If the operation failed

unbind

public void unbind(org.apache.directory.api.ldap.model.message.UnbindRequest unbindRequest)
            throws org.apache.directory.api.ldap.model.exception.LdapException

Unbind from the current LdapSession.

Specified by:

unbind in interface CoreSession

Parameters:

unbindRequest - The Unbind requst, potentially containing some controls

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If the operation failed

isPwdMustChange

public boolean isPwdMustChange()

Specified by:

isPwdMustChange in interface CoreSession

Returns:

true if the password must be changed

setPwdMustChange

public void setPwdMustChange(boolean pwdMustChange)

Sets if the passwords must be changed. If set to true then this session is only allowed to perform modify password, bind, unbind, abandon and StartTLS extended operation only as specified in section #8.1.2.2 of the password policy spec

Specified by:

setPwdMustChange in interface CoreSession