org.keycloak.models.UserFederationValidatingProviderFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of keycloak-server-spi Show documentation

There is a newer version: 26.0.7

/*
 * Copyright 2016 Red Hat, Inc. and/or its affiliates
 * and other contributors as indicated by the @author tags.
 *
 * 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 org.keycloak.models;

import org.keycloak.mappers.FederationConfigValidationException;

/**
 * TODO: Merge with UserFederationProviderFactory and add "default" method validateConfig with empty body once we move to source level 1.8
 *
 * @author Marek Posolda
 */
public interface UserFederationValidatingProviderFactory extends UserFederationProviderFactory {

    /**
     * Called when instance of mapperModel is created for this factory through admin endpoint
     *
     * @param realm
     * @param providerModel
     * @throws FederationConfigValidationException if configuration provided in mapperModel is not valid
     */
    void validateConfig(RealmModel realm, UserFederationProviderModel providerModel) throws FederationConfigValidationException;
}