public interface CoreSession
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()
Returns true if the effective principal associated with this session is
the administrator.
|
boolean |
isAnAdministrator()
Returns true if the effective principal associated with this session is
the administrator or is within the administrators group.
|
boolean |
isAnonymous()
Gets whether or not this user is anonymous.
|
boolean |
isConfidential()
Gets whether or not confidentiality is enabled for this session.
|
boolean |
isVirtual()
Gets whether or not this session is virtual.
|
EntryFilteringCursor |
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... atIds)
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... atIds)
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 newParent,
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
|
EntryFilteringCursor |
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.
|
EntryFilteringCursor |
search(org.apache.directory.api.ldap.model.name.Dn dn,
String filter)
Searches the directory using a specified filter.
|
EntryFilteringCursor |
search(org.apache.directory.api.ldap.model.name.Dn dn,
String filter,
boolean ignoreReferrals)
Searches the directory using a specified filter.
|
EntryFilteringCursor |
search(org.apache.directory.api.ldap.model.message.SearchRequest searchRequest) |
void |
unbind()
Unbind from the current LdapSession.
|
void |
unbind(org.apache.directory.api.ldap.model.message.UnbindRequest unbindRequest)
Unbind from the current LdapSession.
|
DirectoryService getDirectoryService()
LdapPrincipal getAnonymousPrincipal()
LdapPrincipal getAuthenticatedPrincipal()
LdapPrincipal getEffectivePrincipal()
boolean isConfidential()
boolean isAnonymous()
boolean isAdministrator()
ServerDNConstants.ADMIN_SYSTEM_DN
boolean isAnAdministrator()
ServerDNConstants.ADMIN_SYSTEM_DN
,
ServerDNConstants.ADMINISTRATORS_GROUP_DN
org.apache.directory.api.ldap.model.constants.AuthenticationLevel getAuthenticationLevel()
Set<org.apache.directory.api.ldap.model.message.Control> getControls()
Set<OperationContext> getOutstandingOperations()
boolean isVirtual()
SocketAddress getClientAddress()
SocketAddress getServiceAddress()
void add(org.apache.directory.api.ldap.model.entry.Entry entry) throws org.apache.directory.api.ldap.model.exception.LdapException
entry
- the entry to addException
- on failures to add the entryorg.apache.directory.api.ldap.model.exception.LdapException
void add(org.apache.directory.api.ldap.model.entry.Entry entry, LogChange log) throws org.apache.directory.api.ldap.model.exception.LdapException
entry
- the entry to addlog
- a flag set if the added entry should be stored in the changeLogException
- on failures to add the entryorg.apache.directory.api.ldap.model.exception.LdapException
void add(org.apache.directory.api.ldap.model.entry.Entry entry, boolean ignoreReferral) throws org.apache.directory.api.ldap.model.exception.LdapException
entry
- the entry to addignoreReferral
- a flag to tell the server to ignore referralsException
- on failures to add the entryorg.apache.directory.api.ldap.model.exception.LdapException
void add(org.apache.directory.api.ldap.model.entry.Entry entry, boolean ignoreReferral, LogChange log) throws org.apache.directory.api.ldap.model.exception.LdapException
entry
- the entry to addignoreReferral
- a flag to tell the server to ignore referralslog
- a flag set if the added entry should be stored in the changeLogException
- on failures to add the entryorg.apache.directory.api.ldap.model.exception.LdapException
void add(org.apache.directory.api.ldap.model.message.AddRequest addRequest) throws org.apache.directory.api.ldap.model.exception.LdapException
addRequest
- the request to executeException
- on failures to add the entryorg.apache.directory.api.ldap.model.exception.LdapException
void add(org.apache.directory.api.ldap.model.message.AddRequest addRequest, LogChange log) throws org.apache.directory.api.ldap.model.exception.LdapException
addRequest
- the request to executelog
- a flag set if the added entry should be stored in the changeLogException
- on failures to add the entryorg.apache.directory.api.ldap.model.exception.LdapException
boolean compare(org.apache.directory.api.ldap.model.name.Dn dn, String oid, Object value) throws org.apache.directory.api.ldap.model.exception.LdapException
dn
- the distinguished name of the entry to checkoid
- the OID of the attribute to check for the valuevalue
- the value to check forException
- if there are failures while comparingorg.apache.directory.api.ldap.model.exception.LdapException
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
dn
- the distinguished name of the entry to checkoid
- the OID of the attribute to check for the valuevalue
- the value to check forignoreReferral
- a flag to tell the server to ignore referralsException
- if there are failures while comparingorg.apache.directory.api.ldap.model.exception.LdapException
boolean compare(org.apache.directory.api.ldap.model.message.CompareRequest compareRequest) throws org.apache.directory.api.ldap.model.exception.LdapException
compareRequest
- the received requestException
- if there are failures while comparingorg.apache.directory.api.ldap.model.exception.LdapException
void delete(org.apache.directory.api.ldap.model.name.Dn dn) throws org.apache.directory.api.ldap.model.exception.LdapException
dn
- the distinguished name of the entry to deleteException
- if there are failures while deleting the entryorg.apache.directory.api.ldap.model.exception.LdapException
void delete(org.apache.directory.api.ldap.model.name.Dn dn, LogChange log) throws org.apache.directory.api.ldap.model.exception.LdapException
dn
- the distinguished name of the entry to deletelog
- a flag set if the added entry should be stored in the changeLogException
- if there are failures while deleting the entryorg.apache.directory.api.ldap.model.exception.LdapException
void delete(org.apache.directory.api.ldap.model.message.DeleteRequest deleteRequest) throws org.apache.directory.api.ldap.model.exception.LdapException
deleteRequest
- the delete request containing all the informations
necessary to delete the entryException
- if there are failures while deleting the entryorg.apache.directory.api.ldap.model.exception.LdapException
void delete(org.apache.directory.api.ldap.model.message.DeleteRequest deleteRequest, LogChange log) throws org.apache.directory.api.ldap.model.exception.LdapException
deleteRequest
- the delete request containing all the informations
necessary to delete the entrylog
- Tells if we should log the deletion in the ChangeLog interceptorException
- if there are failures while deleting the entryorg.apache.directory.api.ldap.model.exception.LdapException
void delete(org.apache.directory.api.ldap.model.name.Dn dn, boolean ignoreReferral) throws org.apache.directory.api.ldap.model.exception.LdapException
dn
- the distinguished name of the entry to deleteignoreReferral
- a flag to tell the server to ignore referralsException
- if there are failures while deleting the entryorg.apache.directory.api.ldap.model.exception.LdapException
void delete(org.apache.directory.api.ldap.model.name.Dn dn, boolean ignoreReferral, LogChange log) throws org.apache.directory.api.ldap.model.exception.LdapException
dn
- the distinguished name of the entry to deleteignoreReferral
- a flag to tell the server to ignore referralslog
- a flag set if the added entry should be stored in the changeLogException
- if there are failures while deleting the entryorg.apache.directory.api.ldap.model.exception.LdapException
boolean exists(String dn) throws org.apache.directory.api.ldap.model.exception.LdapException
org.apache.directory.api.ldap.model.exception.LdapException
boolean exists(org.apache.directory.api.ldap.model.name.Dn dn) throws org.apache.directory.api.ldap.model.exception.LdapException
org.apache.directory.api.ldap.model.exception.LdapException
org.apache.directory.api.ldap.model.entry.Entry lookup(org.apache.directory.api.ldap.model.name.Dn dn, String... atIds) throws org.apache.directory.api.ldap.model.exception.LdapException
dn
- the name of the entry to lookupatIds
- The list of attributes to returnException
- if there are failures while looking up the entryorg.apache.directory.api.ldap.model.exception.LdapException
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... atIds) throws org.apache.directory.api.ldap.model.exception.LdapException
dn
- the name of the entry to lookupcontrols
- the Controls to useatIds
- The list of attributes to returnException
- if there are failures while looking up the entryorg.apache.directory.api.ldap.model.exception.LdapException
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
dn
- the distinguished name of the entry to modifymods
- the list of modifications to applyException
- if there are failures while modifying the entryorg.apache.directory.api.ldap.model.exception.LdapException
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
dn
- the distinguished name of the entry to modifymods
- the list of modifications to applyException
- if there are failures while modifying the entryorg.apache.directory.api.ldap.model.exception.LdapException
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
dn
- the distinguished name of the entry to modifymods
- the list of modifications to applylog
- a flag set if the added entry should be stored in the changeLogException
- if there are failures while modifying the entryorg.apache.directory.api.ldap.model.exception.LdapException
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
dn
- the distinguished name of the entry to modifyignoreReferral
- a flag to tell the server to ignore referralsmods
- the list of modifications to applyException
- if there are failures while modifying the entryorg.apache.directory.api.ldap.model.exception.LdapException
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
dn
- the distinguished name of the entry to modifyignoreReferral
- a flag to tell the server to ignore referralsmods
- the list of modifications to applylog
- a flag set if the added entry should be stored in the changeLogException
- if there are failures while modifying the entryorg.apache.directory.api.ldap.model.exception.LdapException
void modify(org.apache.directory.api.ldap.model.message.ModifyRequest modifyRequest) throws org.apache.directory.api.ldap.model.exception.LdapException
org.apache.directory.api.ldap.model.exception.LdapException
void modify(org.apache.directory.api.ldap.model.message.ModifyRequest modifyRequest, LogChange log) throws org.apache.directory.api.ldap.model.exception.LdapException
org.apache.directory.api.ldap.model.exception.LdapException
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
dn
- the distinguished name of the entry/branch to movenewParent
- the new parent under which the entry/branch is movedif
- there are failures while moving the entry/branchorg.apache.directory.api.ldap.model.exception.LdapException
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
dn
- the distinguished name of the entry/branch to movenewParent
- the new parent under which the entry/branch is movedlog
- a flag set if the added entry should be stored in the changeLogif
- there are failures while moving the entry/branchorg.apache.directory.api.ldap.model.exception.LdapException
void move(org.apache.directory.api.ldap.model.name.Dn dn, org.apache.directory.api.ldap.model.name.Dn newParent, boolean ignoreReferral) throws Exception
dn
- the distinguished name of the entry/branch to movenewParent
- the new parent under which the entry/branch is movedignoreReferral
- a flag to tell the server to ignore referralsif
- there are failures while moving the entry/branchException
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
dn
- the distinguished name of the entry/branch to movenewParent
- the new parent under which the entry/branch is movedignoreReferral
- a flag to tell the server to ignore referralslog
- a flag set if the added entry should be stored in the changeLogif
- there are failures while moving the entry/branchorg.apache.directory.api.ldap.model.exception.LdapException
void move(org.apache.directory.api.ldap.model.message.ModifyDnRequest modifyDnRequest) throws org.apache.directory.api.ldap.model.exception.LdapException
modifyDnRequest
- The ModifyDN requestException
- if there are failures while moving the entry/branchorg.apache.directory.api.ldap.model.exception.LdapException
void move(org.apache.directory.api.ldap.model.message.ModifyDnRequest modifyDnRequest, LogChange log) throws org.apache.directory.api.ldap.model.exception.LdapException
modifyDnRequest
- The ModifyDN requestlog
- a flag set if the added entry should be stored in the changeLogException
- if there are failures while moving the entry/branchorg.apache.directory.api.ldap.model.exception.LdapException
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
dn
- the distinguished name of the entry/branch to movenewParent
- the new parent under which the entry/branch is movednewRdn
- the new relative distinguished name of the entry at the
root of the branchif
- there are failures while moving and renaming the entry
or branchorg.apache.directory.api.ldap.model.exception.LdapException
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, LogChange log) throws org.apache.directory.api.ldap.model.exception.LdapException
dn
- the distinguished name of the entry/branch to movenewParent
- the new parent under which the entry/branch is movednewRdn
- the new relative distinguished name of the entry at the
root of the branchlog
- a flag set if the added entry should be stored in the changeLogif
- there are failures while moving and renaming the entry
or branchorg.apache.directory.api.ldap.model.exception.LdapException
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
dn
- the distinguished name of the entry/branch to movenewParent
- the new parent under which the entry/branch is movednewRdn
- the new relative distinguished name of the entry at the
root of the branchignoreReferral
- a flag to tell the server to ignore referralsif
- there are failures while moving and renaming the entry
or branchorg.apache.directory.api.ldap.model.exception.LdapException
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
dn
- the distinguished name of the entry/branch to movenewParent
- the new parent under which the entry/branch is movednewRdn
- the new relative distinguished name of the entry at the
root of the branchignoreReferral
- a flag to tell the server to ignore referralslog
- a flag set if the added entry should be stored in the changeLogif
- there are failures while moving and renaming the entry
or branchorg.apache.directory.api.ldap.model.exception.LdapException
void moveAndRename(org.apache.directory.api.ldap.model.message.ModifyDnRequest modifyDnRequest) throws org.apache.directory.api.ldap.model.exception.LdapException
modifyDnRequest
- The move and rename requestException
- if there are failures while moving and renaming the entry
or branchorg.apache.directory.api.ldap.model.exception.LdapException
void moveAndRename(org.apache.directory.api.ldap.model.message.ModifyDnRequest modifyDnRequest, LogChange log) throws org.apache.directory.api.ldap.model.exception.LdapException
modifyDnRequest
- The move and rename requestlog
- a flag set if the added entry should be stored in the changeLogException
- if there are failures while moving and renaming the entry
or branchorg.apache.directory.api.ldap.model.exception.LdapException
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
dn
- the distinguished name of the entry to renamenewRdn
- the new relative distinguished name for the entrydeleteOldRdn
- whether or not the old value for the relative
distinguished name is to be deleted from the entryException
- if there are failures while renaming the entryorg.apache.directory.api.ldap.model.exception.LdapException
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
dn
- the distinguished name of the entry to renamenewRdn
- the new relative distinguished name for the entrydeleteOldRdn
- whether or not the old value for the relative
distinguished name is to be deleted from the entrylog
- a flag set if the added entry should be stored in the changeLogException
- if there are failures while renaming the entryorg.apache.directory.api.ldap.model.exception.LdapException
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
dn
- the distinguished name of the entry to renamenewRdn
- the new relative distinguished name for the entrydeleteOldRdn
- whether or not the old value for the relative
distinguished name is to be deleted from the entryignoreReferral
- a flag to tell the server to ignore referralsException
- if there are failures while renaming the entryorg.apache.directory.api.ldap.model.exception.LdapException
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
dn
- the distinguished name of the entry to renamenewRdn
- the new relative distinguished name for the entrydeleteOldRdn
- whether or not the old value for the relative
distinguished name is to be deleted from the entryignoreReferral
- a flag to tell the server to ignore referralslog
- a flag set if the added entry should be stored in the changeLogException
- if there are failures while renaming the entryorg.apache.directory.api.ldap.model.exception.LdapException
void rename(org.apache.directory.api.ldap.model.message.ModifyDnRequest modifyDnRequest) throws org.apache.directory.api.ldap.model.exception.LdapException
modifyDnRequest
- The requested modificationException
- if there are failures while renaming the entryorg.apache.directory.api.ldap.model.exception.LdapException
void rename(org.apache.directory.api.ldap.model.message.ModifyDnRequest modifyDnRequest, LogChange log) throws org.apache.directory.api.ldap.model.exception.LdapException
modifyDnRequest
- The requested modificationlog
- a flag set if the added entry should be stored in the changeLogException
- if there are failures while renaming the entryorg.apache.directory.api.ldap.model.exception.LdapException
EntryFilteringCursor 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
(objectClass=*)
filter.dn
- the distinguished name of the entry to list the children ofaliasDerefMode
- the alias dereferencing mode usedreturningAttributes
- the attributes to returnException
- if there are failures while listing childrenorg.apache.directory.api.ldap.model.exception.LdapException
EntryFilteringCursor search(org.apache.directory.api.ldap.model.name.Dn dn, String filter) throws org.apache.directory.api.ldap.model.exception.LdapException
dn
- the distinguished name of the entry to list the children offilter
- the search filterException
- if there are failures while listing childrenorg.apache.directory.api.ldap.model.exception.LdapException
EntryFilteringCursor search(org.apache.directory.api.ldap.model.name.Dn dn, String filter, boolean ignoreReferrals) throws org.apache.directory.api.ldap.model.exception.LdapException
dn
- the distinguished name of the entry to list the children offilter
- the search filterignoreReferrals
- a flag to tell the server to ignore referralsException
- if there are failures while listing childrenorg.apache.directory.api.ldap.model.exception.LdapException
EntryFilteringCursor 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
dn
- the distinguished name of the entry to list the children ofscope
- the search scope to applyfilter
- the search filteraliasDerefMode
- the alias dereferencing mode usedreturningAttributes
- the attributes to returnException
- if there are failures while listing childrenorg.apache.directory.api.ldap.model.exception.LdapException
EntryFilteringCursor search(org.apache.directory.api.ldap.model.message.SearchRequest searchRequest) throws org.apache.directory.api.ldap.model.exception.LdapException
org.apache.directory.api.ldap.model.exception.LdapException
void unbind() throws org.apache.directory.api.ldap.model.exception.LdapException
org.apache.directory.api.ldap.model.exception.LdapException
- If the operation failedvoid unbind(org.apache.directory.api.ldap.model.message.UnbindRequest unbindRequest) throws org.apache.directory.api.ldap.model.exception.LdapException
unbindRequest
- The Unbind requst, potentially containing some controlsorg.apache.directory.api.ldap.model.exception.LdapException
- If the operation failedCopyright © 2003-2014 The Apache Software Foundation. All Rights Reserved.