/*
 * Copyright 2022 Haulmont.
 *
 * 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.jmix.core.security;

import org.springframework.security.authentication.AuthenticationManager;

/**
 * Interface is responsible for providing an instance of global {@link AuthenticationManager}. It iterates over all
 * registered {@link AddonAuthenticationManagerSupplier} and returns an AuthenticationManager provided by the supplier
 * with the highest order.
 *
 * @see AddonAuthenticationManagerSupplier
 */
public interface AuthenticationManagerSupplier {

    /**
     * Returns a global AuthenticationManager instance based on information provided by all registered
     * {@link AddonAuthenticationManagerSupplier}
     *
     * @return global authentication manager
     */
    AuthenticationManager getAuthenticationManager();

}
