org.springframework.cloud.netflix.ribbon

Class RibbonLoadBalancerClient

java.lang.Object

org.springframework.cloud.netflix.ribbon.RibbonLoadBalancerClient

All Implemented Interfaces:

org.springframework.cloud.client.loadbalancer.LoadBalancerClient, org.springframework.cloud.client.loadbalancer.ServiceInstanceChooser

public class RibbonLoadBalancerClient
extends Object
implements org.springframework.cloud.client.loadbalancer.LoadBalancerClient

Author:

Spencer Gibb, Dave Syer, Ryan Baxter, Tim Ysewyn

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RibbonLoadBalancerClient.RibbonServer Ribbon-server-specific ServiceInstance implementation.

Constructor Summary

Constructors

Constructor and Description
RibbonLoadBalancerClient(SpringClientFactory clientFactory)

Method Summary

Modifier and Type	Method and Description
org.springframework.cloud.client.ServiceInstance	choose(String serviceId)
org.springframework.cloud.client.ServiceInstance	choose(String serviceId, Object hint) New: Select a server using a 'key'.
<T> T	execute(String serviceId, org.springframework.cloud.client.loadbalancer.LoadBalancerRequest<T> request)
<T> T	execute(String serviceId, org.springframework.cloud.client.loadbalancer.LoadBalancerRequest<T> request, Object hint) New: Execute a request by selecting server using a 'key'.
<T> T	execute(String serviceId, org.springframework.cloud.client.ServiceInstance serviceInstance, org.springframework.cloud.client.loadbalancer.LoadBalancerRequest<T> request)
protected com.netflix.loadbalancer.ILoadBalancer	getLoadBalancer(String serviceId)
protected com.netflix.loadbalancer.Server	getServer(com.netflix.loadbalancer.ILoadBalancer loadBalancer)
protected com.netflix.loadbalancer.Server	getServer(com.netflix.loadbalancer.ILoadBalancer loadBalancer, Object hint)
protected com.netflix.loadbalancer.Server	getServer(String serviceId)
URI	reconstructURI(org.springframework.cloud.client.ServiceInstance instance, URI original)

Methods inherited from class java.lang.Object

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

Constructor Detail

RibbonLoadBalancerClient

public RibbonLoadBalancerClient(SpringClientFactory clientFactory)

Method Detail

reconstructURI

public URI reconstructURI(org.springframework.cloud.client.ServiceInstance instance,
                          URI original)

Specified by:

reconstructURI in interface org.springframework.cloud.client.loadbalancer.LoadBalancerClient

choose

public org.springframework.cloud.client.ServiceInstance choose(String serviceId)

Specified by:

choose in interface org.springframework.cloud.client.loadbalancer.ServiceInstanceChooser

choose

public org.springframework.cloud.client.ServiceInstance choose(String serviceId,
                                                               Object hint)

New: Select a server using a 'key'.

Parameters:

serviceId - of the service to choose an instance for

hint - to specify the service instance

Returns:

the selected ServiceInstance

execute

public <T> T execute(String serviceId,
                     org.springframework.cloud.client.loadbalancer.LoadBalancerRequest<T> request)
              throws IOException

Specified by:

execute in interface org.springframework.cloud.client.loadbalancer.LoadBalancerClient

Throws:

IOException

execute

public <T> T execute(String serviceId,
                     org.springframework.cloud.client.loadbalancer.LoadBalancerRequest<T> request,
                     Object hint)
              throws IOException

New: Execute a request by selecting server using a 'key'. The hint will have to be the last parameter to not mess with the `execute(serviceId, ServiceInstance, request)` method. This somewhat breaks the fluent coding style when using a lambda to define the LoadBalancerRequest.

Type Parameters:

T - returned request execution result type

Parameters:

serviceId - id of the service to execute the request to

request - to be executed

hint - used to choose appropriate Server instance

Returns:

request execution result

Throws:

IOException - executing the request may result in an IOException

execute

public <T> T execute(String serviceId,
                     org.springframework.cloud.client.ServiceInstance serviceInstance,
                     org.springframework.cloud.client.loadbalancer.LoadBalancerRequest<T> request)
              throws IOException

Specified by:

execute in interface org.springframework.cloud.client.loadbalancer.LoadBalancerClient

Throws:

IOException

getServer

protected com.netflix.loadbalancer.Server getServer(String serviceId)

getServer

protected com.netflix.loadbalancer.Server getServer(com.netflix.loadbalancer.ILoadBalancer loadBalancer)

getServer

protected com.netflix.loadbalancer.Server getServer(com.netflix.loadbalancer.ILoadBalancer loadBalancer,
                                                    Object hint)

getLoadBalancer

protected com.netflix.loadbalancer.ILoadBalancer getLoadBalancer(String serviceId)