A B C D E F G H I J L M N O P Q R S T U V
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- allowUnresolved() - Method in class feign.template.Template
- append(HeaderTemplate, Iterable<String>) - Static method in class feign.template.HeaderTemplate
-
Append values to a Header Template.
- append(QueryTemplate, Iterable<String>, CollectionFormat) - Static method in class feign.template.QueryTemplate
-
Append a value to the Query Template.
- append(UriTemplate, String) - Static method in class feign.template.UriTemplate
-
Append a uri fragment to the template.
- append(CharSequence) - Method in class feign.RequestTemplate
-
Deprecated.
- appendToFile(String) - Method in class feign.Logger.JavaLogger
-
Helper that configures java.util.logging to sanely log messages at FINE level without additional formatting.
- apply(RequestTemplate) - Method in class feign.auth.BasicAuthRequestInterceptor
- 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
- apply(String) - Method in class feign.codec.ErrorDecoder.RetryAfterDecoder
-
returns a date that corresponds to the first time a request can be retried.
- asBytes() - Method in class feign.Request.Body
- 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.
- asReader(Charset) - Method in interface feign.Response.Body
- asString() - Method in class feign.Request.Body
B
- BaseContract() - Constructor for class feign.Contract.BaseContract
- BASIC - feign.Logger.Level
-
Log only the request method and URL and the response status code and execution time.
- 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.
- BeanQueryMapEncoder - Class in feign.querymap
-
the query map will be generated using java beans accessible getter property as query parameter names.
- BeanQueryMapEncoder() - Constructor for class feign.querymap.BeanQueryMapEncoder
- body() - Method in class feign.Request
-
Deprecated.use
Request.requestBody()
instead - body() - Method in class feign.RequestTemplate
-
Deprecated.replaced by
RequestTemplate.requestBody()
- body() - Method in class feign.Response
-
if present, the response had a body
- body(byte[]) - Method in class feign.Response.Builder
- body(byte[], Charset) - Method in class feign.RequestTemplate
-
Deprecated.use
RequestTemplate.body(feign.Request.Body)
instead - body(Request.Body) - Method in class feign.RequestTemplate
-
Set the Body for this request.
- body(Response.Body) - Method in class feign.Response.Builder
- body(InputStream, Integer) - Method in class feign.Response.Builder
- body(String) - Method in class feign.RequestTemplate
-
Deprecated.use
RequestTemplate.body(feign.Request.Body)
instead - body(String, Charset) - Method in class feign.Response.Builder
- Body - Annotation Type in feign
-
A possibly templated body of a PUT or POST command.
- bodyIndex() - Method in class feign.MethodMetadata
- bodyIndex(Integer) - Method in class feign.MethodMetadata
- bodyTemplate() - Method in class feign.Request.Body
- bodyTemplate() - Method in class feign.RequestTemplate
-
Body Template to resolve.
- bodyTemplate(String) - Method in class feign.RequestTemplate
-
Deprecated.replaced by
RequestTemplate.body(feign.Request.Body)
- bodyTemplate(String, Charset) - Static method in class feign.Request.Body
- BodyTemplate - Class in feign.template
-
Template for @
Body
annotated Templates. - 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
- build() - Method in class feign.Response.Builder
- builder() - Static method in class feign.Feign
- builder() - Static method in class feign.Response
- Builder() - Constructor for class feign.Feign.Builder
C
- charset() - Method in class feign.Request
-
Deprecated.use
Request.requestBody()
instead - 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(Client) - Method in class feign.Feign.Builder
- Client - Interface in feign
-
Submits HTTP
requests
. - Client.Default - Class in feign
- clone() - Method in interface feign.Retryer
- clone() - Method in class feign.Retryer.Default
- close() - Method in class feign.Response
- collectionFormat() - Method in annotation type feign.RequestLine
- collectionFormat() - Method in class feign.RequestTemplate
-
The Collection Format that will be used when resolving
Iterable
andCollection
variables. - collectionFormat(CollectionFormat) - Method in class feign.RequestTemplate
-
The Collection Format to use when resolving variables that represent
Iterable
s orCollection
s - CollectionFormat - Enum in feign
-
Various ways to encode collections in URL parameters.
- configKey() - Method in class feign.MethodMetadata
-
Used as a reference to this method.
- 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(String) - Method in class feign.MethodMetadata
- CONNECT - feign.Request.HttpMethod
- connectTimeoutMillis() - Method in class feign.Request.Options
-
Defaults to 10 seconds.
- content() - Method in exception feign.FeignException
- 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.
- contentUTF8() - Method in exception feign.FeignException
- continueOrPropagate(RetryableException) - Method in interface feign.Retryer
-
if retry is permitted, return (possibly after sleeping).
- continueOrPropagate(RetryableException) - Method in class feign.Retryer.Default
- contract(Contract) - Method in class feign.Feign.Builder
- Contract - Interface in feign
-
Defines what annotations and values are valid on interfaces.
- Contract.BaseContract - Class in feign
- Contract.Default - Class in feign
- create(Decoder) - Static method in class feign.stream.StreamDecoder
- create(Request.HttpMethod, String, Map<String, Collection<String>>, byte[], Charset) - Static method in class feign.Request
-
Builds a Request.
- create(Request.HttpMethod, String, Map<String, Collection<String>>, Request.Body) - Static method in class feign.Request
-
Builds a Request.
- create(Target, Map<Method, InvocationHandlerFactory.MethodHandler>) - Method in interface feign.InvocationHandlerFactory
- create(Target, Map<Method, InvocationHandlerFactory.MethodHandler>) - Method in class feign.InvocationHandlerFactory.Default
- create(Class<T>) - Static method in class feign.Target.EmptyTarget
- create(Class<T>, String) - Static method in class feign.Target.EmptyTarget
- create(String) - Static method in class feign.template.BodyTemplate
-
Create a new Body Template.
- create(String) - Static method in class feign.template.Expressions
- create(String, boolean, Charset) - Static method in class feign.template.UriTemplate
-
Create a Uri Template.
- create(String, Iterable<String>) - Static method in class feign.template.HeaderTemplate
- create(String, Iterable<String>, Charset) - Static method in class feign.template.QueryTemplate
-
Create a new Query Template.
- create(String, Iterable<String>, Charset, CollectionFormat) - Static method in class feign.template.QueryTemplate
-
Create a new Query Template.
- create(String, String, Map<String, Collection<String>>, byte[], Charset) - Static method in class feign.Request
- create(String, Charset) - Static method in class feign.template.UriTemplate
-
Create a Uri Template.
- CSV - feign.CollectionFormat
-
Comma separated values, eg foo=bar,baz
- 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(Response, Type) - Method in class feign.codec.StringDecoder
- decode(Response, Type) - Method in class feign.optionals.OptionalDecoder
- decode(Response, Type) - Method in class feign.stream.StreamDecoder
- decode(String, Response) - Method in interface feign.codec.ErrorDecoder
-
Implement this method in order to decode an HTTP
Response
whenResponse.status()
is not in the 2xx range. - decode(String, Response) - Method in class feign.codec.ErrorDecoder.Default
- decode(String, Charset) - Static method in class feign.template.UriUtils
-
Uri Decode the value.
- 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 throwingFeignException
. - 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
- decodeOrDefault(byte[], Charset, String) - Static method in class feign.Util
- decoder(Decoder) - Method in class feign.Feign.Builder
- Decoder - Interface in feign.codec
-
Decodes an HTTP response into a single object of the given
type
. - Decoder.Default - Class in feign.codec
-
Default implementation of
Decoder
. - decodeSlash() - Method in annotation type feign.RequestLine
- decodeSlash() - Method in class feign.RequestTemplate
-
If slash / characters are not encoded when resolving.
- decodeSlash(boolean) - Method in class feign.RequestTemplate
-
Set whether do encode slash / characters when resolving this template.
- 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.QueryMapEncoder.Default
-
Deprecated.
- Default() - Constructor for class feign.Retryer.Default
- Default(long, long, int) - Constructor for class feign.Retryer.Default
- Default(SSLSocketFactory, HostnameVerifier) - Constructor for class feign.Client.Default
-
Null parameters imply platform defaults.
- DELETE - feign.Request.HttpMethod
- doNotCloseAfterDecode() - Method in class feign.Feign.Builder
-
This flag indicates that the response should not be automatically closed upon completion of decoding the message.
E
- empty() - Static method in class feign.Request.Body
- 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() - Method in class feign.template.Template
- encode(Object) - Method in class feign.querymap.BeanQueryMapEncoder
- encode(Object) - Method in class feign.querymap.FieldQueryMapEncoder
- encode(Object) - Method in interface feign.QueryMapEncoder
-
Encodes the given object into a query map.
- 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.
- encode(String) - Static method in class feign.template.UriUtils
-
Uri Encode the value, using the default Charset.
- encode(String, Charset) - Static method in class feign.template.UriUtils
-
Uri Encode the value.
- encoded() - Method in annotation type feign.Param
-
Specifies whether argument is already encoded The value is ignored for headers (headers are never encoded)
- encoded() - Method in annotation type feign.QueryMap
-
Specifies whether parameter names and values are already encoded.
- encoded(byte[], Charset) - Static method in class feign.Request.Body
- 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(Encoder) - Method in class feign.Feign.Builder
- Encoder - Interface in feign.codec
-
Encodes an object into an HTTP request body.
- Encoder.Default - Class in feign.codec
-
Default implementation of
Encoder
. - encodeReserved(String, String, Charset) - Static method in class feign.template.UriUtils
-
Encodes the value, preserving all reserved characters..
- encodeSlash() - Method in class feign.template.Template
- 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(ErrorDecoder) - Method in class feign.Feign.Builder
- ErrorDecoder - Interface in feign.codec
-
Allows you to massage an exception into a application-specific one.
- 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
- exceptionPropagationPolicy(ExceptionPropagationPolicy) - Method in class feign.Feign.Builder
- ExceptionPropagationPolicy - Enum in feign
- 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(Map<String, ?>) - Method in class feign.Request.Body
- expand(Map<String, ?>) - Method in class feign.template.BodyTemplate
- expand(Map<String, ?>) - Method in class feign.template.QueryTemplate
-
Expand this template.
- expand(Map<String, ?>) - Method in class feign.template.Template
-
Expand the template.
- expander() - Method in annotation type feign.Param
-
How to expand the value of this parameter, if
Param.ToStringExpander
isn't adequate. - EXPLODED - feign.CollectionFormat
-
Parameter name repeated for each value, eg foo=bar&foo=baz
- Expressions - Class in feign.template
- Expressions() - Constructor for class feign.template.Expressions
- Expressions.ReservedExpression - Class in feign.template
-
Expression that does not encode reserved characters.
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
- feign.optionals - package feign.optionals
- feign.querymap - package feign.querymap
- feign.stream - package feign.stream
- feign.template - package feign.template
- FeignException - Exception in feign
-
Origin exception type for all Http Apis.
- FeignException(int, String, byte[]) - Constructor for exception feign.FeignException
- FeignException(String) - Constructor for exception feign.FeignException
- FeignException(String, Throwable) - Constructor for exception feign.FeignException
- FeignException(String, Throwable, byte[]) - Constructor for exception feign.FeignException
- FieldQueryMapEncoder - Class in feign.querymap
-
the query map will be generated using member variable names as query parameter names.
- FieldQueryMapEncoder() - Constructor for class feign.querymap.FieldQueryMapEncoder
- formParams() - Method in class feign.MethodMetadata
- from(RequestTemplate) - Static method in class feign.RequestTemplate
-
Create a Request Template from an existing Request Template.
- FULL - feign.Logger.Level
-
Log the headers, body, and metadata for both requests and responses.
G
- GET - feign.Request.HttpMethod
- getCharset() - Method in class feign.template.Template
-
The Charset for the template.
- getLiterals() - Method in class feign.template.Template
-
List of all Literals in the Template.
- getName() - Method in class feign.template.HeaderTemplate
- getName() - Method in class feign.template.QueryTemplate
- getRawType(Type) - Static method in class feign.Types
- getRequestVariables() - Method in class feign.RequestTemplate
-
Retrieve all uri, header, and query template variables.
- getValues() - Method in class feign.template.HeaderTemplate
- getValues() - Method in class feign.template.QueryTemplate
- getVariables() - Method in class feign.Request.Body
- getVariables() - Method in class feign.template.Template
-
Variable names contained in the template.
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
- hasRequestVariable(String) - Method in class feign.RequestTemplate
-
Return if the variable exists on the uri, query, or headers, in this template.
- HEAD - feign.Request.HttpMethod
- header(String, Iterable<String>) - Method in class feign.RequestTemplate
-
Specify a Header, with the specified values.
- header(String, 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() - Method in class feign.Request
- headers() - Method in class feign.RequestTemplate
-
Returns an immutable copy of the Headers for this request.
- headers() - Method in class feign.Response
-
Returns a case-insensitive mapping of header names to their values.
- headers(Map<String, Collection<String>>) - Method in class feign.RequestTemplate
-
Headers for this Request.
- headers(Map<String, Collection<String>>) - Method in class feign.Response.Builder
- Headers - Annotation Type in feign
-
Expands headers supplied in the
value
. - HEADERS - feign.Logger.Level
-
Log the basic information along with request and response headers.
- HeaderTemplate - Class in feign.template
-
Template for HTTP Headers.
- httpMethod() - Method in class feign.Request
-
Http Method for the request.
I
- indexToEncoded() - Method in class feign.MethodMetadata
- indexToExpander() - Method in class feign.MethodMetadata
-
When not null, this value will be used instead of
MethodMetadata.indexToExpander()
. - indexToExpander(Map<Integer, Param.Expander>) - Method in class feign.MethodMetadata
-
After
MethodMetadata.indexToExpanderClass
is populated, this is set by contracts that support runtime injection. - 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
-
Deprecated.
- 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
- isAbsolute(String) - Static method in class feign.template.UriUtils
-
Determines if the provided uri is an absolute uri.
- isBlank(String) - Static method in class feign.Util
-
If the provided String is null or empty.
- isDefault(Method) - Static method in class feign.Util
-
Identifies a method as a default instance method.
- isEncoded(String) - Static method in class feign.template.UriUtils
-
Determines if the value is already pct-encoded.
- isFollowRedirects() - Method in class feign.Request.Options
-
Defaults to true.
- isLiteral() - Method in class feign.template.Template
-
Flag to indicate that this template is a literal string, with no variable expressions.
- isNotBlank(String) - Static method in class feign.Util
-
If the provided String is not null or empty.
- 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()
andResponse.Body.asReader()
can be called more than once.
J
- JavaLogger() - Constructor for class feign.Logger.JavaLogger
- join(String, Collection<String>, Charset) - Method in enum feign.CollectionFormat
-
Joins the field and possibly multiple values with the given separator.
L
- length() - Method in class feign.Request.Body
- 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 System.err.
- Logger.JavaLogger - Class in feign
-
Logs to the category
Logger
atLevel.FINE
, if loggable. - Logger.Level - Enum in feign
-
Controls the level of logging.
- Logger.NoOpLogger - Class in feign
- logIOException(String, Logger.Level, IOException, long) - Method in class feign.Logger
- 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
- logRetry(String, Logger.Level) - Method in class feign.Logger
M
- map(Response, Type) - Method in interface feign.ResponseMapper
- 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, ?>
. - mapAndDecode(ResponseMapper, Decoder) - Method in class feign.Feign.Builder
-
Allows to map the response before passing it to the decoder.
- method() - Method in class feign.Request
-
Deprecated.
- method() - Method in class feign.RequestTemplate
-
The Request Http Method.
- method() - Method in exception feign.RetryableException
- method(Request.HttpMethod) - Method in class feign.RequestTemplate
-
Set the Http Method.
- method(String) - Method in class feign.RequestTemplate
-
Deprecated.
- 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.
- NEVER_RETRY - Static variable in interface feign.Retryer
-
Implementation that never retries request.
- newInstance(Target<T>) - Method in class feign.Feign
-
Returns a new instance of an HTTP API, defined by annotations in the
Contract
, for the specifiedtarget
. - newInstance(Target<T>) - Method in class feign.ReflectiveFeign
-
creates an api binding to the
target
. - NONE - feign.ExceptionPropagationPolicy
- NONE - feign.Logger.Level
-
No logging.
- NoOpLogger() - Constructor for class feign.Logger.NoOpLogger
O
- OptionalDecoder - Class in feign.optionals
- OptionalDecoder(Decoder) - Constructor for class feign.optionals.OptionalDecoder
- options(Request.Options) - Method in class feign.Feign.Builder
- Options() - Constructor for class feign.Request.Options
- Options(int, int) - Constructor for class feign.Request.Options
- Options(int, int, boolean) - Constructor for class feign.Request.Options
- OPTIONS - feign.Request.HttpMethod
P
- Param - Annotation Type in feign
- Param.Expander - Interface in feign
- Param.ToStringExpander - Class in feign
- parseAndValidatateMetadata(Class<?>) - Method in class feign.Contract.BaseContract
- parseAndValidatateMetadata(Class<?>) - Method in interface feign.Contract
-
Called to parse the methods in the class that are linked to HTTP requests.
- parseAndValidatateMetadata(Method) - Method in class feign.Contract.BaseContract
-
Deprecated.
- parseAndValidateMetadata(Class<?>, Method) - Method in class feign.Contract.BaseContract
-
Called indirectly by
Contract.BaseContract.parseAndValidatateMetadata(Class)
. - PATCH - feign.Request.HttpMethod
- path() - Method in class feign.RequestTemplate
-
The Uri Path.
- pathEncode(String, Charset) - Static method in class feign.template.UriUtils
-
Uri Encode a Path Fragment.
- PIPES - feign.CollectionFormat
-
Values separated with the pipe (|) character, eg foo=bar|baz
- POST - feign.Request.HttpMethod
- 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
- PUT - feign.Request.HttpMethod
Q
- queries() - Method in class feign.RequestTemplate
-
Return an immutable Map of all Query Parameters and their values.
- queries(Map<String, Collection<String>>) - Method in class feign.RequestTemplate
-
Sets the Query Parameters.
- query(String, Iterable<String>) - Method in class feign.RequestTemplate
-
Specify a Query String parameter, with the specified values.
- query(String, String...) - Method in class feign.RequestTemplate
- queryEncode(String, Charset) - Static method in class feign.template.UriUtils
-
Uri Encode a Query Fragment.
- queryLine() - Method in class feign.RequestTemplate
-
The Query String for the template.
- 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.
- queryMapEncoded() - Method in class feign.MethodMetadata
- queryMapEncoded(boolean) - Method in class feign.MethodMetadata
- queryMapEncoder(QueryMapEncoder) - Method in class feign.Feign.Builder
- QueryMapEncoder - Interface in feign
-
A QueryMapEncoder encodes Objects into maps of query parameter names to values.
- QueryMapEncoder.Default - Class in feign
-
Deprecated.use
BeanQueryMapEncoder
instead. default encoder uses reflection to inspect provided objects Fields to expand the objects values into a query string. If you prefer that the query string be built using getter and setter methods, as defined in the Java Beans API, please use theBeanQueryMapEncoder
- queryMapIndex() - Method in class feign.MethodMetadata
- queryMapIndex(Integer) - Method in class feign.MethodMetadata
- QueryTemplate - Class in feign.template
-
Template for a Query String parameter.
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
- reason(String) - Method in class feign.Response.Builder
- ReflectiveFeign - Class in feign
- removeValues(T[], Predicate<T>, Class<T>) - Static method in class feign.Util
-
Removes values from the array that meet the criteria for removal via the supplied
Predicate
value - request() - Method in class feign.RequestTemplate
-
Creates a
Request
from this template. - request() - Method in class feign.Response
-
the request that generated this response
- request(Request) - Method in class feign.Response.Builder
- Request - Class in feign
-
An immutable request to an http server.
- Request.Body - Class in feign
- Request.HttpMethod - Enum in feign
- Request.Options - Class in feign
- requestBody() - Method in class feign.Request
- requestBody() - Method in class feign.RequestTemplate
- requestCharset() - Method in class feign.RequestTemplate
-
Charset of the Request Body, if known.
- 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 uri template supplied in the
value
, permitting path and query variables, or just the http method. - RequestTemplate - Class in feign
-
Request Builder for an HTTP Target.
- RequestTemplate() - Constructor for class feign.RequestTemplate
-
Create a new Request Template.
- RequestTemplate(RequestTemplate) - Constructor for class feign.RequestTemplate
-
Deprecated.replaced by
RequestTemplate.from(RequestTemplate)
- resolve(Map<String, ?>) - Method in class feign.RequestTemplate
-
Resolve all expressions using the variable value substitutions provided.
- resolved() - Method in class feign.RequestTemplate
-
If this template has been resolved.
- resolveLastTypeParameter(Type, Class<?>) - Static method in class feign.Util
-
Resolves the last type parameter of the parameterized
supertype
, based on thegenericContext
, 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
- Response.Builder - Class in feign
- ResponseMapper - Interface in feign
-
Map function to apply to the response before decoding it.
- 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 anErrorDecoder
when thestatus
is 503. - RetryableException(String, Request.HttpMethod, Throwable, Date) - Constructor for exception feign.RetryableException
- RetryableException(String, Request.HttpMethod, Date) - Constructor for exception feign.RetryableException
- retryAfter() - Method in exception feign.RetryableException
-
Sometimes corresponds to the
Util.RETRY_AFTER
header present in503
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
- SSV - feign.CollectionFormat
-
Space separated values, eg foo=bar baz
- status() - Method in exception feign.FeignException
- status() - Method in class feign.Response
-
status code.
- status(int) - Method in class feign.Response.Builder
- StreamDecoder - Class in feign.stream
-
Iterator based decoder that support streaming.
- StringDecoder - Class in feign.codec
- StringDecoder() - Constructor for class feign.codec.StringDecoder
T
- target(Target<T>) - Method in class feign.Feign.Builder
- target(Class<T>, String) - Method in class feign.Feign.Builder
- target(String) - Method in class feign.RequestTemplate
-
Set the target host for this request.
- Target<T> - Interface in feign
-
relationship to JAXRS 2.0
Similar tojavax.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
- Template - Class in feign.template
-
A Generic representation of a Template Expression as defined by RFC 6570, with some relaxed rules, allowing the concept to be used in areas outside of the uri.
- toArray(Iterable<? extends T>, Class<T>) - Static method in class feign.Util
-
Adapted from
com.google.common.base.Strings#emptyToNull
. - toBuilder() - Method in class feign.Response
- 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() - Method in class feign.template.QueryTemplate
- toString() - Method in class feign.template.Template
- toString(Reader) - Static method in class feign.Util
-
Adapted from
com.google.common.io.CharStreams.toString()
. - ToStringExpander() - Constructor for class feign.Param.ToStringExpander
- TRACE - feign.Request.HttpMethod
- TSV - feign.CollectionFormat
-
Tab separated values, eg foo=bar[tab]baz
- type() - Method in class feign.Target.EmptyTarget
- type() - Method in class feign.Target.HardCodedTarget
- type() - Method in interface feign.Target
- Types - Class in feign
-
Static methods for working with types.
U
- UNWRAP - feign.ExceptionPropagationPolicy
- uri(String) - Method in class feign.RequestTemplate
-
Set the Uri for the request, replacing the existing uri if set.
- uri(String, boolean) - Method in class feign.RequestTemplate
-
Set the uri for the request.
- UriTemplate - Class in feign.template
- UriUtils - Class in feign.template
- UriUtils() - Constructor for class feign.template.UriUtils
- url() - Method in class feign.Request
- url() - Method in class feign.RequestTemplate
-
The URL for the request.
- 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
- value() - Method in annotation type feign.Body
- value() - Method in annotation type feign.Headers
- value() - Method in annotation type feign.Param
-
The name of the template parameter.
- value() - Method in annotation type feign.RequestLine
- valueOf(String) - Static method in enum feign.CollectionFormat
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum feign.ExceptionPropagationPolicy
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum feign.Logger.Level
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum feign.Request.HttpMethod
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum feign.CollectionFormat
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum feign.ExceptionPropagationPolicy
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum feign.Logger.Level
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum feign.Request.HttpMethod
-
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.
- variables() - Method in class feign.RequestTemplate
-
List all of the template variable expressions for this template.
All Classes All Packages