c

com.lightbend.lagom.scaladsl.client

LagomClientFactory

abstract class LagomClientFactory extends LagomServiceClientComponents with LagomConfigComponent

Convenience for constructing service clients in a non Lagom server application.

LagomClientFactory should be used only if your application DO have its own akka.actor.ActorSystem and Akka Streams akka.stream.Materializer, in which case you should reuse then when building a LagomClientFactory.

The easiest way to reuse your existing akka.actor.ActorSystem and Akka Stream akka.stream.Materializer is to extend the LagomClientFactory and add a constructor where you can pass them as arguments (see example below).

There is one more component that you’ll need to provide when creating a LagomClientFactory, that is a service locator. It is up to you what service locator you use, it could be a third party service locator, or a service locator created from static configuration.

Lagom provides a number of built-in service locators, including a StaticServiceLocator, a RoundRobinServiceLocator and a ConfigurationServiceLocator. The easiest way to use these is to mix in their respective Components traits.

For example, here’s a client factory built using the static service locator, which uses a static URI, and reusing an akka.actor.ActorSystem and Akka Streams akka.stream.Materializer created outside it:

import java.net.URI
import com.lightbend.lagom.scaladsl.client._
import play.api.libs.ws.ahc.AhcWSComponents

class MyLagomClientFactory(val actorSystem: ActorSystem, val materializer: Materializer)
  extends LagomClientFactory("my-client")
  with StaticServiceLocatorComponents
  with AhcWSComponents {

  override def staticServiceUri = URI.create("http://localhost:8080")
}


val actorSystem = ActorSystem("my-app")
val materializer = SystemMaterializer(actorSystem).materializer
val clientFactory = new MyLagomClientFactory(actorSystem, materializer)
Source
ServiceClient.scala
Linear Supertypes
LagomConfigComponent, LagomServiceClientComponents, TopicFactoryProvider, AnyRef, Any
Known Subclasses
StandaloneLagomClientFactory, LagomClientApplication
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LagomClientFactory
  2. LagomConfigComponent
  3. LagomServiceClientComponents
  4. TopicFactoryProvider
  5. AnyRef
  6. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new LagomClientFactory(clientName: String, classLoader: ClassLoader = ...)

    clientName

    The name of the service that is consuming the Lagom service. This will impact how calls made through clients generated by this factory will identify themselves.

    classLoader

    A classloader, it will be used to create the service proxy and needs to have the API for the client in it.

Abstract Value Members

  1. abstract def actorSystem: ActorSystem
    Definition Classes
    LagomServiceClientComponents
  2. abstract def materializer: Materializer
    Definition Classes
    LagomServiceClientComponents
  3. abstract def serviceLocator: ServiceLocator
    Definition Classes
    LagomServiceClientComponents
  4. abstract def wsClient: WSClient
    Definition Classes
    LagomServiceClientComponents

Concrete Value Members

  1. lazy val applicationLifecycle: ApplicationLifecycle
    Definition Classes
    LagomClientFactory → LagomServiceClientComponents
  2. lazy val circuitBreakerMetricsProvider: CircuitBreakerMetricsProvider
    Definition Classes
    LagomServiceClientComponents
  3. def config: Config
    Definition Classes
    LagomConfigComponent
  4. lazy val configuration: Configuration
    Definition Classes
    LagomClientFactory → LagomConfigComponent
  5. lazy val defaultExceptionSerializer: ExceptionSerializer
    Definition Classes
    LagomServiceClientComponents
  6. lazy val environment: Environment
    Definition Classes
    LagomClientFactory → LagomServiceClientComponents
  7. lazy val executionContext: ExecutionContext
    Definition Classes
    LagomClientFactory → LagomServiceClientComponents
  8. def optionalTopicFactory: Option[TopicFactory]
    Definition Classes
    TopicFactoryProvider
  9. lazy val scaladslWebSocketClient: ScaladslWebSocketClient
    Definition Classes
    LagomServiceClientComponents
  10. lazy val serviceClient: ServiceClient
    Definition Classes
    LagomServiceClientComponents
  11. lazy val serviceInfo: ServiceInfo
    Definition Classes
    LagomClientFactory → LagomServiceClientComponents
  12. lazy val serviceResolver: ServiceResolver
    Definition Classes
    LagomServiceClientComponents
  13. def stop(): Unit

    Override this method if your LagomClientFactory implementation needs to free any resource.

    Override this method if your LagomClientFactory implementation needs to free any resource.

    For example, when implementing your own LagomClientFactory, you may choose to reuse an existing akka.actor.ActorSystem, but use a internal akka.stream.Materializer. In which case, you can use this method to only shutdown the akka.stream.Materializer.

    If you override this method, make sure you also release the internally managed resources by calling #releaseInternalResources() method.

  14. 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