abstract class LagomApplication extends BuiltInComponentsFromContext with ProvidesAdditionalConfiguration with ProvidesJsonSerializerRegistry with LagomServerComponents with LagomServiceClientComponents with LagomConfigComponent
A Lagom application.
A Lagom service should subclass this in order to wire together a Lagom application.
This includes the Lagom server components (which builds and provides the Lagom router) as well as the Lagom service client components (which allows implementing Lagom service clients from Lagom service descriptors).
There are two abstract defs that must be implemented, one is LagomServerComponents.lagomServer, the other
is LagomServiceClientComponents.serviceLocator. Typically, the lagomServer component will be implemented by
an abstract subclass of this class, and will bind all the services that this Lagom application provides. Meanwhile,
the serviceLocator component will be provided by mixing in a service locator components trait in
LagomApplicationLoader, which trait is mixed in will vary depending on whether the application is being loaded
for production or for development.
- Alphabetic
- By Inheritance
- LagomApplication
- LagomConfigComponent
- LagomServiceClientComponents
- TopicFactoryProvider
- LagomServerComponents
- MetricsServiceComponents
- ProvidesJsonSerializerRegistry
- ProvidesAdditionalConfiguration
- BuiltInComponentsFromContext
- BuiltInComponents
- I18nComponents
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
LagomApplication(context: LagomApplicationContext)
- context
The application context.
Abstract Value Members
-
abstract
def
lagomServer: LagomServer
- Definition Classes
- LagomServerComponents
-
abstract
def
serviceLocator: ServiceLocator
- Definition Classes
- LagomServiceClientComponents
-
abstract
def
wsClient: WSClient
- Definition Classes
- LagomServiceClientComponents
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
+(other: String): String
- Implicit
- This member is added by an implicit conversion from LagomApplication to any2stringadd[LagomApplication] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (LagomApplication, B)
- Implicit
- This member is added by an implicit conversion from LagomApplication to ArrowAssoc[LagomApplication] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
Action: DefaultActionBuilder
- Attributes
- protected
- Definition Classes
- BuiltInComponents
-
lazy val
actorSystem: ActorSystem
- Definition Classes
- LagomApplication → LagomServiceClientComponents → MetricsServiceComponents → BuiltInComponents
-
def
additionalConfiguration: AdditionalConfiguration
Define the additional configuration to add to the application.
Define the additional configuration to add to the application.
Classes that override this must combine the configuration they add with the configuration from the super implementation. Failure to do this will prevent different integrations from working with each other.
When overriding, the overridden file should be a def, so as to ensure multiple components can all override it. Lagom will only invoke this method once from a lazy val, so it will effectively be calculated once.
- Definition Classes
- ProvidesAdditionalConfiguration
-
lazy val
application: Application
- Definition Classes
- BuiltInComponents
-
lazy val
applicationLifecycle: ApplicationLifecycle
- Definition Classes
- BuiltInComponentsFromContext → BuiltInComponents
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
macro
def
bindService[T <: Service]: LagomServiceBinder[T]
- Attributes
- protected
- Definition Classes
- LagomServerComponents
-
lazy val
circuitBreakerMetricsProvider: CircuitBreakerMetricsProvider
- Definition Classes
- LagomServiceClientComponents
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
config: Config
- Definition Classes
- LagomConfigComponent
-
lazy val
controllerComponents: ControllerComponents
- Definition Classes
- BuiltInComponentsFromContext
-
lazy val
cookieSigner: CookieSigner
- Definition Classes
- BuiltInComponents
-
lazy val
csrfTokenSigner: CSRFTokenSigner
- Definition Classes
- BuiltInComponents
-
lazy val
defaultActionBuilder: DefaultActionBuilder
- Definition Classes
- BuiltInComponents
-
lazy val
defaultBodyParser: BodyParser[AnyContent]
- Definition Classes
- BuiltInComponents
-
lazy val
defaultExceptionSerializer: ExceptionSerializer
- Definition Classes
- LagomServiceClientComponents
-
def
ensuring(cond: (LagomApplication) ⇒ Boolean, msg: ⇒ Any): LagomApplication
- Implicit
- This member is added by an implicit conversion from LagomApplication to Ensuring[LagomApplication] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (LagomApplication) ⇒ Boolean): LagomApplication
- Implicit
- This member is added by an implicit conversion from LagomApplication to Ensuring[LagomApplication] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): LagomApplication
- Implicit
- This member is added by an implicit conversion from LagomApplication to Ensuring[LagomApplication] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): LagomApplication
- Implicit
- This member is added by an implicit conversion from LagomApplication to Ensuring[LagomApplication] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
lazy val
environment: Environment
- Definition Classes
- BuiltInComponentsFromContext → BuiltInComponents → I18nComponents
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
implicit
lazy val
executionContext: ExecutionContext
- Definition Classes
- BuiltInComponents
-
lazy val
fileMimeTypes: FileMimeTypes
- Definition Classes
- BuiltInComponents
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from LagomApplication to StringFormat[LagomApplication] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
lazy val
httpConfiguration: HttpConfiguration
- Definition Classes
- BuiltInComponents → I18nComponents
-
lazy val
httpErrorHandler: HttpErrorHandler
- Definition Classes
- BuiltInComponents
-
val
httpFilters: Seq[EssentialFilter]
- Definition Classes
- LagomApplication → BuiltInComponents
-
lazy val
httpRequestHandler: HttpRequestHandler
- Definition Classes
- BuiltInComponents
-
lazy val
injector: Injector
- Definition Classes
- BuiltInComponents
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
lazy val
javaContextComponents: JavaContextComponents
- Definition Classes
- BuiltInComponents
-
lazy val
lagomServerBuilder: LagomServerBuilder
- Definition Classes
- LagomServerComponents → MetricsServiceComponents
-
lazy val
langs: Langs
- Definition Classes
- I18nComponents
-
implicit
lazy val
materializer: Materializer
- Definition Classes
- BuiltInComponents
-
lazy val
messagesApi: MessagesApi
- Definition Classes
- I18nComponents
-
lazy val
metricsServiceBinding: LagomServiceBinding[MetricsService]
- Definition Classes
- MetricsServiceComponents
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
optionalJsonSerializerRegistry: Option[JsonSerializerRegistry]
The optionally provided serializer registry.
The optionally provided serializer registry.
Note that this can also be exploited to allow multiple traits to contribute to the serializer registry rather than provide one, by checking whether the super implementation also provides one, and concatenating with that if it does. To do that, the override must be a def, so that it can be subsequently overridden by other mixed in traits.
- Definition Classes
- ProvidesJsonSerializerRegistry
-
def
optionalTopicFactory: Option[TopicFactory]
- Definition Classes
- TopicFactoryProvider
-
def
parse: PlayBodyParsers
- Attributes
- protected
- Definition Classes
- BuiltInComponents
-
lazy val
playBodyParsers: PlayBodyParsers
- Definition Classes
- BuiltInComponents
-
lazy val
requestFactory: RequestFactory
- Definition Classes
- BuiltInComponents
-
lazy val
router: Router
- Definition Classes
- LagomServerComponents
-
lazy val
scaladslWebSocketClient: ScaladslWebSocketClient
- Definition Classes
- LagomServiceClientComponents
-
macro
def
serverFor[T <: Service](serviceFactory: ⇒ T): LagomServer
Bind a server for the given service and factory for the service.
Bind a server for the given service and factory for the service.
Note, the type parameter for this method should always be passed explicitly, as the macro needs it to know what the trait for the service descriptor should be.
- Attributes
- protected
- Definition Classes
- LagomServerComponents
-
lazy val
serviceClient: ServiceClient
- Definition Classes
- LagomServiceClientComponents
-
lazy val
serviceInfo: ServiceInfo
- Definition Classes
- LagomServerComponents
-
lazy val
serviceResolver: ServiceResolver
- Definition Classes
- LagomServiceClientComponents
-
lazy val
sourceMapper: Option[SourceMapper]
- Definition Classes
- BuiltInComponentsFromContext → BuiltInComponents
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
lazy val
tempFileCreator: TemporaryFileCreator
- Definition Classes
- BuiltInComponents
-
lazy val
tempFileReaper: TemporaryFileReaper
- Definition Classes
- BuiltInComponents
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
def
topicPublisherName: Option[String]
The name of the topic publisher.
The name of the topic publisher.
Since topic publishers don't actually provide any components, they just consume a LagomServer and publish the topics they find there, this can be used to signal that a topic publisher has been provided to publish topics, so that the LagomServerComponents can detect a misconfiguration where one hasn't been provided.
- returns
The name of the topic publisher that has published topics, if one has been provided.
- Definition Classes
- TopicFactoryProvider
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
lazy val
webCommands: WebCommands
- Definition Classes
- BuiltInComponentsFromContext → BuiltInComponents
-
def
→[B](y: B): (LagomApplication, B)
- Implicit
- This member is added by an implicit conversion from LagomApplication to ArrowAssoc[LagomApplication] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
Deprecated Value Members
-
lazy val
configuration: Configuration
- Definition Classes
- LagomApplication → LagomConfigComponent → BuiltInComponentsFromContext → BuiltInComponents → I18nComponents
- Annotations
- @deprecated
- Deprecated
(Since version 1.4.0) prefer
configusing typesafe Config instead