Trait/Object

com.lightbend.lagom.scaladsl.api

ServiceLocator

Related Docs: object ServiceLocator | package api

Permalink

trait ServiceLocator extends AnyRef

Locates services.

The service locator is responsible for two things, one is locating services according to the passed in name and service call information, the other is to implement circuit breaking functionality when #doWithService is invoked.

The reason circuit breaking is a service locator concern is that generally, the service locator will want to be aware of when a circuit breaker is open, and respond accordingly. For example, it may decide to pull that node from its routing pool, or it may decide to notify some up stream service registry that that node is no longer responding.

Source
ServiceLocator.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
CircuitBreakingServiceLocator, ConfigurationServiceLocator, NoServiceLocator, RoundRobinServiceLocator, StaticServiceLocator
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ServiceLocator
  2. AnyRef
  3. 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

Abstract Value Members

  1. abstract def doWithService[T](name: String, serviceCall: Call[_, _])(block: (URI) ⇒ Future[T])(implicit ec: ExecutionContext): Future[Option[T]]

    Permalink

    Do the given action with the given service.

    Do the given action with the given service.

    This should be used in preference to #locate when possible as it will allow the service locator to add in things like circuit breakers.

    It is required that the service locator will, based on the service call circuit breaker configuration, wrap the invocation of the passed in block with a circuit breaker.

    name

    The name of the service.

    serviceCall

    The service call descriptor that this lookup is for.

    block

    A block of code that takes the URI for the service, and returns a future of some work done on the service. This will only be executed if the service was found.

    returns

    The result of the executed block, if the service was found.

  2. abstract def locate(name: String, serviceCall: Call[_, _]): Future[Option[URI]]

    Permalink

    Locate a service with the given name.

    Locate a service with the given name.

    name

    The name of the service.

    serviceCall

    The service call descriptor that this lookup is for.

    returns

    The URI for that service, if it exists.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

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

  4. def ->[B](y: B): (ServiceLocator, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from ServiceLocator to ArrowAssoc[ServiceLocator] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. def ensuring(cond: (ServiceLocator) ⇒ Boolean, msg: ⇒ Any): ServiceLocator

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

  9. def ensuring(cond: (ServiceLocator) ⇒ Boolean): ServiceLocator

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

  10. def ensuring(cond: Boolean, msg: ⇒ Any): ServiceLocator

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

  11. def ensuring(cond: Boolean): ServiceLocator

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

  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  15. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from ServiceLocator to StringFormat[ServiceLocator] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  17. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  19. def locate(name: String): Future[Option[URI]]

    Permalink

    Locate a service with the given name.

    Locate a service with the given name.

    name

    The name of the service.

    returns

    The URI for that service, if it exists.

  20. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  24. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  25. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  27. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  28. def →[B](y: B): (ServiceLocator, B)

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

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped