A B C D E F H I J L M N O P Q R S T U V

A

addTemplatedParam(Collection<String>, String) - Method in class feign.Contract.BaseContract

append(CharSequence) - Method in class feign.RequestTemplate

appendToFile(String) - Method in class feign.Logger.JavaLogger

helper that configures jul to sanely log messages at FINE level without additional formatting.

apply(RequestTemplate) - Method in class feign.auth.BasicAuthRequestInterceptor

apply(String) - Method in class feign.codec.ErrorDecoder.RetryAfterDecoder

returns a date that corresponds to the first time a request can be retried.

apply(RequestTemplate) - Method in interface feign.RequestInterceptor

Called for every request.

apply(RequestTemplate) - Method in interface feign.Target

Targets a template to this target, adding the base url and any target-specific headers or query parameters.

apply(RequestTemplate) - Method in class feign.Target.EmptyTarget

apply(RequestTemplate) - Method in class feign.Target.HardCodedTarget

asInputStream() - Method in interface feign.Response.Body

It is the responsibility of the caller to close the stream.

asReader() - Method in interface feign.Response.Body

It is the responsibility of the caller to close the stream.

B

BaseContract() - Constructor for class feign.Contract.BaseContract

BasicAuthRequestInterceptor - Class in feign.auth

An interceptor that adds the request header needed to use HTTP basic authentication.

BasicAuthRequestInterceptor(String, String) - Constructor for class feign.auth.BasicAuthRequestInterceptor

Creates an interceptor that authenticates all requests with the specified username and password encoded using ISO-8859-1.

BasicAuthRequestInterceptor(String, String, Charset) - Constructor for class feign.auth.BasicAuthRequestInterceptor

Creates an interceptor that authenticates all requests with the specified username and password encoded using the specified charset.

Body - Annotation Type in feign

A possibly templated body of a PUT or POST command.

body() - Method in class feign.Request

If present, this is the replayable body to send to the server.

body(byte[], Charset) - Method in class feign.RequestTemplate

replaces the Util.CONTENT_LENGTH header.

body(String) - Method in class feign.RequestTemplate

replaces the Util.CONTENT_LENGTH header.

body() - Method in class feign.RequestTemplate

body() - Method in class feign.Response

if present, the response had a body

bodyIndex() - Method in class feign.MethodMetadata

bodyIndex(Integer) - Method in class feign.MethodMetadata

bodyTemplate(String) - Method in class feign.RequestTemplate

populated by Body

bodyTemplate() - Method in class feign.RequestTemplate

bodyType() - Method in class feign.MethodMetadata

Type corresponding to MethodMetadata.bodyIndex().

bodyType(Type) - Method in class feign.MethodMetadata

build() - Method in class feign.Feign.Builder

builder() - Static method in class feign.Feign

Builder() - Constructor for class feign.Feign.Builder

C

charset() - Method in class feign.Request

The character set with which the body is encoded, or null if unknown or not applicable.

charset() - Method in class feign.RequestTemplate

The character set with which the body is encoded, or null if unknown or not applicable.

checkArgument(boolean, String, Object...) - Static method in class feign.Util

Copy of com.google.common.base.Preconditions#checkArgument.

checkNotNull(T, String, Object...) - Static method in class feign.Util

Copy of com.google.common.base.Preconditions#checkNotNull.

checkState(boolean, String, Object...) - Static method in class feign.Util

Copy of com.google.common.base.Preconditions#checkState.

Client - Interface in feign

Submits HTTP requests.

client(Client) - Method in class feign.Feign.Builder

Client.Default - Class in feign

clone() - Method in interface feign.Retryer

clone() - Method in class feign.Retryer.Default

close() - Method in class feign.Response

configKey(Class, Method) - Static method in class feign.Feign

Configuration keys are formatted as unresolved see tags.

configKey(Method) - Static method in class feign.Feign

Deprecated.

use Feign.configKey(Class, Method) instead.

configKey() - Method in class feign.MethodMetadata

configKey(String) - Method in class feign.MethodMetadata

connectTimeoutMillis() - Method in class feign.Request.Options

Defaults to 10 seconds.

CONTENT_ENCODING - Static variable in class feign.Util

The HTTP Content-Encoding header field name.

CONTENT_LENGTH - Static variable in class feign.Util

The HTTP Content-Length header field name.

continueOrPropagate(RetryableException) - Method in interface feign.Retryer

if retry is permitted, return (possibly after sleeping).

continueOrPropagate(RetryableException) - Method in class feign.Retryer.Default

Contract - Interface in feign

Defines what annotations and values are valid on interfaces.

