org.springframework.cloud.netflix.ribbon.support

Class AbstractLoadBalancingClient<S extends ContextAwareRequest,T extends com.netflix.client.IResponse,D>

java.lang.Object

com.netflix.loadbalancer.LoadBalancerContext

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

org.springframework.cloud.netflix.ribbon.support.AbstractLoadBalancingClient<S,T,D>

Type Parameters:

D - delegate

S - ContextAwareRequest subtype

T - ServiceInstanceChooser subtype

All Implemented Interfaces:

com.netflix.client.IClient<S,T>, com.netflix.client.IClientConfigAware, org.springframework.cloud.client.loadbalancer.ServiceInstanceChooser

Direct Known Subclasses:

OkHttpLoadBalancingClient, RibbonLoadBalancingHttpClient

public abstract class AbstractLoadBalancingClient<S extends ContextAwareRequest,T extends com.netflix.client.IResponse,D>
extends com.netflix.client.AbstractLoadBalancerAwareClient<S,T>
implements org.springframework.cloud.client.loadbalancer.ServiceInstanceChooser

Author:

Spencer Gibb

Field Summary

Fields

Modifier and Type	Field and Description
protected com.netflix.client.config.IClientConfig	config
protected int	connectTimeout
protected D	delegate
protected boolean	followRedirects
protected boolean	gzipPayload
protected boolean	okToRetryOnAllOperations
protected int	readTimeout
protected boolean	secure
protected ServerIntrospector	serverIntrospector

Fields inherited from class com.netflix.loadbalancer.LoadBalancerContext

clientName, defaultRetryHandler, maxAutoRetries, maxAutoRetriesNextServer, vipAddresses

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractLoadBalancingClient(D delegate, com.netflix.client.config.IClientConfig config, ServerIntrospector serverIntrospector)
protected	AbstractLoadBalancingClient(com.netflix.client.config.IClientConfig config, ServerIntrospector serverIntrospector)

Method Summary

Modifier and Type	Method and Description
org.springframework.cloud.client.ServiceInstance	choose(String serviceId)
protected abstract D	createDelegate(com.netflix.client.config.IClientConfig config)
protected void	customizeLoadBalancerCommandBuilder(S request, com.netflix.client.config.IClientConfig config, com.netflix.loadbalancer.reactive.LoadBalancerCommand.Builder<T> builder)
D	getDelegate()
com.netflix.client.RequestSpecificRetryHandler	getRequestSpecificRetryHandler(S request, com.netflix.client.config.IClientConfig requestConfig)
void	initWithNiwsConfig(com.netflix.client.config.IClientConfig clientConfig)
boolean	isClientRetryable(ContextAwareRequest request)
protected boolean	isSecure(com.netflix.client.config.IClientConfig config)
void	validateServiceInstance(org.springframework.cloud.client.ServiceInstance serviceInstance)

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, reconstructURIWithServer, setLoadBalancer, setMaxAutoRetries, setMaxAutoRetriesNextServer, setOkToRetryOnAllOperations, setRetryHandler

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.netflix.client.IClient

execute

Field Detail

connectTimeout

protected int connectTimeout

readTimeout

protected int readTimeout

secure

protected boolean secure

followRedirects

protected boolean followRedirects

gzipPayload

protected boolean gzipPayload

okToRetryOnAllOperations

protected boolean okToRetryOnAllOperations

delegate

protected final D delegate

config

protected final com.netflix.client.config.IClientConfig config

serverIntrospector

protected final ServerIntrospector serverIntrospector

Constructor Detail

AbstractLoadBalancingClient

protected AbstractLoadBalancingClient(com.netflix.client.config.IClientConfig config,
                                      ServerIntrospector serverIntrospector)

AbstractLoadBalancingClient

protected AbstractLoadBalancingClient(D delegate,
                                      com.netflix.client.config.IClientConfig config,
                                      ServerIntrospector serverIntrospector)

Method Detail

isClientRetryable

public boolean isClientRetryable(ContextAwareRequest request)

initWithNiwsConfig

public void initWithNiwsConfig(com.netflix.client.config.IClientConfig clientConfig)

Specified by:

initWithNiwsConfig in interface com.netflix.client.IClientConfigAware

Overrides:

initWithNiwsConfig in class com.netflix.loadbalancer.LoadBalancerContext

createDelegate

protected abstract D createDelegate(com.netflix.client.config.IClientConfig config)

getDelegate

public D getDelegate()

getRequestSpecificRetryHandler

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

Specified by:

getRequestSpecificRetryHandler in class com.netflix.client.AbstractLoadBalancerAwareClient<S extends ContextAwareRequest,T extends com.netflix.client.IResponse>

isSecure

protected boolean isSecure(com.netflix.client.config.IClientConfig config)

customizeLoadBalancerCommandBuilder

protected void customizeLoadBalancerCommandBuilder(S request,
                                                   com.netflix.client.config.IClientConfig config,
                                                   com.netflix.loadbalancer.reactive.LoadBalancerCommand.Builder<T> builder)

Overrides:

customizeLoadBalancerCommandBuilder in class com.netflix.client.AbstractLoadBalancerAwareClient<S extends ContextAwareRequest,T extends com.netflix.client.IResponse>

choose

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

Specified by:

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

validateServiceInstance

public void validateServiceInstance(org.springframework.cloud.client.ServiceInstance serviceInstance)
                             throws com.netflix.client.ClientException

Throws:

com.netflix.client.ClientException