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 class ArchaiusModule
extends com.google.inject.AbstractModule

Guice Module for enabling archaius and making its components injectable. Installing this module also enables the following functionality.

• Injectable Config
• Configuration Proxy
• Configuration mapping

This module creates an injectable Config instance that has the following override structure in order of precedence. RUNTIME - properties set from code REMOTE - 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 DEFAULT - Default properties driven by bindings Runtime properties may be set in code by injecting and calling one of the setXXX methods of, @RuntimeLayer SettableConfig config A remote configuration may be specified by binding to @RemoteLayer Config When setting up a remote configuration that needs access to Archaius's Config make sure to inject the qualified @Raw Config otherwise the injector will fail with a circular dependency error. Note that the injected config will have system, environment and application properties loaded into it. public class FooRemoteModule extends ArchaiusModule { @Provides @RemoteLayer Config getRemoteConfig(@Raw Config config) { return new FooRemoteConfigImplementaiton(config); } }

Constructor Summary

Constructors

Constructor and Description
ArchaiusModule()

Method Summary

Modifier and Type	Method and Description
protected com.google.inject.binder.LinkedBindingBuilder<com.netflix.archaius.api.Config>	bindApplicationConfigurationOverride() Set application overrides.
protected void	bindApplicationConfigurationOverrideResource(java.lang.String overrideResource) Set application overrides to a particular resource.
protected com.google.inject.binder.LinkedBindingBuilder<com.netflix.archaius.api.CascadeStrategy>	bindCascadeStrategy() Specify the CascadeStrategy used to load environment overrides for application and library configurations.
protected com.google.inject.binder.LinkedBindingBuilder<com.netflix.archaius.api.Config>	bindConfigReader() Add support for a new configuration format.
protected com.google.inject.binder.LinkedBindingBuilder<java.lang.String>	bindConfigurationName() Customize the filename for the main application configuration.
protected com.google.inject.binder.LinkedBindingBuilder<com.netflix.archaius.api.Config>	bindDefaultConfig() Add a config to the bottom of the Config hierarchy.
protected com.google.inject.binder.LinkedBindingBuilder<com.netflix.archaius.api.Config>	bindRemoteConfig() Specify the Config to use for the remote layer.
protected void	configure()
protected void	configureArchaius()
ArchaiusModule	withApplicationOverrides(com.netflix.archaius.api.Config config) Deprecated.
ArchaiusModule	withApplicationOverrides(java.util.Properties prop) Deprecated.
ArchaiusModule	withCascadeStrategy(java.lang.Class<? extends com.netflix.archaius.api.CascadeStrategy> cascadeStrategy) Deprecated. Customize by binding CascadeStrategy in a guice module
ArchaiusModule	withConfigName(java.lang.String value) Deprecated.

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

withConfigName

@Deprecated
public ArchaiusModule withConfigName(java.lang.String value)

Deprecated.

withApplicationOverrides

@Deprecated
public ArchaiusModule withApplicationOverrides(java.util.Properties prop)

Deprecated.

withApplicationOverrides

@Deprecated
public ArchaiusModule withApplicationOverrides(com.netflix.archaius.api.Config config)

Deprecated.

withCascadeStrategy

@Deprecated
public ArchaiusModule withCascadeStrategy(java.lang.Class<? extends com.netflix.archaius.api.CascadeStrategy> cascadeStrategy)

Deprecated. Customize by binding CascadeStrategy in a guice module

configureArchaius

protected void configureArchaius()

bindConfigurationName

protected com.google.inject.binder.LinkedBindingBuilder<java.lang.String> bindConfigurationName()

Customize the filename for the main application configuration. The default filename is 'application'. install(new ArchaiusModule() { @Override protected void configureArchaius() { bindConfigurationName().toInstance("myconfig"); } });

Returns:

LinkedBindingBuilder to which the implementation is set

bindApplicationConfigurationOverride

protected com.google.inject.binder.LinkedBindingBuilder<com.netflix.archaius.api.Config> bindApplicationConfigurationOverride()

Set application overrides. This is normally done for unit tests. install(new ArchaiusModule() { @Override protected void configureArchaius() { bindApplicationConfigurationOverride().toInstance(MapConfig.builder() .put("some_property_to_override", "value") .build() ); } });

Returns:

LinkedBindingBuilder to which the implementation is set

bindRemoteConfig

protected com.google.inject.binder.LinkedBindingBuilder<com.netflix.archaius.api.Config> bindRemoteConfig()

Specify the Config to use for the remote layer. install(new ArchaiusModule() { @Override protected void configureArchaius() { bindRemoteConfig().to(SomeRemoteConfigImpl.class); } });

Returns:

LinkedBindingBuilder to which the implementation is set

bindCascadeStrategy

protected com.google.inject.binder.LinkedBindingBuilder<com.netflix.archaius.api.CascadeStrategy> bindCascadeStrategy()

Specify the CascadeStrategy used to load environment overrides for application and library configurations. install(new ArchaiusModule() { @Override protected void configureArchaius() { bindCascadeStrategy().to(MyCascadeStrategy.class); } });

Returns:

LinkedBindingBuilder to which the implementation is set

bindDefaultConfig

protected com.google.inject.binder.LinkedBindingBuilder<com.netflix.archaius.api.Config> bindDefaultConfig()

Add a config to the bottom of the Config hierarchy. Use this when configuration is added through code. Can be called multiple times as ConfigReader is added to a multibinding. install(new ArchaiusModule() { @Override protected void configureArchaius() { bindDefaultConfig().to(MyDefaultConfig.class); } });

Returns:

LinkedBindingBuilder to which the implementation is set

bindConfigReader

protected com.google.inject.binder.LinkedBindingBuilder<com.netflix.archaius.api.Config> bindConfigReader()

Add support for a new configuration format. Can be called multiple times to add support for multiple file format. install(new ArchaiusModule() { @Override protected void configureArchaius() { bindConfigReader().to(SomeConfigFormatReader.class); } });

Returns:

LinkedBindingBuilder to which the implementation is set

bindApplicationConfigurationOverrideResource

protected void bindApplicationConfigurationOverrideResource(java.lang.String overrideResource)

Set application overrides to a particular resource. This is normally done for unit tests. install(new ArchaiusModule() { @Override protected void configureArchaius() { bindApplicationConfigurationOverrideResource("laptop"); } });

configure

protected final void configure()

Specified by:

configure in class com.google.inject.AbstractModule