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

A

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

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(String) - Method in interface feign.codec.Decoders.ApplyFirstGroup

create a new instance from the non-null firstGroup specified.

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.Target

Targets a template to this target, adding the base url and any authentication headers.

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

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

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

B

Body - Annotation Type in feign

A possibly templated body of a PUT or POST command.

body() - Method in class feign.Request

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

bodyTemplate(String) - Method in class feign.RequestTemplate

populated by Body

bodyTemplate() - Method in class feign.RequestTemplate

bodyType() - Method in class feign.MethodMetadata

C

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.Default - Class in feign

Client.Default(Lazy<SSLSocketFactory>) - Constructor for class feign.Client.Default

close() - Method in class feign.Feign

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

Configuration keys are formatted as unresolved see tags.

configKey() - Method in class feign.MethodMetadata

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

Defaults to 10 seconds.

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 - Class in feign

Defines what annotations and values are valid on interfaces.

Contract() - Constructor for class feign.Contract

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

create(Target<T>, Object...) - Static method in class feign.Feign

Shortcut to create a single targeted http api using reflection.

create(Object...) - Static method in class feign.Feign

Returns a reflective factory for generating targeted http apis.

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

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

createObjectGraph(Object...) - Static method in class feign.Feign

Returns an Dagger ObjectGraph that can inject a reflective Feign.

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

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

D

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

Implement this to decode a resource to an object into a single object.

decode(Reader, Type) - Method in class feign.codec.Decoders.TransformEachFirstGroup

decode(Reader, Type) - Method in class feign.codec.Decoders.TransformFirstGroup

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(I, Type, IncrementalCallback<? super T>) - Method in interface feign.codec.IncrementalDecoder

Implement this to decode a resource to an object into a single object.

decode(Reader, Type) - Method in class feign.codec.SAXDecoder

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

decode(Reader, Type, IncrementalCallback<? super String>) - Method in class feign.codec.StringIncrementalDecoder

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

decodeInto() - Method in class feign.MethodMetadata

Method return type unless there is an IncrementalCallback arg.

Decoder<I,T> - Interface in feign.codec

Decodes an HTTP response into a given type.

Decoder.TextStream<T> - Interface in feign.codec

Used for text-based apis, follows Decoder.decode(Object, java.lang.reflect.Type) semantics, applied to inputs of type Reader.

Decoders - Class in feign.codec

Static utility methods pertaining to Decoder instances.

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

Decoders.ApplyFirstGroup<T> - Interface in feign.codec

guava users will implement this with ApplyFirstGroup<String, T>.

Decoders.TransformEachFirstGroup<T> - Class in feign.codec

On the each find the first match group is applied to applyFirstGroup and added to the list returned.

Decoders.TransformEachFirstGroup(String, Decoders.ApplyFirstGroup<T>) - Constructor for class feign.codec.Decoders.TransformEachFirstGroup

You must subclass this, in order to prevent type erasure on T .

Decoders.TransformFirstGroup<T> - Class in feign.codec

The first match group is applied to applyGroups and result returned.

Decoders.TransformFirstGroup(String, Decoders.ApplyFirstGroup<T>) - Constructor for class feign.codec.Decoders.TransformFirstGroup

You must subclass this, in order to prevent type erasure on T .

E

eachFirstGroup(String) - Static method in class feign.codec.Decoders

shortcut for

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

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

encode(T) - Method in interface feign.codec.Encoder.Text

Implement this to encode an object as a String..

EncodeException - Exception in feign.codec

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

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

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

Encoder<T> - Interface in feign.codec

Encodes an object into an HTTP request body.

Encoder.Text<T> - Interface in feign.codec

Converts objects to an appropriate text representation.

ensureClosed(Response.Body) - Static method in class feign.Util

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.Default - Class in feign.codec

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

ErrorDecoder.RetryAfterDecoder - Class in feign.codec

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

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(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.codec - package feign.codec

Feign.Defaults - Class in feign

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

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

firstGroup(String) - Static method in class feign.codec.Decoders

shortcut for

formParams() - Method in class feign.MethodMetadata

H

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

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

IncrementalCallback<T> - Interface in feign

Communicates results as they are decoded from an http response body.

incrementalCallbackIndex() - Method in class feign.MethodMetadata

IncrementalDecoder<I,T> - Interface in feign.codec

Decodes an HTTP response incrementally into an IncrementalCallback via a series of onNext calls.

IncrementalDecoder.TextStream<T> - Interface in feign.codec

Used for text-based apis, follows IncrementalDecoder.decode(Object, java.lang.reflect.Type, IncrementalCallback) semantics, applied to inputs of type Reader.

indexToName() - Method in class feign.MethodMetadata

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

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

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

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

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.ErrorLogger() - Constructor for class feign.Logger.ErrorLogger

Logger.JavaLogger - Class in feign

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

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

Logger.Level - Enum in feign

Controls the level of logging.

Logger.NoOpLogger - Class in feign

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

M

method() - Method in class feign.Request

method(String) - Method in class feign.RequestTemplate

method() - Method in class feign.RequestTemplate

MethodMetadata - Class in feign

N

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

name() - Method in interface feign.Target

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

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.

O

onFailure(Throwable) - Method in interface feign.IncrementalCallback

Called when response processing failed for any reason.

onNext(T) - Method in interface feign.IncrementalCallback

Invoked as soon as new data is available.

onSuccess() - Method in interface feign.IncrementalCallback

Called when response processing completed successfully.

P

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

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

parseAndValidatateMetadata(Method) - Method in class feign.Contract

Called indirectly by Contract.parseAndValidatateMetadata(Class).

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

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

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 configKey with url decoded values supplied.

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

queryLine() - Method in class feign.RequestTemplate

R

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

Defaults to 60 seconds.

reason() - Method in class feign.Response

ReflectiveFeign - Class in feign

ReflectiveFeign.Module - Class in feign

ReflectiveFeign.Module() - Constructor for class feign.ReflectiveFeign.Module

Request - Class in feign

An immutable request to an http server.

request() - Method in class feign.RequestTemplate

Request.Options - Class in feign

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

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

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

Targets a template to this target, adding the base url and any authentication headers.

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

result() - Method in interface feign.codec.SAXDecoder.ContentHandlerWithResult

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 - Interface in feign

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

Retryer.Default - Class in feign

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

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

S

SAXDecoder<T> - Class in feign.codec

SAXDecoder(Provider<? extends SAXDecoder.ContentHandlerWithResult<T>>) - Constructor for class feign.codec.SAXDecoder

You must subclass this, in order to prevent type erasure on T.

SAXDecoder.ContentHandlerWithResult<T> - Interface in feign.codec

status() - Method in class feign.Response

status code.

StringDecoder - Class in feign.codec

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

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

StringIncrementalDecoder - Class in feign.codec

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

T

Target<T> - Interface in feign

relationship to JAXRS 2.0

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

Target.HardCodedTarget<T> - Class in feign

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

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

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.

toString() - Method in class feign.codec.Decoders.TransformEachFirstGroup

toString() - Method in class feign.codec.Decoders.TransformFirstGroup

toString() - Method in class feign.Request

toString() - Method in class feign.RequestTemplate

toString() - Method in class feign.Response

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.HardCodedTarget

url() - Method in interface feign.Target

urlIndex() - 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 L M N O P Q R S T U V