feign.jackson.JacksonModule Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of feign-jackson Show documentation
feign-jackson
There is a newer version: 8.18.0
/*
 * Copyright 2013 Netflix, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package feign.jackson;

import com.fasterxml.jackson.databind.JsonDeserializer;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.Module;

import java.util.Collections;
import java.util.Set;

import dagger.Provides;
import feign.Feign;
import feign.codec.Decoder;
import feign.codec.Encoder;

/**
 * Custom serializers/deserializers
 
 In order to specify custom json parsing, Jackson's
 * {@code ObjectMapper} supports {@link JsonSerializer serializers} and {@link JsonDeserializer
 * deserializers}, which can be bundled together in {@link Module modules}.  
 Here's an
 * example of adding a custom module. 

 * 
 * public class ObjectIdSerializer extends StdSerializer<ObjectId> {
 *     public ObjectIdSerializer() {
 *         super(ObjectId.class);
 *     }
 *
 *     @Override
 *     public void serialize(ObjectId value, JsonGenerator jsonGenerator, SerializerProvider
 * provider) throws IOException {
 *         jsonGenerator.writeString(value.toString());
 *     }
 * }
 *
 * public class ObjectIdDeserializer extends StdDeserializer<ObjectId> {
 *     public ObjectIdDeserializer() {
 *         super(ObjectId.class);
 *     }
 *
 *     @Override
 *     public ObjectId deserialize(JsonParser jsonParser, DeserializationContext context) throws
 * IOException {
 *         return ObjectId.massageToObjectId(jsonParser.getValueAsString());
 *     }
 * }
 *
 * public class ObjectIdModule extends SimpleModule {
 *     public ObjectIdModule() {
 *         // first deserializers
 *         addDeserializer(ObjectId.class, new ObjectIdDeserializer());
 *
 *         // then serializers:
 *         addSerializer(ObjectId.class, new ObjectIdSerializer());
 *     }
 * }
 *
 * @Provides(type = Provides.Type.SET)
 * Module objectIdModule() {
 *     return new ObjectIdModule();
 * }
 * 
 */
@dagger.Module(injects = Feign.class, addsTo = Feign.Defaults.class)
public final class JacksonModule {

  @Provides
  Encoder encoder(Set modules) {
    return new JacksonEncoder(modules);
  }

  @Provides
  Decoder decoder(Set modules) {
    return new JacksonDecoder(modules);
  }

  @Provides(type = Provides.Type.SET_VALUES)
  Set noDefaultModules() {
    return Collections.emptySet();
  }
}