001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2015 ForgeRock AS.
015 */
016
017package org.forgerock.openam.selfservice.config;
018
019import org.forgerock.selfservice.core.config.ProcessInstanceConfig;
020import org.forgerock.services.context.Context;
021
022/**
023 * Provides self service config instances based of the passed console configuration instance.
024 *
025 * @param <C>
026 *         the console configuration type
027 *
028 * @supported.all.api
029 * @since 13.0.0
030 */
031public interface ServiceConfigProvider<C extends SelfServiceConsoleConfig> {
032
033
034    /**
035     * Determines whether the specific service is enabled.
036     *
037     * @param config
038     *         the console config
039     *
040     * @return whether the service is enabled
041     */
042    boolean isServiceEnabled(C config);
043
044    /**
045     * Provides the self service config for the appropriate flow.
046     *
047     * @param config
048     *         the console config
049     * @param context
050     *         CREST context
051     * @param realm
052     *         the current realm
053     *
054     * @return service config
055     */
056    ProcessInstanceConfig getServiceConfig(C config, Context context, String realm);
057
058}