openam/selfservice/SelfServiceGuiceModule.java

	SelfServiceGuiceModule.java revision e7e4e00fbd2939e8e34c38cd18eebcc413065eea
/*
 * The contents of this file are subject to the terms of the Common Development and
 * Distribution License (the License). You may not use this file except in compliance with the
 * License.
 *
 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
 * specific language governing permission and limitations under the License.
 *
 * When distributing Covered Software, include this CDDL Header Notice in each file and include
 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
 * Header, with the fields enclosed by brackets [] replaced by your own identifying
 * information: "Portions copyright [year] [name of copyright owner]".
 *
 * Copyright 2015 ForgeRock AS.
 */
package org.forgerock.openam.selfservice;

import static org.forgerock.json.resource.Resources.newInternalConnectionFactory;

import com.google.inject.Injector;
import com.google.inject.PrivateModule;
import com.google.inject.Provides;
import com.google.inject.TypeLiteral;
import com.google.inject.name.Named;
import com.iplanet.sso.SSOToken;
import org.forgerock.guice.core.GuiceModule;
import org.forgerock.http.Client;
import org.forgerock.http.HttpApplicationException;
import org.forgerock.http.handler.HttpClientHandler;
import org.forgerock.json.JsonPointer;
import org.forgerock.json.resource.ConnectionFactory;
import org.forgerock.json.resource.ResourcePath;
import org.forgerock.json.resource.Router;
import org.forgerock.openam.rest.ElevatedConnectionFactoryWrapper;
import org.forgerock.openam.selfservice.config.ConsoleConfigExtractor;
import org.forgerock.openam.selfservice.config.ConsoleConfigHandler;
import org.forgerock.openam.selfservice.config.ConsoleConfigHandlerImpl;
import org.forgerock.openam.selfservice.config.ServiceConfigProviderFactory;
import org.forgerock.openam.selfservice.config.ServiceConfigProviderFactoryImpl;
import org.forgerock.openam.selfservice.config.flows.ForgottenPasswordConsoleConfig;
import org.forgerock.openam.selfservice.config.flows.ForgottenPasswordExtractor;
import org.forgerock.openam.selfservice.config.flows.ForgottenUsernameConsoleConfig;
import org.forgerock.openam.selfservice.config.flows.ForgottenUsernameExtractor;
import org.forgerock.openam.selfservice.config.flows.KbaConsoleConfig;
import org.forgerock.openam.selfservice.config.flows.KbaConsoleConfigExtractor;
import org.forgerock.openam.selfservice.config.flows.UserRegistrationConsoleConfig;
import org.forgerock.openam.selfservice.config.flows.UserRegistrationExtractor;
import org.forgerock.selfservice.core.ProcessStore;
import org.forgerock.selfservice.core.ProgressStage;
import org.forgerock.selfservice.core.ProgressStageProvider;
import org.forgerock.selfservice.core.UserUpdateService;
import org.forgerock.selfservice.core.annotations.SelfService;
import org.forgerock.selfservice.core.config.StageConfig;
import org.forgerock.selfservice.core.snapshot.SnapshotTokenHandlerFactory;

import javax.inject.Singleton;
import java.security.PrivilegedAction;

/**
 * Guice module to bind the self service features together.
 *
 * @since 13.0.0
 */
@GuiceModule
public final class SelfServiceGuiceModule extends PrivateModule {

