feign

Class Feign

java.lang.Object

feign.Feign

Direct Known Subclasses:

AsyncFeign, ReflectiveFeign

public abstract class Feign
extends Object

Feign's purpose is to ease development against http apis that feign restfulness.
In implementation, Feign is a factory for generating targeted http apis.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Feign.Builder
static class	Feign.ResponseMappingDecoder

Constructor Summary

Constructors

Constructor and Description
Feign()

Method Summary

Modifier and Type	Method and Description
static Feign.Builder	builder()
static String	configKey(Class targetType, Method method) Configuration keys are formatted as unresolved see tags.
static String	configKey(Method method) Deprecated. use configKey(Class, Method) instead.
abstract <T> T	newInstance(Target<T> target) Returns a new instance of an HTTP API, defined by annotations in the Contract, for the specified target.

Methods inherited from class java.lang.Object

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

Constructor Detail

Feign

public Feign()

Method Detail

builder

public static Feign.Builder builder()

configKey

public static String configKey(Class targetType,
                               Method method)

Configuration keys are formatted as unresolved see tags. This method exposes that format, in case you need to create the same value as MethodMetadata.configKey() for correlation purposes.

Here are some sample encodings:

 

   
 Route53: would match a class  route53.Route53
   
 Route53#list(): would match a method  route53.Route53#list()
   
 Route53#listAt(Marker): would match a method 
 route53.Route53#listAt(Marker)
   
 Route53#listByNameAndType(String, String): would match a method 
 route53.Route53#listAt(String, String)
 
 

Note that there is no whitespace expected in a key!

Parameters:

targetType - type of the Feign interface.

method - invoked method, present on type or its super.

See Also:

MethodMetadata.configKey()

configKey

@Deprecated
public static String configKey(Method method)

Deprecated. use configKey(Class, Method) instead.

newInstance

public abstract <T> T newInstance(Target<T> target)

Returns a new instance of an HTTP API, defined by annotations in the Contract, for the specified target. You should cache this result.