contract(Contract) - Method in class feign.Feign.Builder

Contract.BaseContract - Class in feign

Contract.Default - Class in feign

create(Target, Map<Method, InvocationHandlerFactory.MethodHandler>) - Method in interface feign.InvocationHandlerFactory

create(Target, Map<Method, InvocationHandlerFactory.MethodHandler>) - Method in class feign.InvocationHandlerFactory.Default

create(String, String, Map<String, Collection<String>>, byte[], Charset) - Static method in class feign.Request

No parameters can be null except body and charset.

create(int, String, Map<String, Collection<String>>, InputStream, Integer) - Static method in class feign.Response

create(int, String, Map<String, Collection<String>>, byte[]) - Static method in class feign.Response

create(int, String, Map<String, Collection<String>>, String, Charset) - Static method in class feign.Response

create(int, String, Map<String, Collection<String>>, Response.Body) - Static method in class feign.Response

create(Class<T>) - Static method in class feign.Target.EmptyTarget

create(Class<T>, String) - Static method in class feign.Target.EmptyTarget

currentTimeMillis() - Method in class feign.codec.ErrorDecoder.RetryAfterDecoder

currentTimeMillis() - Method in class feign.Retryer.Default

D

decode(Response, Type) - Method in interface feign.codec.Decoder

Decodes an http response into an object corresponding to its generic return type.

decode(Response, Type) - Method in class feign.codec.Decoder.Default

decode(String, Response) - Method in interface feign.codec.ErrorDecoder

Implement this method in order to decode an HTTP Response when Response.status() is not in the 2xx range.

decode(String, Response) - Method in class feign.codec.ErrorDecoder.Default

decode(Response, Type) - Method in class feign.codec.StringDecoder

decode404() - Method in class feign.Feign.Builder

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

DecodeException - Exception in feign.codec

Similar to javax.websocket.DecodeException, raised when a problem occurs decoding a message.

DecodeException(String) - Constructor for exception feign.codec.DecodeException

DecodeException(String, Throwable) - Constructor for exception feign.codec.DecodeException

Decoder - Interface in feign.codec

Decodes an HTTP response into a single object of the given type.

decoder(Decoder) - Method in class feign.Feign.Builder

Decoder.Default - Class in feign.codec

Default implementation of Decoder.

decodeSlash(boolean) - Method in class feign.RequestTemplate

decodeSlash() - Method in class feign.RequestTemplate

Default(SSLSocketFactory, HostnameVerifier) - Constructor for class feign.Client.Default

Null parameters imply platform defaults.

Default() - Constructor for class feign.codec.Decoder.Default

Default() - Constructor for class feign.codec.Encoder.Default

Default() - Constructor for class feign.codec.ErrorDecoder.Default

Default() - Constructor for class feign.Contract.Default

Default() - Constructor for class feign.InvocationHandlerFactory.Default

Default() - Constructor for class feign.Retryer.Default

Default(long, long, int) - Constructor for class feign.Retryer.Default

E

emptyToNull(String) - Static method in class feign.Util

Adapted from com.google.common.base.Strings#emptyToNull.

emptyValueOf(Type) - Static method in class feign.Util

This returns well known empty values for well-known java types.

encode(Object, Type, RequestTemplate) - Method in class feign.codec.Encoder.Default

encode(Object, Type, RequestTemplate) - Method in interface feign.codec.Encoder

Converts objects to an appropriate representation in the template.

EncodeException - Exception in feign.codec

Similar to javax.websocket.EncodeException, raised when a problem occurs encoding a message.

EncodeException(String) - Constructor for exception feign.codec.EncodeException

EncodeException(String, Throwable) - Constructor for exception feign.codec.EncodeException

Encoder - Interface in feign.codec

Encodes an object into an HTTP request body.

encoder(Encoder) - Method in class feign.Feign.Builder

Encoder.Default - Class in feign.codec

Default implementation of Encoder.

ENCODING_DEFLATE - Static variable in class feign.Util

Value for the Content-Encoding header that indicates that DEFLATE encoding is in use.

ENCODING_GZIP - Static variable in class feign.Util

Value for the Content-Encoding header that indicates that GZIP encoding is in use.

ensureClosed(Closeable) - Static method in class feign.Util

equals(Object) - Method in class feign.Target.EmptyTarget

equals(Object) - Method in class feign.Target.HardCodedTarget

ErrorDecoder - Interface in feign.codec

Allows you to massage an exception into a application-specific one.

errorDecoder(ErrorDecoder) - Method in class feign.Feign.Builder

ErrorDecoder.Default - Class in feign.codec

ErrorDecoder.RetryAfterDecoder - Class in feign.codec

