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 for setting up archaius and making its components injectable. Installing this module also enables the following functionality.

• Injectable Config
• Configuration Proxy
• Configuration mapping

Note that this module has state and should therefore only be installed once. It should only be installed by applications and not by libraries depending on archaius. Such libraries should only specify a bindger.requiresBinding(Config.class). This module creates an injectable Config instances 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 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 AbstractModule { @Override protected void configure() {} @Provides @RemoteLayer Config getRemoteConfig(@Raw Config config) { return new FooRemoteConfigImplementaiton(config); } }

Constructor Summary

Constructors

Constructor and Description
ArchaiusModule()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	configure()
boolean	equals(java.lang.Object obj) equals() on a Module is used by Guice to dedup modules that are installed more than once as modules are assumed to be stateless.
int	hashCode()
ArchaiusModule	withApplicationOverrides(com.netflix.archaius.api.Config config)
ArchaiusModule	withApplicationOverrides(java.util.Properties prop)
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)

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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ArchaiusModule

public ArchaiusModule()

Method Detail

withConfigName

public ArchaiusModule withConfigName(java.lang.String value)

withApplicationOverrides

public ArchaiusModule withApplicationOverrides(java.util.Properties prop)

withApplicationOverrides

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

withCascadeStrategy

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

Deprecated. Customize by binding CascadeStrategy in a guice module

configure

protected void configure()

Specified by:

configure in class com.google.inject.AbstractModule

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

equals() on a Module is used by Guice to dedup modules that are installed more than once as modules are assumed to be stateless. ArchaiusModule however is stateful in that it is initially set up outside of Guice. The following equals() will result in duplicate binding errors if more than one ArchaiusModule is installed().

Overrides:

equals in class java.lang.Object