c

com.lightbend.lagom.scaladsl.client

StandaloneLagomClientFactory

abstract class StandaloneLagomClientFactory extends LagomClientFactory

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

A StandaloneLagomClientFactory should be used only if your application does NOT have its own akka.actor.ActorSystem, in which this standalone factory will create and manage an akka.actor.ActorSystem and Akka Streams akka.stream.Materializer.

It is important to invoke StandaloneLagomClientFactory#stop() when the application is no longer needed, as this will trigger the shutdown of the underlying akka.actor.ActorSystem and Akka Streams akka.stream.Materializer releasing all thread and connection pools in use by the clients.

There is one more component that you’ll need to provide when creating a client application, 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 application built using the static service locator, which uses a static URI:

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

val clientApplication = new StandaloneLagomClientFactory("my-client")
  with StaticServiceLocatorComponents
  with AhcWSComponents {

  override def staticServiceUri = URI.create("http://localhost:8080")
}
Source
ServiceClient.scala
Linear Supertypes
LagomClientFactory, LagomConfigComponent, LagomServiceClientComponents, TopicFactoryProvider, AnyRef, Any
Known Subclasses
LagomClientApplication
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StandaloneLagomClientFactory
  2. LagomClientFactory
  3. LagomConfigComponent
  4. LagomServiceClientComponents
  5. TopicFactoryProvider
  6. AnyRef
  7. 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 StandaloneLagomClientFactory(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 serviceLocator: ServiceLocator
    Definition Classes
    LagomServiceClientComponents
  2. abstract def wsClient: WSClient
    Definition Classes
    LagomServiceClientComponents

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from StandaloneLagomClientFactory to any2stringadd[StandaloneLagomClientFactory] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (StandaloneLagomClientFactory, B)
    Implicit
    This member is added by an implicit conversion from StandaloneLagomClientFactory to ArrowAssoc[StandaloneLagomClientFactory] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. lazy val actorSystem: ActorSystem
    Definition Classes
    StandaloneLagomClientFactory → LagomServiceClientComponents
  7. lazy val applicationLifecycle: ApplicationLifecycle
    Definition Classes
    LagomClientFactory → LagomServiceClientComponents
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. lazy val circuitBreakerMetricsProvider: CircuitBreakerMetricsProvider
    Definition Classes
    LagomServiceClientComponents
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  11. def config: Config
    Definition Classes
    LagomConfigComponent
  12. lazy val configuration: Configuration
    Definition Classes
    LagomClientFactory → LagomConfigComponent
  13. lazy val defaultExceptionSerializer: ExceptionSerializer
    Definition Classes
    LagomServiceClientComponents
  14. def ensuring(cond: (StandaloneLagomClientFactory) ⇒ Boolean, msg: ⇒ Any): StandaloneLagomClientFactory
    Implicit
    This member is added by an implicit conversion from StandaloneLagomClientFactory to Ensuring[StandaloneLagomClientFactory] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: (StandaloneLagomClientFactory) ⇒ Boolean): StandaloneLagomClientFactory
    Implicit
    This member is added by an implicit conversion from StandaloneLagomClientFactory to Ensuring[StandaloneLagomClientFactory] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean, msg: ⇒ Any): StandaloneLagomClientFactory
    Implicit
    This member is added by an implicit conversion from StandaloneLagomClientFactory to Ensuring[StandaloneLagomClientFactory] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean): StandaloneLagomClientFactory
    Implicit
    This member is added by an implicit conversion from StandaloneLagomClientFactory to Ensuring[StandaloneLagomClientFactory] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. lazy val environment: Environment
    Definition Classes
    LagomClientFactory → LagomServiceClientComponents
  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  21. lazy val executionContext: ExecutionContext
    Definition Classes
    LagomClientFactory → LagomServiceClientComponents
  22. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  23. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from StandaloneLagomClientFactory to StringFormat[StandaloneLagomClientFactory] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  24. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  25. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. lazy val materializer: Materializer
    Definition Classes
    StandaloneLagomClientFactory → LagomServiceClientComponents
  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  31. def optionalTopicFactory: Option[TopicFactory]
    Definition Classes
    TopicFactoryProvider
  32. final def releaseInternalResources(): Future[Done]

    Releases the internal resources manages by this LagomClientFactory.

    Releases the internal resources manages by this LagomClientFactory.

    Attributes
    protected
    Definition Classes
    LagomClientFactory
  33. lazy val scaladslWebSocketClient: ScaladslWebSocketClient
    Definition Classes
    LagomServiceClientComponents
  34. lazy val serviceClient: ServiceClient
    Definition Classes
    LagomServiceClientComponents
  35. lazy val serviceInfo: ServiceInfo
    Definition Classes
    LagomClientFactory → LagomServiceClientComponents
  36. lazy val serviceResolver: ServiceResolver
    Definition Classes
    LagomServiceClientComponents
  37. def stop(): Unit

    Stop this LagomClientFactory by shutting down the internal akka.actor.ActorSystem, Akka Streams akka.stream.Materializer and internal resources.

    Stop this LagomClientFactory by shutting down the internal akka.actor.ActorSystem, Akka Streams akka.stream.Materializer and internal resources.

    Definition Classes
    StandaloneLagomClientFactory → LagomClientFactory
  38. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  39. def toString(): String
    Definition Classes
    AnyRef → Any
  40. 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
  41. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  44. def →[B](y: B): (StandaloneLagomClientFactory, B)
    Implicit
    This member is added by an implicit conversion from StandaloneLagomClientFactory to ArrowAssoc[StandaloneLagomClientFactory] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from LagomClientFactory

Inherited from LagomConfigComponent

Inherited from LagomServiceClientComponents

Inherited from TopicFactoryProvider

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from StandaloneLagomClientFactory to any2stringadd[StandaloneLagomClientFactory]

Inherited by implicit conversion StringFormat from StandaloneLagomClientFactory to StringFormat[StandaloneLagomClientFactory]

Inherited by implicit conversion Ensuring from StandaloneLagomClientFactory to Ensuring[StandaloneLagomClientFactory]

Inherited by implicit conversion ArrowAssoc from StandaloneLagomClientFactory to ArrowAssoc[StandaloneLagomClientFactory]

Ungrouped