org.springframework.cloud.netflix.ribbon.okhttp

Class RetryableOkHttpLoadBalancingClient

java.lang.Object

com.netflix.loadbalancer.LoadBalancerContext

com.netflix.client.AbstractLoadBalancerAwareClient<S,T>

org.springframework.cloud.netflix.ribbon.support.AbstractLoadBalancingClient<OkHttpRibbonRequest,OkHttpRibbonResponse,okhttp3.OkHttpClient>

org.springframework.cloud.netflix.ribbon.okhttp.OkHttpLoadBalancingClient

org.springframework.cloud.netflix.ribbon.okhttp.RetryableOkHttpLoadBalancingClient

All Implemented Interfaces:

com.netflix.client.IClient<OkHttpRibbonRequest,OkHttpRibbonResponse>, com.netflix.client.IClientConfigAware, org.springframework.cloud.client.loadbalancer.ServiceInstanceChooser

public class RetryableOkHttpLoadBalancingClient
extends OkHttpLoadBalancingClient
implements org.springframework.cloud.client.loadbalancer.ServiceInstanceChooser

An OK HTTP client which leverages Spring Retry to retry failed request.

Author:

Ryan Baxter, Gang Li

Field Summary

Fields inherited from class org.springframework.cloud.netflix.ribbon.support.AbstractLoadBalancingClient

config, connectTimeout, delegate, followRedirects, okToRetryOnAllOperations, readTimeout, secure, serverIntrospector

Fields inherited from class com.netflix.loadbalancer.LoadBalancerContext

clientName, defaultRetryHandler, maxAutoRetries, maxAutoRetriesNextServer, vipAddresses

Constructor Summary

Constructors

Constructor and Description
RetryableOkHttpLoadBalancingClient(okhttp3.OkHttpClient delegate, com.netflix.client.config.IClientConfig config, ServerIntrospector serverIntrospector, org.springframework.cloud.client.loadbalancer.LoadBalancedRetryPolicyFactory loadBalancedRetryPolicyFactory) Deprecated.
RetryableOkHttpLoadBalancingClient(okhttp3.OkHttpClient delegate, com.netflix.client.config.IClientConfig config, ServerIntrospector serverIntrospector, org.springframework.cloud.client.loadbalancer.LoadBalancedRetryPolicyFactory loadBalancedRetryPolicyFactory, org.springframework.cloud.client.loadbalancer.LoadBalancedBackOffPolicyFactory loadBalancedBackOffPolicyFactory) Deprecated.
RetryableOkHttpLoadBalancingClient(okhttp3.OkHttpClient delegate, com.netflix.client.config.IClientConfig config, ServerIntrospector serverIntrospector, org.springframework.cloud.client.loadbalancer.LoadBalancedRetryPolicyFactory loadBalancedRetryPolicyFactory, org.springframework.cloud.client.loadbalancer.LoadBalancedBackOffPolicyFactory loadBalancedBackOffPolicyFactory, org.springframework.cloud.client.loadbalancer.LoadBalancedRetryListenerFactory loadBalancedRetryListenerFactory)

Method Summary

Modifier and Type	Method and Description
org.springframework.cloud.client.ServiceInstance	choose(String serviceId)
OkHttpRibbonResponse	execute(OkHttpRibbonRequest ribbonRequest, com.netflix.client.config.IClientConfig configOverride)
com.netflix.client.RequestSpecificRetryHandler	getRequestSpecificRetryHandler(OkHttpRibbonRequest request, com.netflix.client.config.IClientConfig requestConfig)
boolean	isClientRetryable(ContextAwareRequest request)

Methods inherited from class org.springframework.cloud.netflix.ribbon.okhttp.OkHttpLoadBalancingClient

createDelegate, reconstructURIWithServer

Methods inherited from class org.springframework.cloud.netflix.ribbon.support.AbstractLoadBalancingClient

customizeLoadBalancerCommandBuilder, getDelegate, initWithNiwsConfig, isSecure

