Module io.inverno.mod.discovery.http

Package io.inverno.mod.discovery.http

Class HttpTrafficPolicy

java.lang.Object

io.inverno.mod.discovery.http.HttpTrafficPolicy

All Implemented Interfaces:

TrafficPolicy<HttpServiceInstance,UnboundExchange<?>>

public class HttpTrafficPolicy
extends Object
implements TrafficPolicy<HttpServiceInstance,UnboundExchange<?>>

An HTTP traffic policy defining load balancing strategy as well as configuration HTTP client and Net client configurations used when creating an HTTP client Endpoint in a service instance.

Since:

1.12

Author:

Jeremy Kuhn

See Also:

• HttpServiceInstance

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HttpTrafficPolicy.Builder	An HTTP traffic policy builder.
static enum	HttpTrafficPolicy.LoadBalancingStrategy	Load balancing strategies supported in HTTP services.

Field Summary

Fields

Modifier and Type	Field	Description
static final HttpTrafficPolicy.LoadBalancingStrategy	DEFAULT_LOAD_BALANCER_STRATEGY	The default load balancer strategy.

Method Summary

Modifier and Type	Method	Description
static HttpTrafficPolicy.Builder	builder()	Returns an HTTP traffic policy builder.
static HttpTrafficPolicy.Builder	builder(HttpTrafficPolicy originalTrafficPolicy)	Returns an HTTP traffic policy builder from an original traffic policy.
boolean	equals(Object o)
HttpClientConfiguration	getConfiguration()	Returns the HTTP client configuration.
TrafficLoadBalancer<HttpServiceInstance,UnboundExchange<?>>	getLoadBalancer(Collection<HttpServiceInstance> instances)	Returns a traffic load balancer for load balancing service request among the specified collection of instances.
TrafficLoadBalancer.Factory<HttpServiceInstance,UnboundExchange<?>>	getLoadBalancerFactory()	Returns the load balancer factory.
HttpTrafficPolicy.LoadBalancingStrategy	getLoadBalancingStrategy()	Returns the load balancing strategy.
NetClientConfiguration	getNetConfiguration()	Returns the Net client configuration.
int	hashCode()

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_LOAD_BALANCER_STRATEGY

public static final HttpTrafficPolicy.LoadBalancingStrategy DEFAULT_LOAD_BALANCER_STRATEGY

The default load balancer strategy.

Method Details

getConfiguration

public HttpClientConfiguration getConfiguration()

Returns the HTTP client configuration.

Returns:

the HTTP client configuration or null to use the default configuration

getNetConfiguration

public NetClientConfiguration getNetConfiguration()

Returns the Net client configuration.

Returns:

the Net client configuration or null to use the default configuration

getLoadBalancerFactory

public TrafficLoadBalancer.Factory<HttpServiceInstance,UnboundExchange<?>> getLoadBalancerFactory()

Returns the load balancer factory.

Returns:

the load balancer factory

getLoadBalancingStrategy

public HttpTrafficPolicy.LoadBalancingStrategy getLoadBalancingStrategy()

Returns the load balancing strategy.

Returns:

the load balancing strategy

builder

public static HttpTrafficPolicy.Builder builder()

Returns an HTTP traffic policy builder.

Returns:

an HTTP traffic policy builder

builder

public static HttpTrafficPolicy.Builder builder(HttpTrafficPolicy originalTrafficPolicy)

Returns an HTTP traffic policy builder from an original traffic policy.

Parameters:

originalTrafficPolicy - the original traffic policy

Returns:

an HTTP traffic policy builder

getLoadBalancer

public TrafficLoadBalancer<HttpServiceInstance,UnboundExchange<?>> getLoadBalancer(Collection<HttpServiceInstance> instances)
                                                                            throws IllegalArgumentException

Description copied from interface: TrafficPolicy

Returns a traffic load balancer for load balancing service request among the specified collection of instances.

Specified by:

getLoadBalancer in interface TrafficPolicy<HttpServiceInstance,UnboundExchange<?>>

Parameters:

instances - a collection of service instances

Returns:

a traffic load balancer

Throws:

IllegalArgumentException - if the collection of instance is empty

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object