com.netflix.archaius.guice

Class ArchaiusModule

java.lang.Object

com.google.inject.AbstractModule

com.netflix.archaius.guice.ArchaiusModule

All Implemented Interfaces:

com.google.inject.Module

public final class ArchaiusModule
extends com.google.inject.AbstractModule

Guice module with default bindings to enable Config injection and configuration mapping/binding in a Guice based application. By default this module will create a top level Config that is a CompositeConfig of the following layers, RUNTIME - properties set from code OVERRIDE - properties loaded from a remote source SYSTEM - System properties ENVIRONMENT - Environment properties APPLICATION - Configuration loaded by the application LIBRARIES - Configuration loaded by libraries used by the application Runtime properties may be set by either injecting and calling one of the setters for,

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ArchaiusModule.ConfigProvider<T> Deprecated. Use @Provides instead

Constructor Summary

Constructors

Constructor and Description
ArchaiusModule()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	configure()
static <T> com.google.inject.AbstractModule	forProxy(java.lang.Class<T> proxy) Deprecated. Use @Provides instead
com.netflix.archaius.Config	getConfig(java.util.Set<com.netflix.archaius.ConfigListener> listeners, com.netflix.archaius.Config config, com.netflix.archaius.config.CompositeConfig applicationLayer, java.lang.String configName, com.netflix.archaius.config.CompositeConfig overrideLayer, com.netflix.archaius.config.SettableConfig runtimeLayer, com.netflix.archaius.ConfigLoader loader, com.netflix.archaius.CascadeStrategy cascadeStrategy, java.util.Set<ConfigSeeder> runtimeConfigResolvers, java.util.Set<ConfigSeeder> remoteConfigResolvers) All code will ultimately inject Config to gain access to the entire configuration hierarchy.

Methods inherited from class com.google.inject.AbstractModule

addError, addError, addError, bind, bind, bind, bindConstant, binder, bindInterceptor, bindListener, bindListener, bindScope, configure, convertToTypes, currentStage, getMembersInjector, getMembersInjector, getProvider, getProvider, install, requestInjection, requestStaticInjection, requireBinding, requireBinding

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ArchaiusModule

public ArchaiusModule()

Method Detail

forProxy

@Deprecated
public static <T> com.google.inject.AbstractModule forProxy(java.lang.Class<T> proxy)

Deprecated. Use @Provides instead

Parameters:

proxy -

Returns:

configure

protected void configure()

Specified by:

configure in class com.google.inject.AbstractModule

getConfig

@Provides
public com.netflix.archaius.Config getConfig(java.util.Set<com.netflix.archaius.ConfigListener> listeners,
                                             com.netflix.archaius.Config config,
                                             com.netflix.archaius.config.CompositeConfig applicationLayer,
                                             java.lang.String configName,
                                             com.netflix.archaius.config.CompositeConfig overrideLayer,
                                             com.netflix.archaius.config.SettableConfig runtimeLayer,
                                             com.netflix.archaius.ConfigLoader loader,
                                             com.netflix.archaius.CascadeStrategy cascadeStrategy,
                                             java.util.Set<ConfigSeeder> runtimeConfigResolvers,
                                             java.util.Set<ConfigSeeder> remoteConfigResolvers)
                                      throws java.lang.Exception

All code will ultimately inject Config to gain access to the entire configuration hierarchy. The empty hierarchy is created by @RootLayer but here we do the actual Configuration initialization which includes, 1. Loading application properties 2. Loading runtime overrides 3. Loading override layer overrides

Parameters:

librariesLayer -

applicationLayer -

settableLayer -

overrideLayer -

Returns:

Throws:

com.netflix.archaius.exceptions.ConfigException

java.lang.Exception