Examples with GuiceSetup com.peterphi.std.guice.apploader.GuiceSetup used on opensource projects

Example 1 with GuiceSetup

use of com.peterphi.std.guice.apploader.GuiceSetup in project stdlib by petergeneric.

the class GuiceFactory method build.

/**
 * Build a guice environment; this is achieved in the following stages:
 * <ol>
 * <li>Load GuiceRole implementations using {@link ServiceLoader} Service Provider Interface</li>
 * <li>Allow all GuiceRole instances to add/remove/change base configuration</li>
 * <li>Load configuration file resources (e.g. environment.properties)</li>
 * <li>Load network configuration (if enabled)</li>
 * <li>Add special GuiceRole for network configuration auto-reload (if network configuration enabled)</li>
 * <li>Load the override configuration file (if present)</li>
 * <li>Set up the classpath scanner (using property {@link GuiceProperties#SCAN_PACKAGES})</li>
 * <li>Instantiate the {@link GuiceSetup} class specified in {@link GuiceProperties#SETUP_PROPERTY}</li>
 * <li>Hand over the GuiceSetup, Roles, Configuration and Classpath Scanner to {@link #createInjector(GuiceRegistry, *
 * ClassScannerFactory, GuiceConfig, GuiceSetup, List)}</li>
 * </ol>
 *
 * @param registry
 * 		(optional) the GuiceRegistry to expose to the Guice environment
 * @param scannerFactory
 * 		(optional) classpath scanner to use
 * @param configs
 * 		base configurations to use
 * @param roles
 * 		base roles to use
 * @param staticSetup
 * 		(optional) a {@link GuiceSetup} implementation to use instead of loading the class name from a property
 * @param autoLoadProperties
 * 		if true, environment.properties etc. and network configuration will be loaded from disk
 * @param autoLoadRoles
 * 		if true, roles will be loaded using the Service Provider Interface
 * @param classloader
 * 		the classloader to use when loading environment.properties etc.
 *
 * @return
 */
static Injector build(final GuiceRegistry registry, ClassScannerFactory scannerFactory, final List<PropertyFile> configs, final List<GuiceRole> roles, final GuiceSetup staticSetup, final boolean autoLoadProperties, final boolean autoLoadRoles, final ClassLoader classloader) {
    final ServiceLoader<GuiceRole> loader = ServiceLoader.load(GuiceRole.class);
    // Find additional guice roles from jar files using the Service Provider Interface
    if (autoLoadRoles) {
        Iterator<GuiceRole> it = loader.iterator();
        while (it.hasNext()) {
            final GuiceRole role = it.next();
            log.debug("Discovered guice role: " + role);
            roles.add(role);
        }
    }
    // Make sure that the first most basic level of properties is the system environment variables
    configs.add(0, getAllEnvironmentVariables());
    // Allow all GuiceRole implementations to add/remove/reorder configuration sources
    for (GuiceRole role : roles) {
        log.debug("Adding requested guice role: " + role);
        role.adjustConfigurations(configs);
    }
    GuiceConfig properties = new GuiceConfig();
    // Generate a random instance ID for this instance of the guice environment
    final String instanceId = SimpleId.alphanumeric(32);
    // Make the randomly generated instance id available to others
    properties.set(GuiceProperties.INSTANCE_ID, instanceId);
    for (PropertyFile config : configs) properties.setAll(config);
    // Load all the core property files?
    if (autoLoadProperties) {
        applyConfigs(classloader, properties);
    }
    // This is a bit of a hack really, but let's insert the GuiceRole for network config if network config is enabled
    if (hasNetworkConfiguration(properties)) {
        final NetworkConfigGuiceRole role = new NetworkConfigGuiceRole();
        roles.add(role);
    }
    // Read the override configuration property to find the override config file
    // Load the override config file and pass that along too.
    PropertyFile overrideFile = load(properties.get(GuiceProperties.OVERRIDE_FILE_PROPERTY));
    // If there are overrides then rebuild the configuration to reflect it
    if (overrideFile != null) {
        log.debug("Applying overrides: " + overrideFile.getFile());
        properties.setOverrides(overrideFile.toMap());
    }
    // Set up the class scanner factory (if the scanner property is set and one has not been provided)
    if (scannerFactory == null) {
        List<String> packages = properties.getList(GuiceProperties.SCAN_PACKAGES, Collections.emptyList());
        if (packages != null && !packages.isEmpty())
            scannerFactory = new ClassScannerFactory(packages.toArray(new String[packages.size()]));
        else
            throw new IllegalArgumentException("Property " + GuiceProperties.SCAN_PACKAGES + " has not been set!");
    }
    final GuiceSetup setup;
    if (staticSetup == null) {
        // Load the Setup property and load the Setup class
        final Class<? extends GuiceSetup> setupClass = getClass(properties, GuiceSetup.class, GuiceProperties.SETUP_PROPERTY);
        try {
            if (setupClass == null)
                throw new IllegalArgumentException("Could not find a setup class!");
            setup = setupClass.newInstance();
            log.debug("Constructed GuiceSetup: " + setupClass);
        } catch (InstantiationException | IllegalAccessException e) {
            throw new IllegalArgumentException("Error constructing instance of " + setupClass, e);
        }
    } else {
        log.debug("Using static GuiceSetup: " + staticSetup);
        setup = staticSetup;
    }
    return createInjector(registry, scannerFactory, properties, setup, roles);
}