feign.stream

Class StreamDecoder

java.lang.Object

feign.stream.StreamDecoder

All Implemented Interfaces:

Decoder

public final class StreamDecoder
extends Object
implements Decoder

Iterator based decoder that support streaming.

Example:

 
 Feign.builder()
   .decoder(StreamDecoder.create(JacksonIteratorDecoder.create()))
   .doNotCloseAfterDecode() // Required for streaming
   .target(GitHub.class, "https://api.github.com");
 or
 Feign.builder()
   .decoder(StreamDecoder.create(JacksonIteratorDecoder.create(), (r, t) -> "hello world")))
   .doNotCloseAfterDecode() // Required for streaming
   .target(GitHub.class, "https://api.github.com");
 interface GitHub {
   @RequestLine("GET /repos/{owner}/{repo}/contributors")
   Stream contributors(@Param("owner") String owner, @Param("repo") String repo);
 }
 

Nested Class Summary

Nested classes/interfaces inherited from interface feign.codec.Decoder

Decoder.Default

Method Summary

Modifier and Type	Method and Description
static StreamDecoder	create(Decoder iteratorDecoder)
static StreamDecoder	create(Decoder iteratorDecoder, Decoder delegateDecoder)
Object	decode(Response response, Type type) Decodes an http response into an object corresponding to its generic return type.
static boolean	isStream(Type type)

Methods inherited from class java.lang.Object

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

Method Detail

decode

public Object decode(Response response,
                     Type type)
              throws IOException,
                     FeignException

Description copied from interface: Decoder

Decodes an http response into an object corresponding to its generic return type. If you need to wrap exceptions, please do so via DecodeException.

Specified by:

decode in interface Decoder

Parameters:

response - the response to decode

type - generic return type of the method corresponding to this response.

Returns:

instance of type

Throws:

IOException - will be propagated safely to the caller.

DecodeException - when decoding failed due to a checked exception besides IOException.

FeignException - when decoding succeeds, but conveys the operation failed.

isStream

public static boolean isStream(Type type)

create

public static StreamDecoder create(Decoder iteratorDecoder)

create

public static StreamDecoder create(Decoder iteratorDecoder,
                                   Decoder delegateDecoder)