com.lightbend.lagom.javadsl.client

Class CircuitBreakingServiceLocator

Object

com.lightbend.lagom.javadsl.client.CircuitBreakingServiceLocator

All Implemented Interfaces:

ServiceLocator

Direct Known Subclasses:

AkkaDiscoveryServiceLocator, ConfigurationServiceLocator

public abstract class CircuitBreakingServiceLocator
extends Object
implements ServiceLocator

Abstract service locator that provides circuit breaking.

Generally, only the ServiceLocator.locate(String, Descriptor.Call) method needs to be implemented, however doWithServiceImpl(String, Descriptor.Call, Function) can be overridden if the service locator wants to handle failures in some way.

Constructor Summary

Constructors

Constructor and Description
CircuitBreakingServiceLocator(com.lightbend.lagom.internal.client.CircuitBreakers circuitBreakers) Deprecated. Use constructor accepting CircuitBreakersPanel instead
CircuitBreakingServiceLocator(CircuitBreakersPanel circuitBreakersPanel)

Method Summary

Modifier and Type	Method and Description
<T> CompletionStage<Optional<T>>	doWithService(String serviceName, Descriptor.Call<?,?> serviceCall, Function<URI,CompletionStage<T>> block) Do the given action with the given service.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.lightbend.lagom.javadsl.api.ServiceLocator

locate, locate, locateAll, locateAll

Constructor Detail

CircuitBreakingServiceLocator

public CircuitBreakingServiceLocator(CircuitBreakersPanel circuitBreakersPanel)

CircuitBreakingServiceLocator

@Deprecated
public CircuitBreakingServiceLocator(com.lightbend.lagom.internal.client.CircuitBreakers circuitBreakers)

Deprecated. Use constructor accepting CircuitBreakersPanel instead

Parameters:

circuitBreakers -

Method Detail

doWithService

public final <T> CompletionStage<Optional<T>> doWithService(String serviceName,
                                                            Descriptor.Call<?,?> serviceCall,
                                                            Function<URI,CompletionStage<T>> block)

Description copied from interface: ServiceLocator

Do the given action with the given service.

This should be used in preference to ServiceLocator.locate(String, Descriptor.Call) 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.

Specified by:

doWithService in interface ServiceLocator

Parameters:

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