org.apache.directory.server.core.normalization

Class NormalizationInterceptor

java.lang.Object

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

org.apache.directory.server.core.normalization.NormalizationInterceptor

All Implemented Interfaces:

Interceptor

public class NormalizationInterceptor
extends BaseInterceptor

A name normalization service. This service makes sure all relative and distinguished names are normalized before calls are made against the respective interface methods on DefaultPartitionNexus. The Filters are also normalized. If the Rdn AttributeTypes are not present in the entry for an Add request, they will be added.

Field Summary

Fields

Modifier and Type	Field and Description
private static org.slf4j.Logger	LOG logger used by this class
private FilterNormalizingVisitor	normVisitor a filter node value normalizer and undefined node remover

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
NormalizationInterceptor() Creates a new instance of a NormalizationInterceptor.

Method Summary

Modifier and Type	Method and Description
void	add(AddOperationContext addContext) Filters Partition#add( AddOperationContext ) call.
private void	addRdnAttributesToEntry(org.apache.directory.api.ldap.model.name.Dn dn, org.apache.directory.api.ldap.model.entry.Entry entry) Adds missing Rdn's attributes and values to the entry.
boolean	compare(CompareOperationContext compareContext) Filters DefaultPartitionNexus#compare( CompareOperationContext ) call.
void	delete(DeleteOperationContext deleteContext) Filters Partition#delete( DeleteOperationContext ) call.
void	destroy() The destroy method does nothing
private org.apache.directory.api.ldap.model.filter.ExprNode	handleAndNode(org.apache.directory.api.ldap.model.filter.ExprNode node) Remove the (ObjectClass=*) node from an AndNode, if we have one.
private org.apache.directory.api.ldap.model.filter.ExprNode	handleNotNode(org.apache.directory.api.ldap.model.filter.ExprNode node) Remove the (ObjectClass=*) node from a NotNode, if we have one.
private org.apache.directory.api.ldap.model.filter.ExprNode	handleOrNode(org.apache.directory.api.ldap.model.filter.ExprNode node) Remove the (ObjectClass=*) node from an OrNode, if we have one.
boolean	hasEntry(HasEntryOperationContext hasEntryContext) Filters Partition#hasEntry( HasEntryOperationContext ) call.
void	init(DirectoryService directoryService) Initialize the registries, normalizers.
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.
private org.apache.directory.api.ldap.model.filter.ExprNode	removeObjectClass(org.apache.directory.api.ldap.model.filter.ExprNode node) Remove the (ObjectClass=*) node from the filter, if we have one.
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, getName, getNextInterceptor, getPrincipal, getRootDse, 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

logger used by this class

normVisitor

private FilterNormalizingVisitor normVisitor

a filter node value normalizer and undefined node remover

Constructor Detail

NormalizationInterceptor

public NormalizationInterceptor()

Creates a new instance of a NormalizationInterceptor.

Method Detail

init

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

Initialize the registries, normalizers.

Specified by:

init in interface Interceptor

Overrides:

init in class BaseInterceptor

Throws:

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

destroy

public void destroy()

The destroy method does nothing

Specified by:

destroy in interface Interceptor

Overrides:

destroy in class BaseInterceptor

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

compare

public boolean compare(CompareOperationContext compareContext)
                throws org.apache.directory.api.ldap.model.exception.LdapException

Filters DefaultPartitionNexus#compare( CompareOperationContext ) call.

Specified by:

compare in interface Interceptor

Overrides:

compare 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

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

hasEntry

public boolean hasEntry(HasEntryOperationContext hasEntryContext)
                 throws org.apache.directory.api.ldap.model.exception.LdapException

Filters Partition#hasEntry( HasEntryOperationContext ) call.

Specified by:

hasEntry in interface Interceptor

Overrides:

hasEntry in class BaseInterceptor

Throws:

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

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

handleAndNode

private org.apache.directory.api.ldap.model.filter.ExprNode handleAndNode(org.apache.directory.api.ldap.model.filter.ExprNode node)

Remove the (ObjectClass=*) node from an AndNode, if we have one.

handleNotNode

private org.apache.directory.api.ldap.model.filter.ExprNode handleNotNode(org.apache.directory.api.ldap.model.filter.ExprNode node)

Remove the (ObjectClass=*) node from a NotNode, if we have one.

handleOrNode

private org.apache.directory.api.ldap.model.filter.ExprNode handleOrNode(org.apache.directory.api.ldap.model.filter.ExprNode node)

Remove the (ObjectClass=*) node from an OrNode, if we have one.

removeObjectClass

private org.apache.directory.api.ldap.model.filter.ExprNode removeObjectClass(org.apache.directory.api.ldap.model.filter.ExprNode node)

Remove the (ObjectClass=*) node from the filter, if we have one.

addRdnAttributesToEntry

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

Adds missing Rdn's attributes and values to the entry.

Parameters:

dn - the Dn

entry - the entry

Throws:

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