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

import java.util.List;
import org.apache.gravitino.Config;
import org.apache.gravitino.UserGroup;

/**
 * Interface for mapping authenticated groups.
 *
 * <p>Implementations should be thread-safe as they may be shared across multiple authentication
 * requests.
 */
public interface GroupMapper {

  /**
   * Initializes the mapper with server configuration. Called by the factory after instantiation.
   *
   * <p>Custom implementations can override this to read additional configuration properties. The
   * default implementation is a no-op for backward compatibility.
   *
   * @param config the server configuration
   */
  default void initialize(Config config) {}

  /**
   * Maps a list of group strings to a new list of group strings.
   *
   * @param groups the list of group strings to map
   * @return a list of mapped group strings
   */
  List<UserGroup> map(List<Object> groups);
}
