Interface | Description |
---|---|
AsyncClient<C> |
Submits HTTP
requests asynchronously, with an optional context. |
Capability |
Capabilities expose core feign artifacts to implementations so parts of core can be customized
around the time the client being built.
|
Client |
Submits HTTP
requests . |
Contract |
Defines what annotations and values are valid on interfaces.
|
DeclarativeContract.AnnotationProcessor<E extends Annotation> | |
DeclarativeContract.ParameterAnnotationProcessor<E extends Annotation> | |
InvocationHandlerFactory |
Controls reflective method dispatch.
|
InvocationHandlerFactory.MethodHandler |
Like
InvocationHandler.invoke(Object, java.lang.reflect.Method, Object[]) , except for a
single method. |
Param.Expander | |
QueryMapEncoder |
A QueryMapEncoder encodes Objects into maps of query parameter names to values.
|
RequestInterceptor |
Zero or more
RequestInterceptors may be configured for purposes such as adding headers to
all requests. |
Response.Body | |
ResponseMapper |
Map function to apply to the response before decoding it.
|
Retryer |
Cloned for each invocation to
Client.execute(Request, feign.Request.Options) . |
Target<T> |
relationship to JAXRS 2.0 Similar to javax.ws.rs.client.WebTarget , as it produces requests. |
Class | Description |
---|---|
AsyncClient.Default<C> | |
AsyncClient.Pseudo<C> |
A synchronous implementation of
AsyncClient |
AsyncFeign<C> |
Enhances
Feign to provide support for asynchronous clients. |
AsyncFeign.AsyncBuilder<C> | |
Client.Default | |
Client.Proxied |
Client that supports a
Proxy . |
Contract.BaseContract | |
Contract.Default | |
DeclarativeContract |
Contract base implementation that works by declaring witch annotations should be
processed and how each annotation modifies MethodMetadata |
Feign |
Feign's purpose is to ease development against http apis that feign restfulness.
|
Feign.Builder | |
Feign.ResponseMappingDecoder | |
InvocationHandlerFactory.Default | |
Logger |
Simple logging abstraction for debug messages.
|
Logger.ErrorLogger |
Logs to System.err.
|
Logger.JavaLogger |
Logs to the category
Logger at Level.FINE , if loggable. |
Logger.NoOpLogger | |
MethodMetadata | |
Param.ToStringExpander | |
QueryMapEncoder.Default | Deprecated
use
BeanQueryMapEncoder instead. |
ReflectiveAsyncFeign<C> | |
ReflectiveFeign | |
Request |
An immutable request to an http server.
|
Request.Body |
Request Body
|
Request.Options |
Controls the per-request settings currently required to be implemented by all
clients |
RequestTemplate |
Request Builder for an HTTP Target.
|
Response |
An immutable response to an http invocation which only returns string content.
|
Response.Builder | |
Retryer.Default | |
Target.EmptyTarget<T> | |
Target.HardCodedTarget<T> | |
Types |
Static methods for working with types.
|
Util |
Utilities, typically copied in from guava, so as to avoid dependency conflicts.
|
Enum | Description |
---|---|
CollectionFormat |
Various ways to encode collections in URL parameters.
|
ExceptionPropagationPolicy | |
Logger.Level |
Controls the level of logging.
|
Request.HttpMethod |
Exception | Description |
---|---|
AsyncJoinException |
Thrown to encapsulate an underlying cause when using
CompletableFuture.join() to convert
an asynchronous call to a synchronous one. |
FeignException |
Origin exception type for all Http Apis.
|
FeignException.BadGateway | |
FeignException.BadRequest | |
FeignException.Conflict | |
FeignException.FeignClientException | |
FeignException.FeignServerException | |
FeignException.Forbidden | |
FeignException.GatewayTimeout | |
FeignException.Gone | |
FeignException.InternalServerError | |
FeignException.MethodNotAllowed | |
FeignException.NotAcceptable | |
FeignException.NotFound | |
FeignException.NotImplemented | |
FeignException.ServiceUnavailable | |
FeignException.TooManyRequests | |
FeignException.Unauthorized | |
FeignException.UnprocessableEntity | |
FeignException.UnsupportedMediaType | |
RetryableException |
This exception is raised when the
Response is deemed to be retryable, typically via an
ErrorDecoder when the status is 503. |
Annotation Type | Description |
---|---|
Body |
A possibly templated body of a PUT or POST command.
|
Experimental |
Indicates that a public API (public class, method or field) is subject to incompatible changes,
or even removal, in a future release.
|
HeaderMap |
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.
|
Headers |
Expands headers supplied in the
value . |
Param |
A named template parameter applied to
Headers , RequestLine,
Body, POJO fields or beans properties when it expanding |
QueryMap |
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.
|
RequestLine |
Expands the uri template supplied in the
value , permitting path and query variables, or
just the http method. |
Copyright © 2012–2020 OpenFeign. All rights reserved.