org.apache.directory.server.core.trigger

Class TriggerInterceptor

java.lang.Object

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

org.apache.directory.server.core.trigger.TriggerInterceptor

All Implemented Interfaces:

Interceptor

public class TriggerInterceptor
extends BaseInterceptor

The Trigger Service based on the Trigger Specification.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	enabled whether or not this interceptor is activated
private static java.lang.String	ENTRY_TRIGGER_ATTR the entry trigger attribute string: entryTrigger
private static org.slf4j.Logger	LOG the logger for this class
private StoredProcExecutionManager	manager
private static SubentryUtils	subentryUtils The SubentryUtils instance
private TriggerExecutionAuthorizer	triggerExecutionAuthorizer a Trigger Execution Authorizer
private org.apache.directory.api.ldap.trigger.TriggerSpecificationParser	triggerParser a normalizing Trigger Specification parser
private TriggerSpecCache	triggerSpecCache a triggerSpecCache that responds to add, delete, and modify attempts

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

Method Summary

Modifier and Type	Method and Description
void	add(AddOperationContext addContext) Filters Partition#add( AddOperationContext ) call.
private void	addEntryTriggerSpecs(java.util.List<org.apache.directory.api.ldap.trigger.TriggerSpecification> triggerSpecs, org.apache.directory.api.ldap.model.entry.Entry entry) Adds the set of entryTriggers to a collection of trigger specifications.
private void	addPrescriptiveTriggerSpecs(OperationContext opContext, java.util.List<org.apache.directory.api.ldap.trigger.TriggerSpecification> triggerSpecs, org.apache.directory.api.ldap.model.name.Dn dn, org.apache.directory.api.ldap.model.entry.Entry entry) Adds prescriptiveTrigger TriggerSpecificaitons to a collection of TriggerSpeficaitions by accessing the triggerSpecCache.
void	delete(DeleteOperationContext deleteContext) Filters Partition#delete( DeleteOperationContext ) call.
private java.lang.Object	executeProcedure(OperationContext opContext, java.lang.String procedure, java.lang.Object[] values)
private java.lang.Object	executeTrigger(OperationContext opContext, org.apache.directory.api.ldap.trigger.TriggerSpecification tsec, StoredProcedureParameterInjector injector)
private java.lang.Object	executeTriggers(OperationContext opContext, java.util.List<org.apache.directory.api.ldap.trigger.TriggerSpecification> triggerSpecs, StoredProcedureParameterInjector injector)
java.util.Map<org.apache.directory.api.ldap.trigger.ActionTime,java.util.List<org.apache.directory.api.ldap.trigger.TriggerSpecification>>	getActionTimeMappedTriggerSpecsForOperation(java.util.List<org.apache.directory.api.ldap.trigger.TriggerSpecification> triggerSpecs, org.apache.directory.api.ldap.trigger.LdapOperation ldapOperation) Return a selection of trigger specifications for a certain type of trigger action time.
void	init(DirectoryService directoryService) This method does nothing by default.
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.

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, search, 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 logger for this class

ENTRY_TRIGGER_ATTR

private static final java.lang.String ENTRY_TRIGGER_ATTR

the entry trigger attribute string: entryTrigger

See Also:

Constant Field Values

triggerSpecCache

private TriggerSpecCache triggerSpecCache

a triggerSpecCache that responds to add, delete, and modify attempts

triggerParser

private org.apache.directory.api.ldap.trigger.TriggerSpecificationParser triggerParser

a normalizing Trigger Specification parser

enabled

private boolean enabled

whether or not this interceptor is activated

triggerExecutionAuthorizer

private TriggerExecutionAuthorizer triggerExecutionAuthorizer

a Trigger Execution Authorizer

manager

private StoredProcExecutionManager manager

subentryUtils

private static SubentryUtils subentryUtils

The SubentryUtils instance

Constructor Detail

TriggerInterceptor

public TriggerInterceptor()

Creates a new instance of a TriggerInterceptor.

Method Detail

addPrescriptiveTriggerSpecs

private void addPrescriptiveTriggerSpecs(OperationContext opContext,
                                         java.util.List<org.apache.directory.api.ldap.trigger.TriggerSpecification> triggerSpecs,
                                         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 prescriptiveTrigger TriggerSpecificaitons to a collection of TriggerSpeficaitions by accessing the triggerSpecCache. The trigger specification cache is accessed for each trigger subentry associated with the entry. Note that subentries are handled differently: their parent, the administrative entry is accessed to determine the perscriptiveTriggers effecting the AP and hence the subentry which is considered to be in the same context.

Parameters:

triggerSpecs - the collection of trigger specifications to add to

dn - the normalized distinguished name of the entry

entry - the target entry that is considered as the trigger source

proxy - the partition nexus proxy

Throws:

java.lang.Exception - if there are problems accessing attribute values

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

addEntryTriggerSpecs

private void addEntryTriggerSpecs(java.util.List<org.apache.directory.api.ldap.trigger.TriggerSpecification> triggerSpecs,
                                  org.apache.directory.api.ldap.model.entry.Entry entry)
                           throws org.apache.directory.api.ldap.model.exception.LdapException

Adds the set of entryTriggers to a collection of trigger specifications. The entryTrigger is parsed and tuples are generated on they fly then added to the collection.

Parameters:

triggerSpecs - the collection of trigger specifications to add to

entry - the target entry that is considered as the trigger source

Throws:

java.lang.Exception - if there are problems accessing attribute values

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

getActionTimeMappedTriggerSpecsForOperation

public java.util.Map<org.apache.directory.api.ldap.trigger.ActionTime,java.util.List<org.apache.directory.api.ldap.trigger.TriggerSpecification>> getActionTimeMappedTriggerSpecsForOperation(java.util.List<org.apache.directory.api.ldap.trigger.TriggerSpecification> triggerSpecs,
                                                                                                                                                                                              org.apache.directory.api.ldap.trigger.LdapOperation ldapOperation)

Return a selection of trigger specifications for a certain type of trigger action time.

Parameters:

triggerSpecs - the trigger specifications

ldapOperation - the ldap operation being performed

Returns:

the set of trigger specs for a trigger action

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

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

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

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

executeTriggers

private java.lang.Object executeTriggers(OperationContext opContext,
                                         java.util.List<org.apache.directory.api.ldap.trigger.TriggerSpecification> triggerSpecs,
                                         StoredProcedureParameterInjector injector)
                                  throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

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

executeTrigger

private java.lang.Object executeTrigger(OperationContext opContext,
                                        org.apache.directory.api.ldap.trigger.TriggerSpecification tsec,
                                        StoredProcedureParameterInjector injector)
                                 throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

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

executeProcedure

private java.lang.Object executeProcedure(OperationContext opContext,
                                          java.lang.String procedure,
                                          java.lang.Object[] values)
                                   throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

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