trunk/core-api/src/main/java/org/apache/directory/server/core/api/event/DirectoryListener.java

/*
 *   Licensed to the Apache Software Foundation (ASF) under one
 *   or more contributor license agreements.  See the NOTICE file
 *   distributed with this work for additional information
 *   regarding copyright ownership.  The ASF licenses this file
 *   to you under the Apache License, Version 2.0 (the
 *   "License"); you may not use this file except in compliance
 *   with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing,
 *   software distributed under the License is distributed on an
 *   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *   KIND, either express or implied.  See the License for the
 *   specific language governing permissions and limitations
 *   under the License.
 *
 */
package org.apache.directory.server.core.api.event;


import org.apache.directory.server.core.api.interceptor.context.AddOperationContext;
import org.apache.directory.server.core.api.interceptor.context.DeleteOperationContext;
import org.apache.directory.server.core.api.interceptor.context.ModifyOperationContext;
import org.apache.directory.server.core.api.interceptor.context.MoveAndRenameOperationContext;
import org.apache.directory.server.core.api.interceptor.context.MoveOperationContext;
import org.apache.directory.server.core.api.interceptor.context.RenameOperationContext;


/**
 * A listener which is notified of changes to the directory service.
 *
 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
 */
public interface DirectoryListener
{
    /**
     * Called when an entry has been added.
     *
     * @param addContext the add operation context responsible for the change
     */
    void entryAdded( AddOperationContext addContext );


    /**
     * Called when an entry has been deleted.
     *
     * @param deleteContext the delete operation context responsible for the change
     */
    void entryDeleted( DeleteOperationContext deleteContext );


    /**
     * Called when an entry has been modified.
     *
     * @param modifyContext the modify operation context responsible for the change
     */
    void entryModified( ModifyOperationContext modifyContext );


    /**
     * Called when an entry has been renamed.
     *
     * @param renameContext the rename operation context responsible for the change
     */
    void entryRenamed( RenameOperationContext renameContext );


    /**
     * Called when an entry is moved.
     *
     * @param moveContext the move operation context responsible for the change
     */
    void entryMoved( MoveOperationContext moveContext );


    /**
     * Called when an entry is moved and renamed at the same time.
     *
     * @param moveAndRenameContext the move/rename operation context responsible for the change
     */
    void entryMovedAndRenamed( MoveAndRenameOperationContext moveAndRenameContext );
    
    
    /**
     * indicates if this listener needs to be invoked synchronously
     *  
     * @return true if should be invoked synchronously, false otherwise
     */
    boolean isSynchronous();
}