org.springframework.cloud.client.loadbalancer

Interface LoadBalancerClient

All Superinterfaces:

ServiceInstanceChooser

public interface LoadBalancerClient
extends ServiceInstanceChooser

Represents a client side load balancer

Author:

Spencer Gibb

Method Summary

Modifier and Type	Method and Description
<T> T	execute(String serviceId, LoadBalancerRequest<T> request) execute request using a ServiceInstance from the LoadBalancer for the specified service
<T> T	execute(String serviceId, ServiceInstance serviceInstance, LoadBalancerRequest<T> request) execute request using a ServiceInstance from the LoadBalancer for the specified service
URI	reconstructURI(ServiceInstance instance, URI original) Create a proper URI with a real host and port for systems to utilize.

Methods inherited from interface org.springframework.cloud.client.loadbalancer.ServiceInstanceChooser

choose

Method Detail

execute

<T> T execute(String serviceId,
              LoadBalancerRequest<T> request)
       throws IOException

execute request using a ServiceInstance from the LoadBalancer for the specified service

Parameters:

serviceId - the service id to look up the LoadBalancer

request - allows implementations to execute pre and post actions such as incrementing metrics

Returns:

the result of the LoadBalancerRequest callback on the selected ServiceInstance

Throws:

IOException

execute

<T> T execute(String serviceId,
              ServiceInstance serviceInstance,
              LoadBalancerRequest<T> request)
       throws IOException

execute request using a ServiceInstance from the LoadBalancer for the specified service

Parameters:

serviceId - the service id to look up the LoadBalancer

serviceInstance - the service to execute the request to

request - allows implementations to execute pre and post actions such as incrementing metrics

Returns:

the result of the LoadBalancerRequest callback on the selected ServiceInstance

Throws:

IOException

reconstructURI

URI reconstructURI(ServiceInstance instance,
                   URI original)

Create a proper URI with a real host and port for systems to utilize. Some systems use a URI with the logical serivce name as the host, such as http://myservice/path/to/service. This will replace the service name with the host:port from the ServiceInstance.

Parameters:

instance -

original - a URI with the host as a logical service name

Returns:

a reconstructed URI