Methods inherited from class com.netflix.client.AbstractLoadBalancerAwareClient

buildLoadBalancerCommand, executeWithLoadBalancer, executeWithLoadBalancer, isCircuitBreakerException, isRetriable, isRetriableException

Methods inherited from class com.netflix.loadbalancer.LoadBalancerContext

deriveHostAndPortFromVipAddress, deriveSchemeAndPortFromPartialUri, generateNIWSException, getClientName, getDeepestCause, getDefaultPortFromScheme, getExecuteTracer, getLoadBalancer, getMaxAutoRetries, getMaxAutoRetriesNextServer, getNumberRetriesOnSameServer, getRetriesNextServer, getRetryHandler, getServerFromLoadBalancer, getServerStats, handleSameServerRetry, isOkToRetryOnAllOperations, noteError, noteOpenConnection, noteRequestCompletion, noteRequestCompletion, noteResponse, setLoadBalancer, setMaxAutoRetries, setMaxAutoRetriesNextServer, setOkToRetryOnAllOperations, setRetryHandler

Methods inherited from class java.lang.Object

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

Constructor Detail

RetryableOkHttpLoadBalancingClient

@Deprecated
public RetryableOkHttpLoadBalancingClient(okhttp3.OkHttpClient delegate,
                                                      com.netflix.client.config.IClientConfig config,
                                                      ServerIntrospector serverIntrospector,
                                                      org.springframework.cloud.client.loadbalancer.LoadBalancedRetryPolicyFactory loadBalancedRetryPolicyFactory)

Deprecated.

RetryableOkHttpLoadBalancingClient

@Deprecated
public RetryableOkHttpLoadBalancingClient(okhttp3.OkHttpClient delegate,
                                                      com.netflix.client.config.IClientConfig config,
                                                      ServerIntrospector serverIntrospector,
                                                      org.springframework.cloud.client.loadbalancer.LoadBalancedRetryPolicyFactory loadBalancedRetryPolicyFactory,
                                                      org.springframework.cloud.client.loadbalancer.LoadBalancedBackOffPolicyFactory loadBalancedBackOffPolicyFactory)

Deprecated.

RetryableOkHttpLoadBalancingClient

public RetryableOkHttpLoadBalancingClient(okhttp3.OkHttpClient delegate,
                                          com.netflix.client.config.IClientConfig config,
                                          ServerIntrospector serverIntrospector,
                                          org.springframework.cloud.client.loadbalancer.LoadBalancedRetryPolicyFactory loadBalancedRetryPolicyFactory,
                                          org.springframework.cloud.client.loadbalancer.LoadBalancedBackOffPolicyFactory loadBalancedBackOffPolicyFactory,
                                          org.springframework.cloud.client.loadbalancer.LoadBalancedRetryListenerFactory loadBalancedRetryListenerFactory)

Method Detail

isClientRetryable

public boolean isClientRetryable(ContextAwareRequest request)

Overrides:

isClientRetryable in class AbstractLoadBalancingClient<OkHttpRibbonRequest,OkHttpRibbonResponse,okhttp3.OkHttpClient>

execute

public OkHttpRibbonResponse execute(OkHttpRibbonRequest ribbonRequest,
                                    com.netflix.client.config.IClientConfig configOverride)
                             throws Exception

Specified by:

execute in interface com.netflix.client.IClient<OkHttpRibbonRequest,OkHttpRibbonResponse>

Overrides:

execute in class OkHttpLoadBalancingClient

Throws:

Exception

choose

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

Specified by:

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

getRequestSpecificRetryHandler

public com.netflix.client.RequestSpecificRetryHandler getRequestSpecificRetryHandler(OkHttpRibbonRequest request,
                                                                                     com.netflix.client.config.IClientConfig requestConfig)

Overrides:

getRequestSpecificRetryHandler in class AbstractLoadBalancingClient<OkHttpRibbonRequest,OkHttpRibbonResponse,okhttp3.OkHttpClient>