feign

Class BaseBuilder<B extends BaseBuilder<B,T>,T>

java.lang.Object

feign.BaseBuilder<B,T>

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

AsyncFeign.AsyncBuilder, Feign.Builder

public abstract class BaseBuilder<B extends BaseBuilder<B,T>,T>
extends Object
implements Cloneable

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Capability>	capabilities
protected boolean	closeAfterDecode
protected Contract	contract
protected Decoder	decoder
protected boolean	decodeVoid
protected boolean	dismiss404
protected Encoder	encoder
protected ErrorDecoder	errorDecoder
protected InvocationHandlerFactory	invocationHandlerFactory
protected Logger	logger
protected Logger.Level	logLevel
protected Request.Options	options
protected ExceptionPropagationPolicy	propagationPolicy
protected QueryMapEncoder	queryMapEncoder
protected List<RequestInterceptor>	requestInterceptors
protected ResponseInterceptor	responseInterceptor
protected Retryer	retryer

Constructor Summary

Constructors

Constructor and Description
BaseBuilder()

Method Summary

Modifier and Type	Method and Description
B	addCapability(Capability capability)
T	build()
B	contract(Contract contract)
B	decode404() Deprecated.
B	decoder(Decoder decoder)
B	decodeVoid()
B	dismiss404() This flag indicates that the decoder should process responses with 404 status, specifically returning null or empty instead of throwing FeignException.
B	doNotCloseAfterDecode() This flag indicates that the response should not be automatically closed upon completion of decoding the message.
B	encoder(Encoder encoder)
B	errorDecoder(ErrorDecoder errorDecoder)
B	exceptionPropagationPolicy(ExceptionPropagationPolicy propagationPolicy)
protected abstract T	internalBuild()
B	invocationHandlerFactory(InvocationHandlerFactory invocationHandlerFactory) Allows you to override how reflective dispatch works inside of Feign.
B	logger(Logger logger)
B	logLevel(Logger.Level logLevel)
B	mapAndDecode(ResponseMapper mapper, Decoder decoder) Allows to map the response before passing it to the decoder.
B	options(Request.Options options)
B	queryMapEncoder(QueryMapEncoder queryMapEncoder)
B	requestInterceptor(RequestInterceptor requestInterceptor) Adds a single request interceptor to the builder.
B	requestInterceptors(Iterable<RequestInterceptor> requestInterceptors) Sets the full set of request interceptors for the builder, overwriting any previous interceptors.
B	responseInterceptor(ResponseInterceptor responseInterceptor) Adds a single response interceptor to the builder.
B	retryer(Retryer retryer)

Methods inherited from class java.lang.Object

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

Field Detail

requestInterceptors

protected final List<RequestInterceptor> requestInterceptors

responseInterceptor

protected ResponseInterceptor responseInterceptor

logLevel

protected Logger.Level logLevel

contract

protected Contract contract

retryer

protected Retryer retryer

logger

protected Logger logger

encoder

protected Encoder encoder

decoder

protected Decoder decoder

closeAfterDecode

protected boolean closeAfterDecode

decodeVoid

protected boolean decodeVoid

queryMapEncoder

protected QueryMapEncoder queryMapEncoder

errorDecoder

protected ErrorDecoder errorDecoder

options

protected Request.Options options

invocationHandlerFactory

protected InvocationHandlerFactory invocationHandlerFactory

dismiss404

protected boolean dismiss404

propagationPolicy

protected ExceptionPropagationPolicy propagationPolicy

capabilities

protected List<Capability> capabilities

Constructor Detail

BaseBuilder

public BaseBuilder()

Method Detail

logLevel

public B logLevel(Logger.Level logLevel)

contract

public B contract(Contract contract)

retryer

public B retryer(Retryer retryer)

logger

public B logger(Logger logger)

encoder

public B encoder(Encoder encoder)

decoder

public B decoder(Decoder decoder)

doNotCloseAfterDecode

public B doNotCloseAfterDecode()

This flag indicates that the response should not be automatically closed upon completion of decoding the message. This should be set if you plan on processing the response into a lazy-evaluated construct, such as a Iterator.

Feign standard decoders do not have built in support for this flag. If you are using this flag, you MUST also use a custom Decoder, and be sure to close all resources appropriately somewhere in the Decoder (you can use Util.ensureClosed(java.io.Closeable) for convenience).

Since:

9.6

decodeVoid

public B decodeVoid()

queryMapEncoder

public B queryMapEncoder(QueryMapEncoder queryMapEncoder)

mapAndDecode

public B mapAndDecode(ResponseMapper mapper,
                      Decoder decoder)

Allows to map the response before passing it to the decoder.

dismiss404

public B dismiss404()

This flag indicates that the decoder should process responses with 404 status, specifically returning null or empty instead of throwing FeignException.

All first-party (ex gson) decoders return well-known empty values defined by Util.emptyValueOf(java.lang.reflect.Type). To customize further, wrap an existing decoder or make your own.

This flag only works with 404, as opposed to all or arbitrary status codes. This was an explicit decision: 404 -> empty is safe, common and doesn't complicate redirection, retry or fallback policy. If your server returns a different status for not-found, correct via a custom client.

Since:

11.9

decode404

@Deprecated
public B decode404()

Deprecated.

This flag indicates that the decoder should process responses with 404 status, specifically returning null or empty instead of throwing FeignException.

All first-party (ex gson) decoders return well-known empty values defined by Util.emptyValueOf(java.lang.reflect.Type). To customize further, wrap an existing decoder or make your own.

This flag only works with 404, as opposed to all or arbitrary status codes. This was an explicit decision: 404 -> empty is safe, common and doesn't complicate redirection, retry or fallback policy. If your server returns a different status for not-found, correct via a custom client.

Since:

8.12

errorDecoder

public B errorDecoder(ErrorDecoder errorDecoder)

options

public B options(Request.Options options)

requestInterceptor

public B requestInterceptor(RequestInterceptor requestInterceptor)

Adds a single request interceptor to the builder.

requestInterceptors

public B requestInterceptors(Iterable<RequestInterceptor> requestInterceptors)

Sets the full set of request interceptors for the builder, overwriting any previous interceptors.

responseInterceptor

public B responseInterceptor(ResponseInterceptor responseInterceptor)

Adds a single response interceptor to the builder.

invocationHandlerFactory

public B invocationHandlerFactory(InvocationHandlerFactory invocationHandlerFactory)

Allows you to override how reflective dispatch works inside of Feign.

exceptionPropagationPolicy

public B exceptionPropagationPolicy(ExceptionPropagationPolicy propagationPolicy)

addCapability

public B addCapability(Capability capability)

build

public final T build()

internalBuild

protected abstract T internalBuild()