/*
 * 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 java.util.List;
import java.util.Set;
import java.util.stream.Collectors;
import java.util.stream.Stream;

/**
 * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
 * @version $Revision: 1 $
 */
public interface ProtocolMapperContainerModel {
    /**
     * Returns protocol mappers as a stream.
     * @return Stream of protocol mapper. Never returns {@code null}.
     */
    Stream<ProtocolMapperModel> getProtocolMappersStream();

    ProtocolMapperModel addProtocolMapper(ProtocolMapperModel model);

    void removeProtocolMapper(ProtocolMapperModel mapping);

    void updateProtocolMapper(ProtocolMapperModel mapping);

    ProtocolMapperModel getProtocolMapperById(String id);

    ProtocolMapperModel getProtocolMapperByName(String protocol, String name);

    default List<ProtocolMapperModel> getProtocolMapperByType(String type) {
        return List.of();
    }
}
