org.apache.jackrabbit.oak.plugins.index.WhiteboardIndexEditorProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation

The Adobe Experience Manager SDK

There is a newer version: 2024.11.18751.20241128T090041Z-241100

/*
 * 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;

import org.apache.jackrabbit.oak.api.CommitFailedException;
import org.apache.jackrabbit.oak.spi.commit.Editor;
import org.apache.jackrabbit.oak.spi.state.NodeBuilder;
import org.apache.jackrabbit.oak.spi.state.NodeState;
import org.apache.jackrabbit.oak.spi.whiteboard.AbstractServiceTracker;
import org.jetbrains.annotations.NotNull;

/**
 * Dynamic {@link IndexEditorProvider} based on the available
 * whiteboard services.
 */
public class WhiteboardIndexEditorProvider
        extends AbstractServiceTracker
        implements IndexEditorProvider {

    public WhiteboardIndexEditorProvider() {
        super(IndexEditorProvider.class);
    }

    @Override
    public Editor getIndexEditor(@NotNull String type, @NotNull NodeBuilder builder,
            @NotNull NodeState root, @NotNull IndexUpdateCallback callback)
            throws CommitFailedException {
        IndexEditorProvider composite = CompositeIndexEditorProvider
                .compose(getServices());
        if (composite == null) {
            return null;
        }
        return composite.getIndexEditor(type, builder, root, callback);
    }

}