001/** The contents of this file are subject to the terms of the Common Development and
002* Distribution License (the License). You may not use this file except in compliance with the
003* License.
004*
005* You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
006* specific language governing permission and limitations under the License.
007*
008* When distributing Covered Software, include this CDDL Header Notice in each file and include
009* the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
010* Header, with the fields enclosed by brackets [] replaced by your own identifying
011* information: "Portions copyright [year] [name of copyright owner]".
012*
013* Copyright 2014 ForgeRock AS.
014*/
015
016package org.forgerock.jaspi.modules.openid.resolvers.service;
017
018import java.util.List;
019import java.util.Map;
020
021/**
022 * Interface directing how to configure
023 * ({@link OpenIdResolverServiceConfigurator#configureService(OpenIdResolverService, java.util.List)})
024 * an {@link OpenIdResolverService}.
025 *
026 * Implementing classes must be aware that the configurations are "flat" and enter
027 * this method call unverified and unchecked - thus can contain
028 * invalid combinations of values.
029 */
030public interface OpenIdResolverServiceConfigurator {
031
032    /**
033     * Configures a provided {@link OpenIdResolverService} using the resolver information held
034     * in a {@link List} of {@link Map}.
035     *
036     * @param service to configure
037     * @param resolvers the configuration
038     * @return false if any resolver configuration fails true otherwise
039     */
040    public boolean configureService(final OpenIdResolverService service, final List<Map<String, String>> resolvers);
041
042}