org.apache.directory.server.core.subtree

Class SubentryInterceptor

java.lang.Object

org.apache.directory.server.core.api.interceptor.BaseInterceptor

org.apache.directory.server.core.subtree.SubentryInterceptor

All Implemented Interfaces:

org.apache.directory.server.core.api.interceptor.Interceptor

public class SubentryInterceptor
extends org.apache.directory.server.core.api.interceptor.BaseInterceptor

The Subentry interceptor service which is responsible for filtering out subentries on search operations and injecting operational attributes

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.directory.api.ldap.model.schema.AttributeType[]	SUBENTRY_OPATTRS The set of Subentry operational attributes

Fields inherited from class org.apache.directory.server.core.api.interceptor.BaseInterceptor

ACCESS_CONTROL_SUBENTRIES_AT, ADMINISTRATIVE_ROLE_AT, COLLECTIVE_ATTRIBUTE_SUBENTRIES_AT, COLLECTIVE_EXCLUSIONS_AT, CREATE_TIMESTAMP_AT, CREATORS_NAME_AT, directoryService, dnFactory, ENTRY_ACI_AT, ENTRY_CSN_AT, ENTRY_DN_AT, ENTRY_UUID_AT, MODIFIERS_NAME_AT, MODIFY_TIMESTAMP_AT, OBJECT_CLASS_AT, PWD_POLICY_STATE_ATTRIBUTE_TYPES, schemaManager, SUBENTRY_ACI_AT, SUBSCHEMA_SUBENTRY_AT, SUBTREE_SPECIFICATION_AT, TRIGGER_EXECUTION_SUBENTRIES_AT, UNIQUE_MEMBER_AT, USER_PASSWORD_AT

Constructor Summary

Constructors

Constructor and Description
SubentryInterceptor() Creates a new instance of SubentryInterceptor

Method Summary

Methods

Modifier and Type	Method and Description
void	add(org.apache.directory.server.core.api.interceptor.context.AddOperationContext addContext)
void	delete(org.apache.directory.server.core.api.interceptor.context.DeleteOperationContext deleteContext)
void	init(org.apache.directory.server.core.api.DirectoryService directoryService) Initialize the Subentry Interceptor
void	modify(org.apache.directory.server.core.api.interceptor.context.ModifyOperationContext modifyContext)
void	move(org.apache.directory.server.core.api.interceptor.context.MoveOperationContext moveContext) The Move operation for a Subentry will deal with different cases : 1) we move a normal entry 2) we move a subentry 3) we move an administrationPoint
void	moveAndRename(org.apache.directory.server.core.api.interceptor.context.MoveAndRenameOperationContext moveAndRenameContext)
void	rename(org.apache.directory.server.core.api.interceptor.context.RenameOperationContext renameContext)
org.apache.directory.server.core.api.filtering.EntryFilteringCursor	search(org.apache.directory.server.core.api.interceptor.context.SearchOperationContext searchContext)

Methods inherited from class org.apache.directory.server.core.api.interceptor.BaseInterceptor

bind, compare, destroy, getName, getNextInterceptor, getPrincipal, getRootDse, hasEntry, lookup, next, next, next, next, next, next, next, next, next, next, next, next, next, unbind

Methods inherited from class java.lang.Object

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

Field Detail

SUBENTRY_OPATTRS

public static org.apache.directory.api.ldap.model.schema.AttributeType[] SUBENTRY_OPATTRS

The set of Subentry operational attributes

Constructor Detail

SubentryInterceptor

public SubentryInterceptor()

Creates a new instance of SubentryInterceptor

Method Detail

init

public void init(org.apache.directory.server.core.api.DirectoryService directoryService)
          throws org.apache.directory.api.ldap.model.exception.LdapException

Initialize the Subentry Interceptor

Specified by:

init in interface org.apache.directory.server.core.api.interceptor.Interceptor

Overrides:

init in class org.apache.directory.server.core.api.interceptor.BaseInterceptor

Parameters:

directoryService - The DirectoryService instance

Throws:

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

add

public void add(org.apache.directory.server.core.api.interceptor.context.AddOperationContext addContext)
         throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

add in interface org.apache.directory.server.core.api.interceptor.Interceptor

Overrides:

add in class org.apache.directory.server.core.api.interceptor.BaseInterceptor

Throws:

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

delete

public void delete(org.apache.directory.server.core.api.interceptor.context.DeleteOperationContext deleteContext)
            throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

delete in interface org.apache.directory.server.core.api.interceptor.Interceptor

Overrides:

delete in class org.apache.directory.server.core.api.interceptor.BaseInterceptor

Throws:

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

modify

public void modify(org.apache.directory.server.core.api.interceptor.context.ModifyOperationContext modifyContext)
            throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

modify in interface org.apache.directory.server.core.api.interceptor.Interceptor

Overrides:

modify in class org.apache.directory.server.core.api.interceptor.BaseInterceptor

Throws:

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

move

public void move(org.apache.directory.server.core.api.interceptor.context.MoveOperationContext moveContext)
          throws org.apache.directory.api.ldap.model.exception.LdapException

The Move operation for a Subentry will deal with different cases : 1) we move a normal entry 2) we move a subentry 3) we move an administrationPoint

Case 1 :
A normal entry (ie, not a subentry or an AP) may be part of some administrative areas. We have to remove the references to the associated areas if the entry gets out of them.
This entry can also be moved to some other administrative area, and it should then be updated to point to the associated subentries.

There is one preliminary condition : If the entry has a descendant which is an Administrative Point, then the move cannot be done.

Case 2 :
The subentry has to be moved under a new AP, otherwise this is an error. Once moved, we have to update all the entries selected by the old subtreeSpecification, removing the references to the subentry from all the selected entry, and update the entries selected by the new subtreeSpecification by adding a reference to the subentry into them.

Case 3 :

Specified by:

move in interface org.apache.directory.server.core.api.interceptor.Interceptor

Overrides:

move in class org.apache.directory.server.core.api.interceptor.BaseInterceptor

Parameters:

next - The next interceptor in the chain

moveContext - The context containing all the needed informations to proceed

Throws:

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

moveAndRename

public void moveAndRename(org.apache.directory.server.core.api.interceptor.context.MoveAndRenameOperationContext moveAndRenameContext)
                   throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

moveAndRename in interface org.apache.directory.server.core.api.interceptor.Interceptor

Overrides:

moveAndRename in class org.apache.directory.server.core.api.interceptor.BaseInterceptor

Throws:

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

rename

public void rename(org.apache.directory.server.core.api.interceptor.context.RenameOperationContext renameContext)
            throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

rename in interface org.apache.directory.server.core.api.interceptor.Interceptor

Overrides:

rename in class org.apache.directory.server.core.api.interceptor.BaseInterceptor

Throws:

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

search

public org.apache.directory.server.core.api.filtering.EntryFilteringCursor search(org.apache.directory.server.core.api.interceptor.context.SearchOperationContext searchContext)
                                                                           throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

search in interface org.apache.directory.server.core.api.interceptor.Interceptor

Overrides:

search in class org.apache.directory.server.core.api.interceptor.BaseInterceptor

Throws:

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