001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 *  
010 *    http://www.apache.org/licenses/LICENSE-2.0
011 *  
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License. 
018 *  
019 */
020package org.apache.directory.server.core.api.interceptor.context;
021
022
023import org.apache.directory.server.core.api.changelog.ChangeLogEvent;
024import org.apache.directory.server.core.api.changelog.LogChange;
025
026
027/**
028 * Operations (write based) causing changes extend this interface. 
029 *
030 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
031 */
032public interface ChangeOperationContext extends OperationContext
033{
034    /**
035     * Gets the ChangeLogEvent associated with this operation after the 
036     * operation has been executed.  Returns null if the ChangeLogService has 
037     * not been enabled. 
038     *
039     * @return the ChangeLogEvent associated with this operation, or null
040     */
041    ChangeLogEvent getChangeLogEvent();
042
043
044    /**
045     * Set the flag which tells the server to log the changes into
046     * the changeLog file
047     * 
048     * @param log The flag
049     */
050    void setLogChange( LogChange log );
051
052
053    /**
054     * @return True if the changes are logged into the changeLog
055     */
056    boolean isLogChange();
057}