sirius.kernel.AutoSetup Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sirius-kernel Show documentation

Provides common core classes and the microkernel powering all Sirius applications

There is a newer version: 12.9.1

/*
 * Made with all the love in the world
 * by scireum in Remshalden, Germany
 *
 * Copyright by scireum GmbH
 * http://www.scireum.de - [email protected]
 */

package sirius.kernel;

import sirius.kernel.di.std.ConfigValue;
import sirius.kernel.di.std.PriorityParts;
import sirius.kernel.di.std.Register;
import sirius.kernel.health.Exceptions;
import sirius.kernel.health.Log;

import java.util.List;

/**
 * Responsible for executing {@link AutoSetupRule auto setup rules} during th system startup.
 * 
 * As most probably we only want to do this in dev / test / staging systems or once for production systems,
 * this facility has to be enabled via the system config in sirius.autoSetup.
 */
@Register(classes = {AutoSetup.class, Startable.class})
public class AutoSetup implements Startable {

    @ConfigValue("sirius.autoSetup")
    private boolean enabled;

    @PriorityParts(AutoSetupRule.class)
    private List rules;

    /**
     * Represents the logger used for everything concerning the system setup
     */
    public static final Log LOG = Log.get("autosetup");

    @Override
    public int getPriority() {
        return 1000;
    }

    @Override
    public void started() {
        if (!isEnabled()) {
            return;
        }

        for (AutoSetupRule rule : rules) {
            LOG.INFO("Executing auto setup rule: %s", rule.getClass().getName());
            try {
                rule.setup();
            } catch (Exception e) {
                Exceptions.handle()
                          .to(LOG)
                          .error(e)
                          .withSystemErrorMessage("Auto seatup rule %s failed: %s (%s)", rule.getClass().getName())
                          .handle();
            }
        }
    }

    /**
     * Determines if the auto setup facility is active.
     *
     * @return true if auto setup is enabled, false otherwise
     */
    public boolean isEnabled() {
        return enabled;
    }
}