org.apache.directory.server.core.logger

Class TimerInterceptor

java.lang.Object

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

org.apache.directory.server.core.logger.TimerInterceptor

All Implemented Interfaces:

Interceptor

public class TimerInterceptor
extends BaseInterceptor

An interceptor used to log times to process each operation. The way it works is that it gathers the time to process an operation into a global counter, which is logged every 1000 operations (when using the OPERATION_STATS logger). It's also possible to get the time for each single operation if activating the OPERATION_TIME logger. Thos two loggers must be set to DEBUG.

Field Summary

Fields

Modifier and Type	Field and Description
private static boolean	IS_DEBUG_STATS Speedup for logs
private static boolean	IS_DEBUG_TIME
private static java.util.concurrent.atomic.AtomicInteger	nbAddCalls
private static java.util.concurrent.atomic.AtomicInteger	nbBindCalls
private static java.util.concurrent.atomic.AtomicInteger	nbCompareCalls
private static java.util.concurrent.atomic.AtomicInteger	nbDeleteCalls
private static java.util.concurrent.atomic.AtomicInteger	nbGetRootDseCalls
private static java.util.concurrent.atomic.AtomicInteger	nbHasEntryCalls
private static java.util.concurrent.atomic.AtomicInteger	nbLookupCalls
private static java.util.concurrent.atomic.AtomicInteger	nbModifyCalls
private static java.util.concurrent.atomic.AtomicInteger	nbMoveAndRenameCalls
private static java.util.concurrent.atomic.AtomicInteger	nbMoveCalls
private static java.util.concurrent.atomic.AtomicInteger	nbRenameCalls
private static java.util.concurrent.atomic.AtomicInteger	nbSearchCalls
private static java.util.concurrent.atomic.AtomicInteger	nbUnbindCalls
private static org.slf4j.Logger	OPERATION_STATS A aggregating logger
private static org.slf4j.Logger	OPERATION_TIME An operation logger
private static java.util.concurrent.atomic.AtomicLong	totalAdd Stats for the add operation
private static java.util.concurrent.atomic.AtomicLong	totalBind Stats for the bind operation
private static java.util.concurrent.atomic.AtomicLong	totalCompare Stats for the compare operation
private static java.util.concurrent.atomic.AtomicLong	totalDelete Stats for the delete operation
private static java.util.concurrent.atomic.AtomicLong	totalGetRootDse Stats for the GetRootDse operation
private static java.util.concurrent.atomic.AtomicLong	totalHasEntry Stats for the HasEntry operation
private static java.util.concurrent.atomic.AtomicLong	totalLookup Stats for the lookup operation
private static java.util.concurrent.atomic.AtomicLong	totalModify Stats for the modify operation
private static java.util.concurrent.atomic.AtomicLong	totalMove Stats for the move operation
private static java.util.concurrent.atomic.AtomicLong	totalMoveAndRename Stats for the moveAndRename operation
private static java.util.concurrent.atomic.AtomicLong	totalRename Stats for the rename operation
private static java.util.concurrent.atomic.AtomicLong	totalSearch Stats for the search operation
private static java.util.concurrent.atomic.AtomicLong	totalUnbind Stats for the unbind operation

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
TimerInterceptor(java.lang.String name) Creates a new instance of TimerInterceptor.

Method Summary

Modifier and Type	Method and Description
void	add(AddOperationContext addContext) Filters Partition#add( AddOperationContext ) call.
void	bind(BindOperationContext bindContext) Filters Partition#bind( BindOperationContext ) call.
boolean	compare(CompareOperationContext compareContext) Filters DefaultPartitionNexus#compare( CompareOperationContext ) call.
void	delete(DeleteOperationContext deleteContext) Filters Partition#delete( DeleteOperationContext ) call.
void	destroy() This method does nothing by default.
org.apache.directory.api.ldap.model.entry.Entry	getRootDse(GetRootDseOperationContext getRootDseContext) Filters DefaultPartitionNexus#getRootDse( GetRootDseOperationContext ) call.
boolean	hasEntry(HasEntryOperationContext hasEntryContext) Filters Partition#hasEntry( HasEntryOperationContext ) call.
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.
void	unbind(UnbindOperationContext unbindContext) Filters Partition#unbind( UnbindOperationContext ) call.

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

getName, getNextInterceptor, getPrincipal, next, next, next, next, next, next, next, next, next, next, next, next, next

Methods inherited from class java.lang.Object

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

Field Detail

OPERATION_STATS

private static final org.slf4j.Logger OPERATION_STATS

