/*
 * Copyright The Stargate Authors
 *
 * Licensed 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 io.stargate.sgv2.api.common.tenant;

import io.vertx.ext.web.RoutingContext;
import jakarta.ws.rs.core.SecurityContext;
import java.util.Optional;

/** Resolver of the tenant ID, in case multi-tenancy is used. */
@FunctionalInterface
public interface TenantResolver {

  /**
   * Returns a tenant identifier given a {@link RoutingContext} and a {@link SecurityContext}.
   *
   * @param context the routing context
   * @param securityContext the security context
   * @return The tenant identifier. If empty, indicates that the multi-tenancy is disabled.
   */
  Optional<String> resolve(RoutingContext context, SecurityContext securityContext);
}