Decodes a Util.RETRY_AFTER header into an absolute date, if possible.

ErrorLogger() - Constructor for class feign.Logger.ErrorLogger

errorStatus(String, Response) - Static method in exception feign.FeignException

execute(Request, Request.Options) - Method in class feign.Client.Default

execute(Request, Request.Options) - Method in interface feign.Client

Executes a request against its url and returns a response.

expand(Object) - Method in interface feign.Param.Expander

Expands the value into a string.

expand(Object) - Method in class feign.Param.ToStringExpander

expand(String, Map<String, ?>) - Static method in class feign.RequestTemplate

Expands a template, such as username, using the variables supplied.

F

feign - package feign

Feign - Class in feign

Feign's purpose is to ease development against http apis that feign restfulness.

Feign() - Constructor for class feign.Feign

feign.auth - package feign.auth

Feign.Builder - Class in feign

feign.codec - package feign.codec

FeignException - Exception in feign

Origin exception type for all Http Apis.

FeignException(String, Throwable) - Constructor for exception feign.FeignException

FeignException(String) - Constructor for exception feign.FeignException

FeignException(int, String) - Constructor for exception feign.FeignException

formParams() - Method in class feign.MethodMetadata

H

HardCodedTarget(Class<T>, String) - Constructor for class feign.Target.HardCodedTarget

HardCodedTarget(Class<T>, String, String) - Constructor for class feign.Target.HardCodedTarget

hashCode() - Method in class feign.Target.EmptyTarget

hashCode() - Method in class feign.Target.HardCodedTarget

header(String, String...) - Method in class feign.RequestTemplate

Replaces headers with the specified configKey with the values supplied.

header(String, Iterable<String>) - Method in class feign.RequestTemplate

HeaderMap - Annotation Type in feign

A template parameter that can be applied to a Map that contains header entries, where the keys are Strings that are the header field names and the values are the header field values.

headerMapIndex() - Method in class feign.MethodMetadata

headerMapIndex(Integer) - Method in class feign.MethodMetadata

Headers - Annotation Type in feign

Expands headers supplied in the value.

headers() - Method in class feign.Request

headers(Map<String, Collection<String>>) - Method in class feign.RequestTemplate

Replaces all existing headers with the newly supplied headers.

headers() - Method in class feign.RequestTemplate

Returns an immutable copy of the current headers.

headers() - Method in class feign.Response

I

indexToExpander(Map<Integer, Param.Expander>) - Method in class feign.MethodMetadata

After MethodMetadata.indexToExpanderClass is populated, this is set by contracts that support runtime injection.

indexToExpander() - Method in class feign.MethodMetadata

When not null, this value will be used instead of MethodMetadata.indexToExpander().

indexToExpanderClass() - Method in class feign.MethodMetadata

If MethodMetadata.indexToExpander is null, classes here will be instantiated by newInstance.

indexToName() - Method in class feign.MethodMetadata

insert(int, CharSequence) - Method in class feign.RequestTemplate

invocationHandlerFactory(InvocationHandlerFactory) - Method in class feign.Feign.Builder

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

InvocationHandlerFactory - Interface in feign

Controls reflective method dispatch.

InvocationHandlerFactory.Default - Class in feign

InvocationHandlerFactory.MethodHandler - Interface in feign

Like InvocationHandler.invoke(Object, java.lang.reflect.Method, Object[]), except for a single method.

invoke(Object[]) - Method in interface feign.InvocationHandlerFactory.MethodHandler

isDefault(Method) - Static method in class feign.Util

Identifies a method as a default instance method.

ISO_8859_1 - Static variable in class feign.Util

ISO-8859-1: ISO Latin Alphabet Number 1 (ISO-LATIN-1).

isRepeatable() - Method in interface feign.Response.Body

True if Response.Body.asInputStream() and Response.Body.asReader() can be called more than once.

J

JavaLogger() - Constructor for class feign.Logger.JavaLogger

L

length() - Method in interface feign.Response.Body

length in bytes, if known.

log(String, String, Object...) - Method in class feign.Logger.ErrorLogger

log(String, String, Object...) - Method in class feign.Logger.JavaLogger

log(String, String, Object...) - Method in class feign.Logger

Override to log requests and responses using your own implementation.

log(String, String, Object...) - Method in class feign.Logger.NoOpLogger

logAndRebufferResponse(String, Logger.Level, Response, long) - Method in class feign.Logger.JavaLogger

logAndRebufferResponse(String, Logger.Level, Response, long) - Method in class feign.Logger

logAndRebufferResponse(String, Logger.Level, Response, long) - Method in class feign.Logger.NoOpLogger