    @Override
    protected void configure() {
        bind(ProcessStore.class).to(ProcessStoreImpl.class);
        bind(ConsoleConfigHandler.class).to(ConsoleConfigHandlerImpl.class);
        bind(SnapshotTokenHandlerFactory.class).to(SnapshotTokenHandlerFactoryImpl.class);
        bind(ServiceConfigProviderFactory.class).to(ServiceConfigProviderFactoryImpl.class);
        bind(SelfServiceFactory.class).to(SelfServiceFactoryImpl.class);
        bind(KbaResource.class);

        bind(new TypeLiteral<ConsoleConfigExtractor<UserRegistrationConsoleConfig>>() {})
                .to(UserRegistrationExtractor.class);
        bind(new TypeLiteral<ConsoleConfigExtractor<ForgottenPasswordConsoleConfig>>() {})
                .to(ForgottenPasswordExtractor.class);
        bind(new TypeLiteral<ConsoleConfigExtractor<ForgottenUsernameConsoleConfig>>() {})
                .to(ForgottenUsernameExtractor.class);
        bind(new TypeLiteral<ConsoleConfigExtractor<KbaConsoleConfig>>() {})
                .to(KbaConsoleConfigExtractor.class);

        try {
            bind(Client.class)
                    .annotatedWith(SelfService.class)
                    .toInstance(new Client(new HttpClientHandler()));
        } catch (HttpApplicationException haE) {
            throw new HttpClientCreationException("Unable to create http client", haE);
        }

        // Registration CREST services
        expose(new TypeLiteral<SelfServiceRequestHandler<UserRegistrationConsoleConfig>>() {});
        expose(new TypeLiteral<SelfServiceRequestHandler<ForgottenPasswordConsoleConfig>>() {});
        expose(new TypeLiteral<SelfServiceRequestHandler<ForgottenUsernameConsoleConfig>>() {});
        expose(UserUpdateService.class);
        expose(KbaResource.class);
        // Exposed to be accessible to custom progress stages
        expose(ConnectionFactory.class).annotatedWith(SelfService.class);
        expose(Client.class).annotatedWith(SelfService.class);
    }

    @Provides
    @Singleton
    SelfServiceRequestHandler<UserRegistrationConsoleConfig> getUserRegistrationService(
            SelfServiceFactory serviceFactory, ConsoleConfigHandler configHandler,
            ConsoleConfigExtractor<UserRegistrationConsoleConfig> configExtractor,
            ServiceConfigProviderFactory configProviderFactory) {

        return new SelfServiceRequestHandler<>(serviceFactory, configHandler, configExtractor, configProviderFactory);
    }

    @Provides
    @Singleton
    SelfServiceRequestHandler<ForgottenPasswordConsoleConfig> getForgottenPasswordService(
            SelfServiceFactory serviceFactory, ConsoleConfigHandler configHandler,
            ConsoleConfigExtractor<ForgottenPasswordConsoleConfig> configExtractor,
            ServiceConfigProviderFactory configProviderFactory) {

        return new SelfServiceRequestHandler<>(serviceFactory, configHandler, configExtractor, configProviderFactory);
    }

    @Provides
    @Singleton
    SelfServiceRequestHandler<ForgottenUsernameConsoleConfig> getForgottenUsernameService(
            SelfServiceFactory serviceFactory, ConsoleConfigHandler configHandler,
            ConsoleConfigExtractor<ForgottenUsernameConsoleConfig> configExtractor,
            ServiceConfigProviderFactory configProviderFactory) {

        return new SelfServiceRequestHandler<>(serviceFactory, configHandler, configExtractor, configProviderFactory);
    }

    @Provides
    @Singleton
    UserUpdateService getUserUpdateService(@SelfService ConnectionFactory connectionFactory) {
        return new UserUpdateService(connectionFactory, ResourcePath.resourcePath("/users"), new JsonPointer("/kbaInfo"));
    }

    @Provides
    @Singleton
    @SelfService
    ConnectionFactory getConnectionFactory(@Named("InternalCrestRouter") Router router,
            PrivilegedAction<SSOToken> ssoTokenPrivilegedAction) {
        ConnectionFactory internalConnectionFactory = newInternalConnectionFactory(router);
        return new ElevatedConnectionFactoryWrapper(internalConnectionFactory, ssoTokenPrivilegedAction);
    }

    @Provides
    @Singleton
    ProgressStageProvider getProgressStageProvider(final Injector injector) {
        return new ProgressStageProvider() {

            @Override
            public ProgressStage<StageConfig> get(Class<? extends ProgressStage<StageConfig>> progressStageClass) {
                return injector.getInstance(progressStageClass);
            }

        };
    }

}