com.peterphi.std.guice.apploader

Interface GuiceRole

All Known Implementing Classes:

BindEagerSingletonRole

public interface GuiceRole

Method Summary

Modifier and Type	Method and Description
void	adjustConfigurations(List<org.apache.commons.configuration.Configuration> configs) Provides an opportunity, pre-compositing, to influence the configuration sources and order.
void	injectorCreated(com.google.inject.Stage stage, ClassScannerFactory scannerFactory, org.apache.commons.configuration.CompositeConfiguration config, org.apache.commons.configuration.PropertiesConfiguration overrides, GuiceSetup setup, List<com.google.inject.Module> modules, AtomicReference<com.google.inject.Injector> injectorRef, com.codahale.metrics.MetricRegistry metrics) Called once the Injector has been created
void	register(com.google.inject.Stage stage, ClassScannerFactory scannerFactory, org.apache.commons.configuration.CompositeConfiguration config, org.apache.commons.configuration.PropertiesConfiguration overrides, GuiceSetup setup, List<com.google.inject.Module> modules, AtomicReference<com.google.inject.Injector> injectorRef, com.codahale.metrics.MetricRegistry metrics) Provides an opportunity to influence modules (adding, removing, reordering) being loaded.

Method Detail

adjustConfigurations

void adjustConfigurations(List<org.apache.commons.configuration.Configuration> configs)

Provides an opportunity, pre-compositing, to influence the configuration sources and order. Configuration sources earlier in this list will be overridden by configuration sources later in the list.

Called before #register(com.google.inject.Stage, org.apache.commons.configuration.CompositeConfiguration, org.apache.commons.configuration.PropertiesConfiguration, GuiceSetup, java.util.List, java.util.concurrent.atomic.AtomicReference)

Parameters:

configs -

register

void register(com.google.inject.Stage stage,
              ClassScannerFactory scannerFactory,
              org.apache.commons.configuration.CompositeConfiguration config,
              org.apache.commons.configuration.PropertiesConfiguration overrides,
              GuiceSetup setup,
              List<com.google.inject.Module> modules,
              AtomicReference<com.google.inject.Injector> injectorRef,
              com.codahale.metrics.MetricRegistry metrics)

Provides an opportunity to influence modules (adding, removing, reordering) being loaded. Called before the GuiceSetup class has loaded its modules.

Called before #injectorCreated(com.google.inject.Stage, com.peterphi.std.guice.common.ClassScanner, org.apache.commons.configuration.CompositeConfiguration, org.apache.commons.configuration.PropertiesConfiguration, GuiceSetup, java.util.List, java.util.concurrent.atomic.AtomicReference)

Parameters:

stage -

scannerFactory - a factory for a classpath scanner for the user application classes. Implementations should not hold on to this for long (to save memory usage)

config -

overrides -

setup -

modules -

injectorRef -

metrics - the MetricsRegistry for environment-wide metrics

injectorCreated

void injectorCreated(com.google.inject.Stage stage,
                     ClassScannerFactory scannerFactory,
                     org.apache.commons.configuration.CompositeConfiguration config,
                     org.apache.commons.configuration.PropertiesConfiguration overrides,
                     GuiceSetup setup,
                     List<com.google.inject.Module> modules,
                     AtomicReference<com.google.inject.Injector> injectorRef,
                     com.codahale.metrics.MetricRegistry metrics)

Called once the Injector has been created

Parameters:

stage -

scannerFactory - a factory for a classpath scanner for the user application classes. Implementations should not hold on to this for long (to save memory usage)

config -

overrides -

setup -

modules - the final list of modules in use

injectorRef - the reference to the injector, must contain a non-null value

metrics - the MetricsRegistry for environment-wide metrics