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

import jakarta.annotation.Nonnull;
import jakarta.enterprise.context.ApplicationScoped;

/**
 * Builder factory to generate "realm-scoped" {@link Persistence} instances.
 *
 * <p>{@link RealmPersistenceFactory} instance is available as an {@link ApplicationScoped} bean.
 */
public interface RealmPersistenceFactory {
  /**
   * Return a new builder for per-realm persistence.
   *
   * <p>Builders must only be used once.
   */
  RealmPersistenceBuilder newBuilder();

  interface RealmPersistenceBuilder {
    RealmPersistenceBuilder realmId(@Nonnull String realmId);

    RealmPersistenceBuilder skipDecorators();

    Persistence build();
  }
}
