inject

Type Members

1. case class Injector(underlying: google.inject.Injector) extends Product with Serializable

   

2. abstract class StackTransformer extends Transformer

   

   StackTransformer allows plugins to modify Finatra filters before they are applied to controller routes.

   StackTransformer allows plugins to modify Finatra filters before they are applied to controller routes.

   Related to the Finagle com.twitter.finagle.StackTransformer, which modifies Finagle server stacks, the Finatra StackTransformer modifies Finatra controller routes.

   If the goal is to share functionality between Finagle and Finatra, it's reasonable to want to use Finagle's StackTransformer directly on Finatra routes. However, the unit of functionality, and therefore meaningful reuse, is the stack module - the StackTransformer merely adapts stack modules to various stack contexts.

   The stack module as the unit of reuse also makes it possible to install them in specific contexts; for example, modules that should be installed at the service-level but not at the route-level (e.g. admission controllers).

3. trait TwitterBaseModule extends TwitterModuleFlags with TwitterModuleLifecycle

   

4. abstract class TwitterModule extends AbstractModule with TwitterBaseModule with Logging

   

   A support class for Module implementations which exposes a DSL for binding via type parameters.

   A support class for Module implementations which exposes a DSL for binding via type parameters. Extend this class, override the configure method and call the bind methods, or define custom @Provides annotated methods. This class also provides an integration with com.twitter.app.Flag types which allows for passing external configuration to aid in the creation of bound types. Lastly, it is also possible to define a list of other TwitterModule instances which this TwitterModule "depends" on by setting the TwitterBaseModule.modules (or TwitterBaseModule.javaModules) to a non-empty list. This will ensure that when only this TwitterModule instance is used to compose an Injector the "dependent" list of modules will also be installed.

   Example:

   1. object MyModule extends TwitterModule {
       flag[String](name = "card.gateway", help = "The processing gateway to use for credit cards.")
       override protected def configure(): Unit = {
         bind[Service].to[ServiceImpl].in[Singleton]
         bind[CreditCardPaymentService]
         bind[Bar[Foo]].to[FooBarImpl]
         bind[PaymentService].to[CreditCardPaymentService]
       }
       @Singleton
       @Provides
       def provideCreditCardServiceProcessor(
         @Flag("card.gateway") gateway: String
       ): CreditCardProcessor = {
         new CreditCardProcessor(gateway)
       }
      }

   Note

   Attempting to bind the same type multiple times with no discriminating com.google.inject.BindingAnnotation will result in an exception during injector construction.

   See also

   Writing Modules in Finatra

   com.google.inject.AbstractModule

5. trait TwitterModuleFlags extends AnyRef

   

   Guice/twitter.util.Flag integrations usable from both non-private and private Guice modules

6. trait TwitterModuleLifecycle extends Logging

   

   com.twitter.inject.TwitterModule to com.twitter.inject.app.App lifecycle integration.

7. abstract class TwitterPrivateModule extends PrivateModule with TwitterBaseModule with ScalaPrivateModule

   

   A module whose configuration information is hidden from its environment by default.

   A module whose configuration information is hidden from its environment by default. Only bindings that are explicitly exposed will be available to other modules and to the users of the injector. This module may expose the bindings it creates and the bindings of the modules it installs.

   Note

   Calling com.google.inject.PrivateModule#install in the configure() method is not supported. Please set TwitterBaseModule.modules (or TwitterBaseModule.javaModules) to a non-empty list instead.

   See also

   Writing Modules in Finatra

   com.google.inject.PrivateModule