feign.form

Class FormEncoder

java.lang.Object

feign.form.FormEncoder

All Implemented Interfaces:

feign.codec.Encoder

public class FormEncoder
extends Object
implements feign.codec.Encoder

Properly encodes requests with application/x-www-form-urlencoded and multipart/form-data Content-Type.

Also, the encoder has a delegate field for encoding non-form requests (like JSON or other).

Default delegate object is Encoder.Default instance.

Usage example:

Declaring API interface:

 interface SomeApi {

     @RequestLine("POST /json")
     @Headers("Content-Type: application/json")
     void json (Dto dto);

     @RequestLine("POST /form")
     @Headers("Content-Type: application/x-www-form-urlencoded")
     void from (@Param("field1") String field1, @Param("field2") String field2);

 }
 

Creating Feign client instance:

 SomeApi api = Feign.builder()
       .encoder(new FormEncoder(new JacksonEncoder()))
       .target(SomeApi.class, "http://localhost:8080");
 

Now it can handle JSON Content-Type by feign.jackson.JacksonEncoder and form request by FormEncoder.

Since:

30.04.2016

Author:

Artem Labazin

Nested Class Summary

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

feign.codec.Encoder.Default

Field Summary

Fields inherited from interface feign.codec.Encoder

MAP_STRING_WILDCARD

Constructor Summary

Constructors

Constructor and Description
FormEncoder() Default FormEncoder constructor.
FormEncoder(feign.codec.Encoder delegate) FormEncoder constructor with delegate encoder argument.

Method Summary

Modifier and Type	Method and Description
void	encode(Object object, Type bodyType, feign.RequestTemplate template)

Methods inherited from class java.lang.Object

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

Constructor Detail

FormEncoder

public FormEncoder()

Default FormEncoder constructor.

Sets Encoder.Default instance as delegate encoder.

FormEncoder

public FormEncoder(feign.codec.Encoder delegate)

FormEncoder constructor with delegate encoder argument.

Parameters:

delegate - delegate encoder for processing non-form requests.

Method Detail

encode

public void encode(Object object,
                   Type bodyType,
                   feign.RequestTemplate template)

Specified by:

encode in interface feign.codec.Encoder