feign.hystrix

Class HystrixFeign.Builder

java.lang.Object

feign.BaseBuilder<Feign.Builder>

feign.Feign.Builder

feign.hystrix.HystrixFeign.Builder

Enclosing class:

HystrixFeign

public static final class HystrixFeign.Builder
extends Feign.Builder

Field Summary

Fields inherited from class feign.BaseBuilder

capabilities, closeAfterDecode, decoder, dismiss404, encoder, errorDecoder, invocationHandlerFactory, logger, logLevel, options, propagationPolicy, queryMapEncoder, requestInterceptors, responseInterceptor, retryer

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
Feign	build()
HystrixFeign.Builder	client(Client client)
HystrixFeign.Builder	contract(Contract contract)
HystrixFeign.Builder	decode404()
HystrixFeign.Builder	decoder(Decoder decoder)
HystrixFeign.Builder	dismiss404()
HystrixFeign.Builder	encoder(Encoder encoder)
HystrixFeign.Builder	errorDecoder(ErrorDecoder errorDecoder)
Feign.Builder	invocationHandlerFactory(InvocationHandlerFactory invocationHandlerFactory)
HystrixFeign.Builder	logger(Logger logger)
HystrixFeign.Builder	logLevel(Logger.Level logLevel)
HystrixFeign.Builder	mapAndDecode(ResponseMapper mapper, Decoder decoder)
HystrixFeign.Builder	options(Request.Options options)
HystrixFeign.Builder	requestInterceptor(RequestInterceptor requestInterceptor)
HystrixFeign.Builder	requestInterceptors(Iterable<RequestInterceptor> requestInterceptors)
HystrixFeign.Builder	retryer(Retryer retryer)
HystrixFeign.Builder	setterFactory(SetterFactory setterFactory) Allows you to override hystrix properties such as thread pools and command keys.
<T> T	target(Class<T> apiType, String url, FallbackFactory<? extends T> fallbackFactory) Same as #target(Class, String, T), except you can inspect a source exception before creating a fallback object.
<T> T	target(Class<T> apiType, String url, T fallback) Like Feign.newInstance(Target), except with fallback support.
<T> T	target(Target<T> target, FallbackFactory<? extends T> fallbackFactory)
<T> T	target(Target<T> target, T fallback)

Methods inherited from class feign.Feign.Builder

target, target

Methods inherited from class feign.BaseBuilder

addCapability, doNotCloseAfterDecode, enrich, exceptionPropagationPolicy, queryMapEncoder, responseInterceptor

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

setterFactory

public HystrixFeign.Builder setterFactory(SetterFactory setterFactory)

Allows you to override hystrix properties such as thread pools and command keys.

target

public <T> T target(Target<T> target,
                    T fallback)

See Also:

target(Class, String, Object)

target

public <T> T target(Target<T> target,
                    FallbackFactory<? extends T> fallbackFactory)

See Also:

target(Class, String, FallbackFactory)

target

public <T> T target(Class<T> apiType,
                    String url,
                    T fallback)

Like Feign.newInstance(Target), except with fallback support.

Fallbacks are known values, which you return when there's an error invoking an http method. For example, you can return a cached result as opposed to raising an error to the caller. To use this feature, pass a safe implementation of your target interface as the last parameter. Here's an example:

 

 // When dealing with fallbacks, it is less tedious to keep interfaces small.
 interface GitHub {
   @RequestLine("GET /repos/{owner}/{repo}/contributors")
   List<String> contributors(@Param("owner") String owner, @Param("repo") String repo);
 }

 // This instance will be invoked if there are errors of any kind.
 GitHub fallback = (owner, repo) -> {
   if (owner.equals("Netflix") && repo.equals("feign")) {
     return Arrays.asList("stuarthendren"); // inspired this approach!
   } else {
     return Collections.emptyList();
   }
 };

 GitHub github = HystrixFeign.builder()
                             ...
                             .target(GitHub.class, "https://api.github.com", fallback);
 
 

See Also:

target(Target, Object)

target

public <T> T target(Class<T> apiType,
                    String url,
                    FallbackFactory<? extends T> fallbackFactory)

Same as #target(Class, String, T), except you can inspect a source exception before creating a fallback object.

invocationHandlerFactory

public Feign.Builder invocationHandlerFactory(InvocationHandlerFactory invocationHandlerFactory)

Overrides:

invocationHandlerFactory in class BaseBuilder<Feign.Builder>

contract

public HystrixFeign.Builder contract(Contract contract)

Overrides:

contract in class BaseBuilder<Feign.Builder>

build

public Feign build()

Overrides:

build in class Feign.Builder

logLevel

public HystrixFeign.Builder logLevel(Logger.Level logLevel)

Overrides:

logLevel in class BaseBuilder<Feign.Builder>

client

public HystrixFeign.Builder client(Client client)

Overrides:

client in class Feign.Builder

retryer

public HystrixFeign.Builder retryer(Retryer retryer)

Overrides:

retryer in class BaseBuilder<Feign.Builder>

logger

public HystrixFeign.Builder logger(Logger logger)

Overrides:

logger in class BaseBuilder<Feign.Builder>

encoder

public HystrixFeign.Builder encoder(Encoder encoder)

Overrides:

encoder in class BaseBuilder<Feign.Builder>

decoder

public HystrixFeign.Builder decoder(Decoder decoder)

Overrides:

decoder in class BaseBuilder<Feign.Builder>

mapAndDecode

public HystrixFeign.Builder mapAndDecode(ResponseMapper mapper,
                                         Decoder decoder)

Overrides:

mapAndDecode in class BaseBuilder<Feign.Builder>

decode404

public HystrixFeign.Builder decode404()

Overrides:

decode404 in class BaseBuilder<Feign.Builder>

dismiss404

public HystrixFeign.Builder dismiss404()

Overrides:

dismiss404 in class BaseBuilder<Feign.Builder>

errorDecoder

public HystrixFeign.Builder errorDecoder(ErrorDecoder errorDecoder)

Overrides:

errorDecoder in class BaseBuilder<Feign.Builder>

options

public HystrixFeign.Builder options(Request.Options options)

Overrides:

options in class BaseBuilder<Feign.Builder>

requestInterceptor

public HystrixFeign.Builder requestInterceptor(RequestInterceptor requestInterceptor)

Overrides:

requestInterceptor in class BaseBuilder<Feign.Builder>

requestInterceptors

public HystrixFeign.Builder requestInterceptors(Iterable<RequestInterceptor> requestInterceptors)

Overrides:

requestInterceptors in class BaseBuilder<Feign.Builder>