/*
 * 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.polaris.persistence.nosql.metastore.committers;

import jakarta.annotation.Nonnull;
import org.apache.polaris.persistence.nosql.api.commit.CommitException;
import org.apache.polaris.persistence.nosql.api.commit.CommitterState;
import org.apache.polaris.persistence.nosql.api.index.IndexKey;
import org.apache.polaris.persistence.nosql.api.index.UpdatableIndex;
import org.apache.polaris.persistence.nosql.api.obj.ObjRef;
import org.apache.polaris.persistence.nosql.coretypes.principals.PrincipalsObj;

@FunctionalInterface
public interface PrincipalsChangeCommitter<RESULT> {
  @Nonnull
  ChangeResult<RESULT> change(
      @Nonnull CommitterState<PrincipalsObj, RESULT> state,
      @Nonnull PrincipalsObj.Builder ref,
      @Nonnull UpdatableIndex<ObjRef> byName,
      @Nonnull UpdatableIndex<IndexKey> byId,
      @Nonnull UpdatableIndex<ObjRef> byClientId)
      throws CommitException;
}
