org.apache.jackrabbit.oak.spi.commit.EditorHook 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.spi.commit;

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

import static java.util.Objects.requireNonNull;

/**
 * This commit hook implementation processes changes to be committed
 * using the {@link Editor} instance provided by the {@link EditorProvider}
 * passed to the constructor.
 *
 * @since Oak 0.7
 * @see Commit editors
 */
public class EditorHook implements CommitHook {

    private final EditorProvider provider;

    public EditorHook(@NotNull EditorProvider provider) {
        this.provider = requireNonNull(provider);
    }

    @Override @NotNull
    public NodeState processCommit(
            @NotNull NodeState before, @NotNull NodeState after,
            @NotNull CommitInfo info) throws CommitFailedException {
        requireNonNull(before);
        requireNonNull(after);
        requireNonNull(info);

        NodeBuilder builder = after.builder();
        Editor editor = provider.getRootEditor(before, after, builder, info);
        CommitFailedException exception =
                EditorDiff.process(editor, before, after);
        if (exception == null) {
            return builder.getNodeState();
        } else {
            throw exception;
        }
    }

    @Override
    public String toString() {
        return "EditorHook : (" + provider + ")";
    }
}