A aggregating logger

OPERATION_TIME

private static final org.slf4j.Logger OPERATION_TIME

An operation logger

IS_DEBUG_STATS

private static final boolean IS_DEBUG_STATS

Speedup for logs

IS_DEBUG_TIME

private static final boolean IS_DEBUG_TIME

totalAdd

private static java.util.concurrent.atomic.AtomicLong totalAdd

Stats for the add operation

nbAddCalls

private static java.util.concurrent.atomic.AtomicInteger nbAddCalls

totalBind

private static java.util.concurrent.atomic.AtomicLong totalBind

Stats for the bind operation

nbBindCalls

private static java.util.concurrent.atomic.AtomicInteger nbBindCalls

totalCompare

private static java.util.concurrent.atomic.AtomicLong totalCompare

Stats for the compare operation

nbCompareCalls

private static java.util.concurrent.atomic.AtomicInteger nbCompareCalls

totalDelete

private static java.util.concurrent.atomic.AtomicLong totalDelete

Stats for the delete operation

nbDeleteCalls

private static java.util.concurrent.atomic.AtomicInteger nbDeleteCalls

totalGetRootDse

private static java.util.concurrent.atomic.AtomicLong totalGetRootDse

Stats for the GetRootDse operation

nbGetRootDseCalls

private static java.util.concurrent.atomic.AtomicInteger nbGetRootDseCalls

totalHasEntry

private static java.util.concurrent.atomic.AtomicLong totalHasEntry

Stats for the HasEntry operation

nbHasEntryCalls

private static java.util.concurrent.atomic.AtomicInteger nbHasEntryCalls

totalLookup

private static java.util.concurrent.atomic.AtomicLong totalLookup

Stats for the lookup operation

nbLookupCalls

private static java.util.concurrent.atomic.AtomicInteger nbLookupCalls

totalModify

private static java.util.concurrent.atomic.AtomicLong totalModify

Stats for the modify operation

nbModifyCalls

private static java.util.concurrent.atomic.AtomicInteger nbModifyCalls

totalMove

private static java.util.concurrent.atomic.AtomicLong totalMove

Stats for the move operation

nbMoveCalls

private static java.util.concurrent.atomic.AtomicInteger nbMoveCalls

totalMoveAndRename

private static java.util.concurrent.atomic.AtomicLong totalMoveAndRename

Stats for the moveAndRename operation

nbMoveAndRenameCalls

private static java.util.concurrent.atomic.AtomicInteger nbMoveAndRenameCalls

totalRename

private static java.util.concurrent.atomic.AtomicLong totalRename

Stats for the rename operation

nbRenameCalls

private static java.util.concurrent.atomic.AtomicInteger nbRenameCalls

totalSearch

private static java.util.concurrent.atomic.AtomicLong totalSearch

Stats for the search operation

nbSearchCalls

private static java.util.concurrent.atomic.AtomicInteger nbSearchCalls

totalUnbind

private static java.util.concurrent.atomic.AtomicLong totalUnbind

Stats for the unbind operation

nbUnbindCalls

private static java.util.concurrent.atomic.AtomicInteger nbUnbindCalls

Constructor Detail

TimerInterceptor

public TimerInterceptor(java.lang.String name)

Creates a new instance of TimerInterceptor.

Parameters:

name - This interceptor's getName()

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

destroy

public void destroy()

This method does nothing by default.

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

bind

public void bind(BindOperationContext bindContext)
          throws org.apache.directory.api.ldap.model.exception.LdapException

Filters Partition#bind( BindOperationContext ) call.

Specified by:

bind in interface Interceptor

Overrides:

bind in class BaseInterceptor

Throws:

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

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

getRootDse

public org.apache.directory.api.ldap.model.entry.Entry getRootDse(GetRootDseOperationContext getRootDseContext)
                                                           throws org.apache.directory.api.ldap.model.exception.LdapException

Filters DefaultPartitionNexus#getRootDse( GetRootDseOperationContext ) call.

Specified by:

getRootDse in interface Interceptor

Overrides:

getRootDse in class BaseInterceptor

Parameters:

getRootDseContext - The getRoot() operation context

Returns:

The RootDSE entry, if found

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If we can't get back the RootDSE entry

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

unbind

public void unbind(UnbindOperationContext unbindContext)
            throws org.apache.directory.api.ldap.model.exception.LdapException

Filters Partition#unbind( UnbindOperationContext ) call.

Specified by:

unbind in interface Interceptor

Overrides:

unbind in class BaseInterceptor

Throws:

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