logger(Logger) - Method in class feign.Feign.Builder

Logger - Class in feign

Simple logging abstraction for debug messages.

Logger() - Constructor for class feign.Logger

Logger.ErrorLogger - Class in feign

logs to the category Logger at Level.FINE.

Logger.JavaLogger - Class in feign

logs to the category Logger at Level.FINE, if loggable.

Logger.Level - Enum in feign

Controls the level of logging.

Logger.NoOpLogger - Class in feign

logLevel(Logger.Level) - Method in class feign.Feign.Builder

logRequest(String, Logger.Level, Request) - Method in class feign.Logger.JavaLogger

logRequest(String, Logger.Level, Request) - Method in class feign.Logger

logRequest(String, Logger.Level, Request) - Method in class feign.Logger.NoOpLogger

M

MAP_STRING_WILDCARD - Static variable in interface feign.codec.Encoder

Type literal for Map<String, ?>, indicating the object to encode is a form.

MAP_STRING_WILDCARD - Static variable in class feign.Util

Type literal for Map<String, ?>.

method() - Method in class feign.Request

method(String) - Method in class feign.RequestTemplate

method() - Method in class feign.RequestTemplate

MethodMetadata - Class in feign

methodTag(String) - Static method in class feign.Logger

N

name() - Method in class feign.Target.EmptyTarget

name() - Method in class feign.Target.HardCodedTarget

name() - Method in interface feign.Target

nameParam(MethodMetadata, String, int) - Method in class feign.Contract.BaseContract

links a parameter name to its index in the method signature.

newInstance(Target<T>) - Method in class feign.Feign

Returns a new instance of an HTTP API, defined by annotations in the Contract, for the specified target.

newInstance(Target<T>) - Method in class feign.ReflectiveFeign

creates an api binding to the target.

NoOpLogger() - Constructor for class feign.Logger.NoOpLogger

O

options(Request.Options) - Method in class feign.Feign.Builder

Options(int, int) - Constructor for class feign.Request.Options

Options() - Constructor for class feign.Request.Options

P

Param - Annotation Type in feign

A named template parameter applied to Headers, RequestLine or Body

Param.Expander - Interface in feign

Param.ToStringExpander - Class in feign

parseAndValidatateMetadata(Class<?>) - Method in class feign.Contract.BaseContract

parseAndValidatateMetadata(Method) - Method in class feign.Contract.BaseContract

Deprecated.

use Contract.BaseContract.parseAndValidateMetadata(Class, Method) instead.

parseAndValidatateMetadata(Class<?>) - Method in interface feign.Contract

Called to parse the methods in the class that are linked to HTTP requests.

parseAndValidateMetadata(Class<?>, Method) - Method in class feign.Contract.BaseContract

Called indirectly by Contract.BaseContract.parseAndValidatateMetadata(Class).

processAnnotationOnClass(MethodMetadata, Class<?>) - Method in class feign.Contract.BaseContract

Called by parseAndValidateMetadata twice, first on the declaring class, then on the target type (unless they are the same).

processAnnotationOnClass(MethodMetadata, Class<?>) - Method in class feign.Contract.Default

processAnnotationOnMethod(MethodMetadata, Annotation, Method) - Method in class feign.Contract.BaseContract

processAnnotationOnMethod(MethodMetadata, Annotation, Method) - Method in class feign.Contract.Default

processAnnotationsOnParameter(MethodMetadata, Annotation[], int) - Method in class feign.Contract.BaseContract

processAnnotationsOnParameter(MethodMetadata, Annotation[], int) - Method in class feign.Contract.Default

Q

queries(Map<String, Collection<String>>) - Method in class feign.RequestTemplate

Replaces all existing queries with the newly supplied url decoded queries.

queries() - Method in class feign.RequestTemplate

Returns an immutable copy of the url decoded queries.

query(String, String...) - Method in class feign.RequestTemplate

Replaces queries with the specified name with url decoded values supplied.

query(String, Iterable<String>) - Method in class feign.RequestTemplate

queryLine() - Method in class feign.RequestTemplate

QueryMap - Annotation Type in feign

A template parameter that can be applied to a Map that contains query parameters, where the keys are Strings that are the parameter names and the values are the parameter values.

queryMapIndex() - Method in class feign.MethodMetadata

queryMapIndex(Integer) - Method in class feign.MethodMetadata

R

readTimeoutMillis() - Method in class feign.Request.Options

Defaults to 60 seconds.

reason() - Method in class feign.Response

Nullable and not set when using http/2 See https://github.com/http2/http2-spec/issues/202

ReflectiveFeign - Class in feign

