org.apache.directory.server.core.operational

Class OperationalAttributeInterceptor

java.lang.Object

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

org.apache.directory.server.core.operational.OperationalAttributeInterceptor

All Implemented Interfaces:

Interceptor

public class OperationalAttributeInterceptor
extends BaseInterceptor

An Interceptor that adds or modifies the default attributes of entries. There are six default attributes for now; 'creatorsName', 'createTimestamp', 'modifiersName', 'modifyTimestamp', entryUUID and entryCSN.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	OperationalAttributeInterceptor.OperationalAttributeDenormalizingSearchFilter the search result filter to use for collective attribute injection
private class	OperationalAttributeInterceptor.OperationalAttributeSearchFilter the search result filter to use for the addition of mandatory operational attributes

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.directory.api.ldap.model.name.Dn	adminDn The admin Dn
private EntryFilter	denormalizingSearchFilter The denormalizer filter
private static org.slf4j.Logger	LOG The LoggerFactory used by this Interceptor
private EntryFilter	operationalAttributeSearchFilter The filter that add the mandatory operational attributes
private org.apache.directory.api.ldap.model.name.Dn	subschemaSubentryDn The subschemasubentry Dn

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
OperationalAttributeInterceptor() Creates the operational attribute management service interceptor.

Method Summary

Modifier and Type	Method and Description
void	add(AddOperationContext addContext) Filters Partition#add( AddOperationContext ) call.
private boolean	checkAddOperationalAttribute(boolean isAdmin, org.apache.directory.api.ldap.model.entry.Entry entry, org.apache.directory.api.ldap.model.schema.AttributeType attribute) Check if we have to add an operational attribute, or if the admin has injected one
void	delete(DeleteOperationContext deleteContext) Filters Partition#delete( DeleteOperationContext ) call.
private void	denormalizeEntryOpAttrs(org.apache.directory.api.ldap.model.entry.Entry entry)
private org.apache.directory.api.ldap.model.name.Dn	denormalizeTypes(org.apache.directory.api.ldap.model.name.Dn dn) Does not create a new Dn but alters existing Dn by using the first short name for an attributeType definition.
void	destroy() This method does nothing by default.
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.
void	move(MoveOperationContext moveContext) Filters Partition#move( MoveOperationContext ) call.
void	moveAndRename(MoveAndRenameOperationContext moveAndRenameContext) Filters Partition#moveAndRename( MoveAndRenameOperationContext) call.
void	rename(RenameOperationContext renameContext) Filters Partition#rename( RenameOperationContext ) call.
EntryFilteringCursor	search(SearchOperationContext searchContext) Filters Partition#search( SearchOperationContext ) call.

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

bind, compare, getName, getNextInterceptor, getPrincipal, getRootDse, hasEntry, 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

LOG

private static final org.slf4j.Logger LOG

The LoggerFactory used by this Interceptor

denormalizingSearchFilter

private final EntryFilter denormalizingSearchFilter

The denormalizer filter

operationalAttributeSearchFilter

private final EntryFilter operationalAttributeSearchFilter

The filter that add the mandatory operational attributes

subschemaSubentryDn

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

The subschemasubentry Dn

adminDn

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

The admin Dn

Constructor Detail

OperationalAttributeInterceptor

public OperationalAttributeInterceptor()

Creates the operational attribute management service interceptor.

Method Detail

init

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

Description copied from class: BaseInterceptor

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

destroy

public void destroy()

Description copied from class: BaseInterceptor

This method does nothing by default.

Specified by:

destroy in interface Interceptor

Overrides:

destroy in class BaseInterceptor

checkAddOperationalAttribute

private boolean checkAddOperationalAttribute(boolean isAdmin,
                                             org.apache.directory.api.ldap.model.entry.Entry entry,
                                             org.apache.directory.api.ldap.model.schema.AttributeType attribute)
                                      throws org.apache.directory.api.ldap.model.exception.LdapException

Check if we have to add an operational attribute, or if the admin has injected one

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

move

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

Filters Partition#move( MoveOperationContext ) call.

Specified by:

move in interface Interceptor

Overrides:

move in class BaseInterceptor

Throws:

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

moveAndRename

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

Filters Partition#moveAndRename( MoveAndRenameOperationContext) call.

Specified by:

moveAndRename in interface Interceptor

Overrides:

moveAndRename in class BaseInterceptor

Throws:

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

rename

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

Filters Partition#rename( RenameOperationContext ) call.

Specified by:

rename in interface Interceptor

Overrides:

rename 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

delete

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

Description copied from class: BaseInterceptor

Filters Partition#delete( DeleteOperationContext ) call.

Specified by:

delete in interface Interceptor

Overrides:

delete in class BaseInterceptor

Throws:

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

denormalizeEntryOpAttrs

private void denormalizeEntryOpAttrs(org.apache.directory.api.ldap.model.entry.Entry entry)
                              throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

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

denormalizeTypes

private org.apache.directory.api.ldap.model.name.Dn denormalizeTypes(org.apache.directory.api.ldap.model.name.Dn dn)
                                                              throws org.apache.directory.api.ldap.model.exception.LdapException

Does not create a new Dn but alters existing Dn by using the first short name for an attributeType definition.

Parameters:

dn - the normalized distinguished name

Returns:

the distinuished name denormalized

Throws:

java.lang.Exception - if there are problems denormalizing

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