com.spotify.apollo.module

Interface ApolloModule

All Superinterfaces:

com.google.inject.Module

All Known Implementing Classes:

AbstractApolloModule, ApolloEnvironmentModule, HttpClientModule, HttpServerModule, SlackModule

public interface ApolloModule
extends com.google.inject.Module

A module that can be loaded by Apollo to add more functionality to a service. DO NOT USE this interface directly. It is not part of the public API. Instead, extend AbstractApolloModule which is part of the public API.

Method Summary

Modifier and Type	Method and Description
String	getId() Returns the id for this module.
Set<? extends com.google.inject.Key<?>>	getLifecycleManaged() Returns the immutable, idempotently determined and stable set of injection keys that should be bound to the service lifecycle; i.e.
double	getPriority() Returns the priority of this module relative to other modules.

Methods inherited from interface com.google.inject.Module

configure

Method Detail

getId

String getId()

Returns the id for this module.

Returns:

the id for this module.

getPriority

double getPriority()

Returns the priority of this module relative to other modules. A higher priority means that initialization will happen earlier for this module. This only matters for independent components of module dependencies; dependencies will always be initialized before the dependees. The default ("don't care") priority is 0.0.

Returns:

the priority of this module relative to other modules.

getLifecycleManaged

Set<? extends com.google.inject.Key<?>> getLifecycleManaged()

Returns the immutable, idempotently determined and stable set of injection keys that should be bound to the service lifecycle; i.e. created on service start-up and destroyed on shutdown. All the instances for the keys returned by this method that implement Closeable will be closed on shutdown.

Returns:

the set of injection keys that should be bound to the service lifecycle.