Packages

  • package root
    Definition Classes
    root
  • package play

    Play framework.

    Play framework.

    Play

    http://www.playframework.com

    Definition Classes
    root
  • package api

    Contains the public API for Scala developers.

    Contains the public API for Scala developers.

    Access the current Play application 
    import play.api.Play.current
    Read configuration 
    val poolSize = configuration.getInt("engine.pool.size")
    Use the logger 
    Logger.info("Hello!")
    Define a Plugin 
    class MyPlugin(app: Application) extends Plugin
    Create adhoc applications (for testing) 
    val application = Application(new File("."), this.getClass.getClassloader, None, Play.Mode.DEV)
    Definition Classes
    play
  • package inject

    Play's runtime dependency injection abstraction.

    Play's runtime dependency injection abstraction.

    Play's runtime dependency injection support is built on JSR-330, which provides a specification for declaring how dependencies get wired to components. JSR-330 however does not address how components are provided to or located by a DI container. Play's API seeks to address this in a DI container agnostic way.

    The reason for providing this abstraction is so that Play, the modules it provides, and third party modules can all express their bindings in a way that is not specific to any one DI container.

    Components are bound in the DI container. Each binding is identified by a BindingKey, which is typically an interface that the component implements, and may be optionally qualified by a JSR-330 qualifier annotation. A binding key is bound to a BindingTarget, which describes how the implementation of the interface that the binding key represents is constructed or provided. Bindings may also be scoped using JSR-330 scope annotations.

    Bindings are provided by instances of Module.

    Out of the box, Play provides an implementation of this abstraction using Guice.

    Definition Classes
    api
    See also

    The Module class for information on how to provide bindings.

  • package guice
    Definition Classes
    inject
  • ApplicationLifecycle
  • Binding
  • BindingKey
  • BindingKeyTarget
  • BindingTarget
  • BuiltinModule
  • ConfigProvider
  • ConfigurationProvider
  • ConstructionTarget
  • DefaultApplicationLifecycle
  • Injector
  • Module
  • Modules
  • NewInstanceInjector
  • ProviderConstructionTarget
  • ProviderTarget
  • QualifierAnnotation
  • QualifierClass
  • QualifierInstance
  • RoutesProvider
  • SimpleInjector
  • SimpleModule
c

play.api.inject

Module

abstract class Module extends AnyRef

A Play dependency injection module.

Dependency injection modules can be used by Play plugins to provide bindings for JSR-330 compliant ApplicationLoaders. Any plugin that wants to provide components that a Play application can use may implement one of these.

Providing custom modules can be done by appending their fully qualified class names to play.modules.enabled in application.conf, for example

play.modules.enabled += "com.example.FooModule"
play.modules.enabled += "com.example.BarModule"

It is strongly advised that in addition to providing a module for JSR-330 DI, that plugins also provide a Scala trait that constructs the modules manually. This allows for use of the module without needing a runtime dependency injection provider.

The bind methods are provided only as a DSL for specifying bindings. For example:

def bindings(env: Environment, conf: Configuration) = Seq(
  bind[Foo].to[FooImpl],
  bind[Bar].to(new Bar()),
  bind[Foo].qualifiedWith[SomeQualifier].to[OtherFoo]
)
Source
Module.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
AssetsModule, CaffeineCacheModule, EhCacheModule, DBModule, HikariCPModule, EvolutionsModule, SlickModule, EvolutionsModule, I18nModule, BuiltinModule, SimpleModule, JCacheModule, OpenIDModule, AhcWSModule, CookiesModule, LegacyCookiesModule, FileMimeTypesModule, ObjectMapperModule, CORSModule, CSPModule, CSRFModule, GzipFilterModule, SecurityHeadersModule, AllowedHostsModule, RedirectHttpsModule, RoutingDslModule
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Module
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Module()

Abstract Value Members

  1. abstract def bindings(environment: Environment, configuration: Configuration): Seq[Binding[_]]

    Get the bindings provided by this module.

    Get the bindings provided by this module.

    Implementations are strongly encouraged to do *nothing* in this method other than provide bindings. Startup should be handled in the constructors and/or providers bound in the returned bindings. Dependencies on other modules or components should be expressed through constructor arguments.

    The configuration and environment a provided for the purpose of producing dynamic bindings, for example, if what gets bound depends on some configuration, this may be read to control that.

    environment

    The environment

    configuration

    The configuration

    returns

    A sequence of bindings

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. final def bind[T](implicit arg0: ClassTag[T]): BindingKey[T]

    Create a binding key for the given class.

  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Deprecated Value Members

  1. final def bind[T](clazz: Class[T]): BindingKey[T]

    Create a binding key for the given class.

    Create a binding key for the given class.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.7.0) Use play.inject.Module.bindClass instead if the Module is coded in Java. Scala modules can use play.api.inject.bind[T: ClassTag]

  2. final def seq(bindings: Binding[_]*): Seq[Binding[_]]

    Create a seq.

    Create a seq.

    For Java compatibility.

    Annotations
    @deprecated @varargs()
    Deprecated

    (Since version 2.7.0) Use play.inject.Module instead if the Module is coded in Java.

Inherited from AnyRef

Inherited from Any

Ungrouped