StandaloneLagomClientFactory

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

Instance Constructors

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

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 information
This member is added by an implicit conversion from StandaloneLagomClientFactory to any2stringadd[StandaloneLagomClientFactory] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (StandaloneLagomClientFactory, B)

Implicit information
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()
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
lazy val actorSystem: ActorSystem

Definition Classes
StandaloneLagomClientFactory → LagomServiceClientComponents
lazy val applicationLifecycle: ApplicationLifecycle

Definition Classes
LagomClientFactory → LagomServiceClientComponents
final def asInstanceOf[T0]: T0

Definition Classes
Any
lazy val circuitBreakerMetricsProvider: CircuitBreakerMetricsProvider

Definition Classes
LagomServiceClientComponents
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def config: Config

Definition Classes
LagomConfigComponent
lazy val configuration: Configuration

Definition Classes
LagomClientFactory → LagomConfigComponent
lazy val defaultExceptionSerializer: ExceptionSerializer

Definition Classes
LagomServiceClientComponents
def ensuring(cond: (StandaloneLagomClientFactory) ⇒ Boolean, msg: ⇒ Any): StandaloneLagomClientFactory

Implicit information
This member is added by an implicit conversion from StandaloneLagomClientFactory to Ensuring[StandaloneLagomClientFactory] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (StandaloneLagomClientFactory) ⇒ Boolean): StandaloneLagomClientFactory

Implicit information
This member is added by an implicit conversion from StandaloneLagomClientFactory to Ensuring[StandaloneLagomClientFactory] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): StandaloneLagomClientFactory

Implicit information
This member is added by an implicit conversion from StandaloneLagomClientFactory to Ensuring[StandaloneLagomClientFactory] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): StandaloneLagomClientFactory

Implicit information
This member is added by an implicit conversion from StandaloneLagomClientFactory to Ensuring[StandaloneLagomClientFactory] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
lazy val environment: Environment

Definition Classes
LagomClientFactory → LagomServiceClientComponents
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
lazy val executionContext: ExecutionContext

Definition Classes
LagomClientFactory → LagomServiceClientComponents
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def formatted(fmtstr: String): String

Implicit information
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()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
lazy val materializer: Materializer

Definition Classes
StandaloneLagomClientFactory → LagomServiceClientComponents
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def optionalTopicFactory: Option[TopicFactory]

Definition Classes
TopicFactoryProvider
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
lazy val scaladslWebSocketClient: ScaladslWebSocketClient

Definition Classes
LagomServiceClientComponents
lazy val serviceClient: ServiceClient

Definition Classes
LagomServiceClientComponents
lazy val serviceInfo: ServiceInfo

Definition Classes
LagomClientFactory → LagomServiceClientComponents
lazy val serviceResolver: ServiceResolver

Definition Classes
LagomServiceClientComponents
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
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def topicPublisherName: Option[String]

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( ... )
def →[B](y: B): (StandaloneLagomClientFactory, B)

Implicit information
This member is added by an implicit conversion from StandaloneLagomClientFactory to ArrowAssoc[StandaloneLagomClientFactory] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Related Doc: package client

abstract class StandaloneLagomClientFactory extends LagomClientFactory

Instance Constructors

new StandaloneLagomClientFactory(clientName: String, classLoader: ClassLoader = ...)

Abstract Value Members

abstract def serviceLocator: ServiceLocator

abstract def wsClient: WSClient

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (StandaloneLagomClientFactory, B)

final def ==(arg0: Any): Boolean

lazy val actorSystem: ActorSystem

lazy val applicationLifecycle: ApplicationLifecycle

final def asInstanceOf[T0]: T0

lazy val circuitBreakerMetricsProvider: CircuitBreakerMetricsProvider

def clone(): AnyRef

def config: Config

lazy val configuration: Configuration

lazy val defaultExceptionSerializer: ExceptionSerializer

def ensuring(cond: (StandaloneLagomClientFactory) ⇒ Boolean, msg: ⇒ Any): StandaloneLagomClientFactory

def ensuring(cond: (StandaloneLagomClientFactory) ⇒ Boolean): StandaloneLagomClientFactory

def ensuring(cond: Boolean, msg: ⇒ Any): StandaloneLagomClientFactory

def ensuring(cond: Boolean): StandaloneLagomClientFactory

lazy val environment: Environment

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

lazy val executionContext: ExecutionContext

def finalize(): Unit

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

lazy val materializer: Materializer

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def optionalTopicFactory: Option[TopicFactory]

final def releaseInternalResources(): Future[Done]

lazy val scaladslWebSocketClient: ScaladslWebSocketClient

lazy val serviceClient: ServiceClient

lazy val serviceInfo: ServiceInfo

lazy val serviceResolver: ServiceResolver

def stop(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

def topicPublisherName: Option[String]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def →[B](y: B): (StandaloneLagomClientFactory, B)

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