trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/index/IndexCommitCallback.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.jackrabbit.oak.plugins.index;

/**
 * Implementations of this interface can be notified of progress of
 * commit that would update the index. e.g. {@link AsyncIndexUpdate}
 * notifies {@link IndexUpdate} about how commit progresses, which,
 * in turn notifies registered callbacks (via
 * {@link IndexingContext#registerIndexCommitCallback}).
 */
public interface IndexCommitCallback {
    void commitProgress(IndexProgress indexProgress);

    enum IndexProgress {
        COMMIT_SUCCEDED,
        COMMIT_FAILED,
        ABORT_REQUESTED
    }
}