replaceQueryValues(Map<String, ?>) - Method in class feign.RequestTemplate

Replaces query values which are templated with corresponding values from the unencoded map.

Request - Class in feign

An immutable request to an http server.

request() - Method in class feign.RequestTemplate

Request.Options - Class in feign

requestInterceptor(RequestInterceptor) - Method in class feign.Feign.Builder

Adds a single request interceptor to the builder.

RequestInterceptor - Interface in feign

Zero or more RequestInterceptors may be configured for purposes such as adding headers to all requests.

requestInterceptors(Iterable<RequestInterceptor>) - Method in class feign.Feign.Builder

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

RequestLine - Annotation Type in feign

Expands the request-line supplied in the value, permitting path and query variables, or just the http method.

RequestTemplate - Class in feign

Builds a request to an http target.

RequestTemplate() - Constructor for class feign.RequestTemplate

RequestTemplate(RequestTemplate) - Constructor for class feign.RequestTemplate

resolve(Map<String, ?>) - Method in class feign.RequestTemplate

Resolves any template parameters in the requests path, query, or headers against the supplied unencoded arguments.

resolveLastTypeParameter(Type, Class<?>) - Static method in class feign.Util

Resolves the last type parameter of the parameterized supertype, based on the genericContext, into its upper bounds.

Response - Class in feign

An immutable response to an http invocation which only returns string content.

Response.Body - Interface in feign

RETRY_AFTER - Static variable in class feign.Util

The HTTP Retry-After header field name.

RetryableException - Exception in feign

This exception is raised when the Response is deemed to be retryable, typically via an ErrorDecoder when the status is 503.

RetryableException(String, Throwable, Date) - Constructor for exception feign.RetryableException

RetryableException(String, Date) - Constructor for exception feign.RetryableException

retryAfter() - Method in exception feign.RetryableException

Sometimes corresponds to the Util.RETRY_AFTER header present in 503 status.

retryer(Retryer) - Method in class feign.Feign.Builder

Retryer - Interface in feign

Cloned for each invocation to Client.execute(Request, feign.Request.Options).

Retryer.Default - Class in feign

returnType() - Method in class feign.MethodMetadata

returnType(Type) - Method in class feign.MethodMetadata

S

status() - Method in exception feign.FeignException

status() - Method in class feign.Response

status code.

StringDecoder - Class in feign.codec

StringDecoder() - Constructor for class feign.codec.StringDecoder

T

target(Class<T>, String) - Method in class feign.Feign.Builder

target(Target<T>) - Method in class feign.Feign.Builder

Target<T> - Interface in feign

relationship to JAXRS 2.0

Similar to javax.ws.rs.client.WebTarget, as it produces requests.

Target.EmptyTarget<T> - Class in feign

Target.HardCodedTarget<T> - Class in feign

template() - Method in class feign.MethodMetadata

toArray(Iterable<? extends T>, Class<T>) - Static method in class feign.Util

Adapted from com.google.common.base.Strings#emptyToNull.

toByteArray(InputStream) - Static method in class feign.Util

Adapted from com.google.common.io.ByteStreams.toByteArray().

toString() - Method in class feign.Request

toString() - Method in class feign.RequestTemplate

toString() - Method in class feign.Response

toString() - Method in class feign.Target.EmptyTarget

toString() - Method in class feign.Target.HardCodedTarget

toString(Reader) - Static method in class feign.Util

Adapted from com.google.common.io.CharStreams.toString().

ToStringExpander() - Constructor for class feign.Param.ToStringExpander

type() - Method in class feign.Target.EmptyTarget

type() - Method in class feign.Target.HardCodedTarget

type() - Method in interface feign.Target

U

url() - Method in class feign.Request

url() - Method in class feign.RequestTemplate

url() - Method in class feign.Target.EmptyTarget

url() - Method in class feign.Target.HardCodedTarget

url() - Method in interface feign.Target

urlIndex() - Method in class feign.MethodMetadata

urlIndex(Integer) - Method in class feign.MethodMetadata

UTF_8 - Static variable in class feign.Util

UTF-8: eight-bit UCS Transformation Format.

Util - Class in feign

Utilities, typically copied in from guava, so as to avoid dependency conflicts.

V

valueOf(String) - Static method in enum feign.Logger.Level

Returns the enum constant of this type with the specified name.

values() - Static method in enum feign.Logger.Level

Returns an array containing the constants of this enum type, in the order they are declared.

valuesOrEmpty(Map<String, Collection<T>>, String) - Static method in class feign.Util

Returns an unmodifiable collection which may be empty, but is never null.

A B C D E F H I J L M N O P Q R S T U V