org.apache.directory.server.core.collective

Class CollectiveAttributeInterceptor

java.lang.Object

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

org.apache.directory.server.core.collective.CollectiveAttributeInterceptor

All Implemented Interfaces:

Interceptor

public class CollectiveAttributeInterceptor
extends BaseInterceptor

An interceptor based service dealing with collective attribute management. This service intercepts read operations on entries to inject collective attribute value pairs into the response based on the entires inclusion within collectiveAttributeSpecificAreas and collectiveAttributeInnerAreas.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	CollectiveAttributeInterceptor.CollectiveAttributeFilter the search result filter to use for collective attribute injection

Field Summary

Fields

Modifier and Type	Field and Description
private static org.slf4j.Logger	LOG The LoggerFactory used by this Interceptor
private EntryFilter	searchFilter The CollectiveAttribute search filter

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

directoryService, dnFactory, PWD_POLICY_STATE_ATTRIBUTE_TYPES, schemaManager

Constructor Summary

Constructors

Constructor and Description
CollectiveAttributeInterceptor() Creates a new instance of a CollectiveAttributeInterceptor.

Method Summary

Modifier and Type	Method and Description
void	add(AddOperationContext addContext) Filters Partition#add( AddOperationContext ) call.
private void	addCollectiveAttributes(FilteringOperationContext opContext, org.apache.directory.api.ldap.model.entry.Entry entry) Adds the set of collective attributes requested in the returning attribute list and contained in subentries referenced by the entry.
private void	checkAdd(org.apache.directory.api.ldap.model.name.Dn normName, org.apache.directory.api.ldap.model.entry.Entry entry) Check if we can add an entry.
private void	checkModify(ModifyOperationContext modifyContext) Check that we can modify an entry
private boolean	containsAnyCollectiveAttributes(org.apache.directory.api.ldap.model.entry.Entry entry) Check if the entry contains any collective AttributeType (those starting with 'c-')
private boolean	hasCollectiveAttributes(java.util.List<org.apache.directory.api.ldap.model.entry.Modification> mods) Check that we have a CollectiveAttribute in the modifications.
void	init(DirectoryService directoryService) This method does nothing by default.
org.apache.directory.api.ldap.model.entry.Entry	lookup(LookupOperationContext lookupContext) Filters Partition#lookup( LookupOperationContext ) call.
void	modify(ModifyOperationContext modifyContext) Filters Partition#modify( ModifyOperationContext ) call.
EntryFilteringCursor	search(SearchOperationContext searchContext) Filters Partition#search( SearchOperationContext ) call.

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

bind, compare, delete, destroy, getName, getNextInterceptor, getPrincipal, getRootDse, hasEntry, move, moveAndRename, next, next, next, next, next, next, next, next, next, next, next, next, next, rename, unbind

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

The LoggerFactory used by this Interceptor

searchFilter

private final EntryFilter searchFilter

The CollectiveAttribute search filter

Constructor Detail

CollectiveAttributeInterceptor

public CollectiveAttributeInterceptor()

Creates a new instance of a CollectiveAttributeInterceptor.

Method Detail

init

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

This method does nothing by default.

Specified by:

init in interface Interceptor

Overrides:

init in class BaseInterceptor

Throws:

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

add

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

Filters Partition#add( AddOperationContext ) call.

Specified by:

add in interface Interceptor

Overrides:

add in class BaseInterceptor

Parameters:

addContext - The AddOperationContext instance

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If we had some error while processing the Add operation

lookup

public org.apache.directory.api.ldap.model.entry.Entry lookup(LookupOperationContext lookupContext)
                                                       throws org.apache.directory.api.ldap.model.exception.LdapException

Filters Partition#lookup( LookupOperationContext ) call.

Specified by:

lookup in interface Interceptor

Overrides:

lookup in class BaseInterceptor

Throws:

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

modify

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

Filters Partition#modify( ModifyOperationContext ) call.

Specified by:

modify in interface Interceptor

Overrides:

modify in class BaseInterceptor

Throws:

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

search

public EntryFilteringCursor search(SearchOperationContext searchContext)
                            throws org.apache.directory.api.ldap.model.exception.LdapException

Filters Partition#search( SearchOperationContext ) call.

Specified by:

search in interface Interceptor

Overrides:

search in class BaseInterceptor

Throws:

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

checkAdd

private void checkAdd(org.apache.directory.api.ldap.model.name.Dn normName,
                      org.apache.directory.api.ldap.model.entry.Entry entry)
               throws org.apache.directory.api.ldap.model.exception.LdapException

Check if we can add an entry. There are two cases :

• The entry is a normal entry : it should not contain any 'c-XXX' attributeType
• The entry is a collectiveAttributeSubentry

Throws:

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

checkModify

private void checkModify(ModifyOperationContext modifyContext)
                  throws org.apache.directory.api.ldap.model.exception.LdapException

Check that we can modify an entry

Throws:

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

hasCollectiveAttributes

private boolean hasCollectiveAttributes(java.util.List<org.apache.directory.api.ldap.model.entry.Modification> mods)
                                 throws org.apache.directory.api.ldap.model.exception.LdapException

Check that we have a CollectiveAttribute in the modifications. (CollectiveAttributes are those with a name starting with 'c-').

Throws:

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

containsAnyCollectiveAttributes

private boolean containsAnyCollectiveAttributes(org.apache.directory.api.ldap.model.entry.Entry entry)
                                         throws org.apache.directory.api.ldap.model.exception.LdapException

Check if the entry contains any collective AttributeType (those starting with 'c-')

Throws:

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

addCollectiveAttributes

private void addCollectiveAttributes(FilteringOperationContext opContext,
                                     org.apache.directory.api.ldap.model.entry.Entry entry)
                              throws org.apache.directory.api.ldap.model.exception.LdapException

Adds the set of collective attributes requested in the returning attribute list and contained in subentries referenced by the entry. Excludes collective attributes that are specified to be excluded via the 'collectiveExclusions' attribute in the entry.

Parameters:

opContext - the context of the operation collective attributes are added to

entry - the entry to have the collective attributes injected

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - if there are problems accessing subentries