org.openremote.manager.setup.SetupService Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2016, OpenRemote Inc.
 *
 * See the CONTRIBUTORS.txt file in the distribution for a
 * full listing of individual contributors.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see .
 */
package org.openremote.manager.setup;

import org.openremote.container.persistence.PersistenceService;
import org.openremote.container.security.IdentityService;
import org.openremote.manager.security.ManagerIdentityService;
import org.openremote.model.Container;
import org.openremote.model.ContainerService;
import org.openremote.model.setup.Setup;
import org.openremote.model.setup.SetupTasks;

import java.util.ArrayList;
import java.util.List;
import java.util.ServiceLoader;
import java.util.logging.Logger;

/**
 * Executes setup tasks for a clean installation when the application starts.
 * 
 * This service is disabled when {@link PersistenceService#isCleanInstall} is false.
 * 
 * First, this service will load an implementation of {@link SetupTasks} from the
 * classpath using {@link ServiceLoader}. If multiple providers are found, an error
 * is raised. If a provider is found, its tasks will be used on top of {@link KeycloakCleanSetup}
 * and {@link KeycloakInitSetup} which are auto-loaded if keycloak is enabled.
 */
public class SetupService implements ContainerService {

    private static final Logger LOG = Logger.getLogger(SetupService.class.getName());

    final protected List tasks = new ArrayList<>();

    @Override
    public int getPriority() {
        return IdentityService.PRIORITY + 10;
    }

    @Override
    public void init(Container container) throws Exception {

        boolean isClean = container.getService(PersistenceService.class).isCleanInstall();

        if (!isClean) {
            LOG.info("Setup service disabled, clean install = false");
            return;
        }

        // If keycloak then we need keycloak clean and init tasks
        boolean keycloakEnabled = container.getService(ManagerIdentityService.class).isKeycloakEnabled();
        String setupType = container.getConfig().get(SetupTasks.OR_SETUP_TYPE);

        LOG.info(SetupTasks.OR_SETUP_TYPE + " value: " + setupType);

        if (keycloakEnabled) {
            // Keycloak is not managed by persistence service so need separate clean task
            tasks.add(new KeycloakCleanSetup(container));
            tasks.add(new KeycloakInitSetup(container));
        }

        tasks.addAll(ServiceLoader.load(SetupTasks.class).stream().map(ServiceLoader.Provider::get)
            .flatMap(discoveredSetupTasks -> {
                LOG.info("Found custom SetupTasks provider on classpath: " + discoveredSetupTasks.getClass().getName());
                List tasks = discoveredSetupTasks.createTasks(container, setupType, keycloakEnabled);
                return tasks != null ? tasks.stream() : null;
            }).toList());

        try {
            if (!tasks.isEmpty()) {
                LOG.info("--- EXECUTING INIT TASKS ---");
                for (Setup setup : tasks) {
                    LOG.info("Executing setup task '" + setup.getClass().getName() + "'");
                    setup.onInit();
                }
                LOG.info("--- INIT TASKS COMPLETED SUCCESSFULLY ---");
            }
        } catch (Exception ex) {
            throw new RuntimeException("Error setting up application", ex);
        }
    }

    @Override
    public void start(Container container) {

        try {
            if (!tasks.isEmpty()) {
                LOG.info("--- EXECUTING START TASKS ---");
                for (Setup setup : tasks) {
                    LOG.info("Executing setup task '" + setup.getClass().getName() + "'");
                    setup.onStart();
                }
                LOG.info("--- START TASKS COMPLETED SUCCESSFULLY ---");
            }
        } catch (Exception ex) {
            throw new RuntimeException("Error setting up application", ex);
        }
    }

    @Override
    public void stop(Container container) {
        tasks.clear();
    }

    @SuppressWarnings("unchecked")
    public  S getTaskOfType(Class setupType) {
        for (Setup task : tasks) {
            if (setupType.isAssignableFrom(task.getClass()))
                return (S) task;
        }
        throw new IllegalStateException("No setup task found of type: " + setupType);
    }

    @Override
    public String toString() {
        return getClass().getSimpleName() + "{" +
            '}';
    }
}